SiteVolumeBinFolder

Type 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

Members

Properties

Property	Type	Summary
Name	string	Site Volume Bin Folder Name
Position	int	This SiteVolumeBinFolder object's Position in the collection. It is a zero-base integer.
SiteVolumeBins	ISIAPISiteVolumeBins	Collection of SiteVolumeBins in this Folder
Project	ISIAPIProject
IsExpanded	bool	Flag indicating whether this folder is expanded.

Methods

Method	Returns	Summary
AddSiteVolumeBin(int)	ISIAPISiteVolumeBin	Create a new SiteVolumeBin by using a Standard Software Setup and add it into this Folder.
AddSiteVolumeBin(string)	ISIAPISiteVolumeBin	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.
RemoveSiteVolumeBin(ISIAPISiteVolumeBin)	bool	Remove a SiteVolumeBin from this Folder.
CloneSiteVolumeBin(ISIAPISiteVolumeBin)	ISIAPISiteVolumeBin	Clone a SiteVolumeBin.
MoveSiteVolumeBinTo(ISIAPISiteVolumeBin, int)	bool	Move a SiteVolumeBin to a new position in the same Folder.
MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin, ISIAPISiteVolumeBinFolder)	bool	Move a SiteVolumeBin from this Site Volume Bin Folder to another Site Volume Bin Folder in this Project.

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#C++Python

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

CComBSTR name;
siteVolumeBinFolder->get_Name(&name);
siteVolumeBinFolder->put_Name(CComBSTR(L"Example"));

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

Position

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

int Position { get; }

Type int

Code samples

C#C++Python

int position = siteVolumeBinFolder.Position;

long position;
siteVolumeBinFolder->get_Position(&position);

position = siteVolumeBinFolder.Position

SiteVolumeBins

Collection of SiteVolumeBins in this Folder

ISIAPISiteVolumeBins SiteVolumeBins { get; }

Type ISIAPISiteVolumeBins

Value

SiteVolumeBins collection

Code samples

C#C++Python

var siteVolumeBins = siteVolumeBinFolder.SiteVolumeBins;

CComPtr<ISIAPISiteVolumeBins> siteVolumeBins;
siteVolumeBinFolder->get_SiteVolumeBins(&siteVolumeBins);

site_volume_bins = siteVolumeBinFolder.SiteVolumeBins

Project

ISIAPIProject Project { get; }

Type ISIAPIProject

Code samples

C#C++Python

var project = siteVolumeBinFolder.Project;

CComPtr<ISIAPIProject> project;
siteVolumeBinFolder->get_Project(&project);

project = siteVolumeBinFolder.Project

IsExpanded

Flag indicating whether this folder is expanded.

bool IsExpanded { get; set; }

Type bool

Code samples

C#C++Python

bool isExpanded = siteVolumeBinFolder.IsExpanded;
siteVolumeBinFolder.IsExpanded = true;

VARIANT_BOOL isExpanded;
siteVolumeBinFolder->get_IsExpanded(&isExpanded);
siteVolumeBinFolder->put_IsExpanded(VARIANT_TRUE);

is_expanded = siteVolumeBinFolder.IsExpanded
siteVolumeBinFolder.IsExpanded = True

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 Volume Bin - 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#C++Python

var result = siteVolumeBinFolder.AddSiteVolumeBin(0);

CComPtr<ISIAPISiteVolumeBin> result;
siteVolumeBinFolder->AddSiteVolumeBin(0, &result);

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#C++Python

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

CComPtr<ISIAPISiteVolumeBin> result;
siteVolumeBinFolder->AddSiteVolumeBin(CComBSTR(L"value"), &result);

result = siteVolumeBinFolder.AddSiteVolumeBin(r"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#C++Python

bool result = siteVolumeBinFolder.RemoveSiteVolumeBin(null);

VARIANT_BOOL result;
siteVolumeBinFolder->RemoveSiteVolumeBin(NULL, &result);

result = siteVolumeBinFolder.RemoveSiteVolumeBin(None)

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#C++Python

var result = siteVolumeBinFolder.CloneSiteVolumeBin(null);

CComPtr<ISIAPISiteVolumeBin> result;
siteVolumeBinFolder->CloneSiteVolumeBin(NULL, &result);

result = siteVolumeBinFolder.CloneSiteVolumeBin(None)

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#C++Python

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

VARIANT_BOOL result;
siteVolumeBinFolder->MoveSiteVolumeBinTo(NULL, 0, &result);

result = siteVolumeBinFolder.MoveSiteVolumeBinTo(None, 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#C++Python

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

VARIANT_BOOL result;
siteVolumeBinFolder->MoveSiteVolumeBinToFolder(NULL, NULL, &result);

result = siteVolumeBinFolder.MoveSiteVolumeBinToFolder(None, None)