ISIAPISiteVolumeBinFolder Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 0781C83D-1FBD-4E54-B026-2D0B1C2A6255

SiteVolumeBinFolder wrapper interface

Declaration¶

[Guid("0781C83D-1FBD-4E54-B026-2D0B1C2A6255")]
public interface ISIAPISiteVolumeBinFolder

Get an instance¶

C#VB.NETPythonPowerShell

// Navigate to the ISIAPISiteVolumeBinFolder you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var siteVolumeBinFolder = /* ... */;

' Navigate to the ISIAPISiteVolumeBinFolder you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim siteVolumeBinFolder As ISIAPISiteVolumeBinFolder = Nothing

# Navigate to the ISIAPISiteVolumeBinFolder you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeBinFolder = ...

# Navigate to the ISIAPISiteVolumeBinFolder you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$siteVolumeBinFolder = $null

Properties¶

Name¶

Site Volume Bin Folder Name

string Name { get; set; }

Type string

Value

The Site Volume Bin Folder's name, max length = 100.

Code samples

C#VB.NETPythonPowerShell

string name = siteVolumeBinFolder.Name;
siteVolumeBinFolder.Name = @"Example";

Dim name As String = siteVolumeBinFolder.Name
siteVolumeBinFolder.Name = "Example"

name = siteVolumeBinFolder.Name
siteVolumeBinFolder.Name = r"Example"

$name = $siteVolumeBinFolder.Name
$siteVolumeBinFolder.Name = "Example"

Position¶

This SiteVolumeBinFolder object's Position in the collection. It is a zero-base integer.

int Position { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int position = siteVolumeBinFolder.Position;

Dim position As Integer = siteVolumeBinFolder.Position

position = siteVolumeBinFolder.Position

$position = $siteVolumeBinFolder.Position

SiteVolumeBins¶

Collection of SiteVolumeBins in this Folder

ISIAPISiteVolumeBins SiteVolumeBins { get; }

Type ISIAPISiteVolumeBins

Value

SiteVolumeBins collection

Code samples

C#VB.NETPythonPowerShell

var siteVolumeBins = siteVolumeBinFolder.SiteVolumeBins;

Dim siteVolumeBins As ISIAPISiteVolumeBins = siteVolumeBinFolder.SiteVolumeBins

site_volume_bins = siteVolumeBinFolder.SiteVolumeBins

$siteVolumeBins = $siteVolumeBinFolder.SiteVolumeBins

Project¶

ISIAPIProject Project { get; }

Type ISIAPIProject

Code samples

C#VB.NETPythonPowerShell

var project = siteVolumeBinFolder.Project;

Dim project As ISIAPIProject = siteVolumeBinFolder.Project

project = siteVolumeBinFolder.Project

$project = $siteVolumeBinFolder.Project

Methods¶

AddSiteVolumeBin(int)¶

Create a new SiteVolumeBin by using a Standard Software Setup and add it into this Folder.

ISIAPISiteVolumeBin AddSiteVolumeBin(int softwareSetup)

Parameters

Name	Type	Description
`softwareSetup`	`int`	One of: - Standard Software Setup that is used to create the Site - `1` - Standard Left - `2` - New Zealand - `3` - New South Wales - `4` - Standard Right - `5` - US HCM (Metric) - `6` - US HCM (Customary)

Returns ISIAPISiteVolumeBin - The new added SiteVolumeBin.

Code samples

C#VB.NETPythonPowerShell

var result = siteVolumeBinFolder.AddSiteVolumeBin(0);

Dim result As ISIAPISiteVolumeBin = siteVolumeBinFolder.AddSiteVolumeBin(0)

result = siteVolumeBinFolder.AddSiteVolumeBin(0)

$result = $siteVolumeBinFolder.AddSiteVolumeBin(0)

AddSiteVolumeBin(string)¶

Create a new SiteVolumeBin and add it into this Folder.
The SiteVolumeBin is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature.

ISIAPISiteVolumeBin AddSiteVolumeBin(string softwareSetupSignature)

Parameters

Name	Type	Description
`softwareSetupSignature`	`string`	The signature string of a User Software Setup or a Standard Software Setup.

Returns ISIAPISiteVolumeBin - The new added SiteVolumeBin.

Code samples

C#VB.NETPythonPowerShell

var result = siteVolumeBinFolder.AddSiteVolumeBin(@"value");

Dim result As ISIAPISiteVolumeBin = siteVolumeBinFolder.AddSiteVolumeBin("value")

result = siteVolumeBinFolder.AddSiteVolumeBin(r"value")

$result = $siteVolumeBinFolder.AddSiteVolumeBin("value")

RemoveSiteVolumeBin(ISIAPISiteVolumeBin)¶

Remove a SiteVolumeBin from this Folder.

bool RemoveSiteVolumeBin(ISIAPISiteVolumeBin siteVolumeBin)

Parameters

Name	Type	Description
`siteVolumeBin`	`ISIAPISiteVolumeBin`	The SiteVolumeBin to remove.

Returns bool - true if the SiteVolumeBin is successfully removed; otherwise, false. This method also returns false if the SiteVolumeBin does not exist in this Folder.

Remarks

The SiteVolumeBin cannot be used in any Site.

Code samples

C#VB.NETPythonPowerShell

bool result = siteVolumeBinFolder.RemoveSiteVolumeBin(null);

Dim result As Boolean = siteVolumeBinFolder.RemoveSiteVolumeBin(Nothing)

result = siteVolumeBinFolder.RemoveSiteVolumeBin(None)

$result = $siteVolumeBinFolder.RemoveSiteVolumeBin($null)

CloneSiteVolumeBin(ISIAPISiteVolumeBin)¶

Clone a SiteVolumeBin.

ISIAPISiteVolumeBin CloneSiteVolumeBin(ISIAPISiteVolumeBin siteVolumeBin)

Parameters

Name	Type	Description
`siteVolumeBin`	`ISIAPISiteVolumeBin`	The SiteVolumeBin to be cloned.

Returns ISIAPISiteVolumeBin - The new cloned SiteVolumeBin.

Code samples

C#VB.NETPythonPowerShell

var result = siteVolumeBinFolder.CloneSiteVolumeBin(null);

Dim result As ISIAPISiteVolumeBin = siteVolumeBinFolder.CloneSiteVolumeBin(Nothing)

result = siteVolumeBinFolder.CloneSiteVolumeBin(None)

$result = $siteVolumeBinFolder.CloneSiteVolumeBin($null)

MoveSiteVolumeBinTo(ISIAPISiteVolumeBin, int)¶

Move a SiteVolumeBin to a new position in the same Folder.

bool MoveSiteVolumeBinTo(ISIAPISiteVolumeBin siteVolumeBin, int newPosition)

Parameters

Name	Type	Description
`siteVolumeBin`	`ISIAPISiteVolumeBin`	The SiteVolumeBin to move.
`newPosition`	`int`	The zero-based position that the SiteVolumeBin should be moved to.

Returns bool - true if the SiteVolumeBin is successfully moved; otherwise, false. This method also returns false if the SiteVolumeBin does not exist in this Folder.

Code samples

C#VB.NETPythonPowerShell

bool result = siteVolumeBinFolder.MoveSiteVolumeBinTo(null, 0);

Dim result As Boolean = siteVolumeBinFolder.MoveSiteVolumeBinTo(Nothing, 0)

result = siteVolumeBinFolder.MoveSiteVolumeBinTo(None, 0)

$result = $siteVolumeBinFolder.MoveSiteVolumeBinTo($null, 0)

MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin, ISIAPISiteVolumeBinFolder)¶

Move a SiteVolumeBin from this Site Volume Bin Folder to another Site Volume Bin Folder in this Project.

bool MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin siteVolumeBin, ISIAPISiteVolumeBinFolder destFolder)

Parameters

Name	Type	Description
`siteVolumeBin`	`ISIAPISiteVolumeBin`	The SiteVolumeBin to move.
`destFolder`	`ISIAPISiteVolumeBinFolder`	The destination Site Volume Bin Folder

Returns bool - true if the SiteVolumeBin is successfully moved; otherwise, false. This method also returns false if the SiteVolumeBin does not exist in this Folder before moving it.

Code samples

C#VB.NETPythonPowerShell

bool result = siteVolumeBinFolder.MoveSiteVolumeBinToFolder(null, null);

Dim result As Boolean = siteVolumeBinFolder.MoveSiteVolumeBinToFolder(Nothing, Nothing)

result = siteVolumeBinFolder.MoveSiteVolumeBinToFolder(None, None)

$result = $siteVolumeBinFolder.MoveSiteVolumeBinToFolder($null, $null)