Skip to content

AssignVolumeBinFolder

Type ISIAPIAssignVolumeBinFolder · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID C76BF8CA-B494-40AB-A25F-099B684878A4

AssignVolumeBinFolder wrapper interface

Declaration

[Guid("C76BF8CA-B494-40AB-A25F-099B684878A4")]
public interface ISIAPIAssignVolumeBinFolder

Members

Properties

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

Methods

Method Returns Summary
AddAssignVolumeBin(int) ISIAPIAssignVolumeBin Create a new AssignVolumeBin by using a Standard Software Setup and add it into this Folder.
AddAssignVolumeBin(string) ISIAPIAssignVolumeBin Create a new AssignVolumeBin and add it into this Folder. The AssignVolumeBin is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature.
RemoveAssignVolumeBin(ISIAPIAssignVolumeBin) bool Remove an AssignVolumeBin from this Folder.
CloneAssignVolumeBin(ISIAPIAssignVolumeBin) ISIAPIAssignVolumeBin Clone an AssignVolumeBin.
MoveAssignVolumeBinTo(ISIAPIAssignVolumeBin, int) bool Move an AssignVolumeBin to a new position in the same Folder.
MoveAssignVolumeBinToFolder(ISIAPIAssignVolumeBin, ISIAPIAssignVolumeBinFolder) bool Move an AssignVolumeBin from this Assign Volume Bin Folder to another Assign Volume Bin Folder in this Project.

Properties

Name

Assign Volume Bin Folder Name

string Name { get; set; }

Type string

Value

Type: System.String.

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

Code samples 
string name = assignVolumeBinFolder.Name;
assignVolumeBinFolder.Name = @"Example";

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

name = assignVolumeBinFolder.Name
assignVolumeBinFolder.Name = r"Example"

Position

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

int Position { get; }

Type int

Code samples 
int position = assignVolumeBinFolder.Position;

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

position = assignVolumeBinFolder.Position

IsExpanded

Flag indicating whether this folder is expanded.

bool IsExpanded { get; set; }

Type bool

Code samples 
bool isExpanded = assignVolumeBinFolder.IsExpanded;
assignVolumeBinFolder.IsExpanded = true;

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

is_expanded = assignVolumeBinFolder.IsExpanded
assignVolumeBinFolder.IsExpanded = True

AssignVolumeBins

Collection of AssignVolumeBins in this Folder

ISIAPIAssignVolumeBins AssignVolumeBins { get; }

Type ISIAPIAssignVolumeBins

Value

Type: ISIAPIAssignVolumeBins

AssignVolumeBins collection

Code samples 
var assignVolumeBins = assignVolumeBinFolder.AssignVolumeBins;

CComPtr<ISIAPIAssignVolumeBins> assignVolumeBins;
assignVolumeBinFolder->get_AssignVolumeBins(&assignVolumeBins);

assign_volume_bins = assignVolumeBinFolder.AssignVolumeBins

Project

ISIAPIProject Project { get; }

Type ISIAPIProject

Code samples 
var project = assignVolumeBinFolder.Project;

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

project = assignVolumeBinFolder.Project

Methods

AddAssignVolumeBin(int)

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

ISIAPIAssignVolumeBin AddAssignVolumeBin(int softwareSetup)

Parameters

Name Type Description
softwareSetup int Type: System.Int32; 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 ISIAPIAssignVolumeBin - The new added AssignVolumeBin.

Code samples 
var result = assignVolumeBinFolder.AddAssignVolumeBin(0);

CComPtr<ISIAPIAssignVolumeBin> result;
assignVolumeBinFolder->AddAssignVolumeBin(0, &result);

result = assignVolumeBinFolder.AddAssignVolumeBin(0)

AddAssignVolumeBin(string)

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

ISIAPIAssignVolumeBin AddAssignVolumeBin(string softwareSetupSignature)

Parameters

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

Returns ISIAPIAssignVolumeBin - The new added AssignVolumeBin.

Code samples 
var result = assignVolumeBinFolder.AddAssignVolumeBin(@"value");

CComPtr<ISIAPIAssignVolumeBin> result;
assignVolumeBinFolder->AddAssignVolumeBin(CComBSTR(L"value"), &result);

result = assignVolumeBinFolder.AddAssignVolumeBin(r"value")

RemoveAssignVolumeBin(ISIAPIAssignVolumeBin)

Remove an AssignVolumeBin from this Folder.

bool RemoveAssignVolumeBin(ISIAPIAssignVolumeBin assignVolumeBin)

Parameters

Name Type Description
assignVolumeBin ISIAPIAssignVolumeBin The AssignVolumeBin to remove.

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

Remarks

The AssignVolumeBin cannot be used in any Assign Network.

Code samples 
bool result = assignVolumeBinFolder.RemoveAssignVolumeBin(null);

VARIANT_BOOL result;
assignVolumeBinFolder->RemoveAssignVolumeBin(NULL, &result);

result = assignVolumeBinFolder.RemoveAssignVolumeBin(None)

CloneAssignVolumeBin(ISIAPIAssignVolumeBin)

Clone an AssignVolumeBin.

ISIAPIAssignVolumeBin CloneAssignVolumeBin(ISIAPIAssignVolumeBin assignVolumeBin)

Parameters

Name Type Description
assignVolumeBin ISIAPIAssignVolumeBin The AssignVolumeBin to be cloned.

Returns ISIAPIAssignVolumeBin - The new cloned AssignVolumeBin.

Code samples 
var result = assignVolumeBinFolder.CloneAssignVolumeBin(null);

CComPtr<ISIAPIAssignVolumeBin> result;
assignVolumeBinFolder->CloneAssignVolumeBin(NULL, &result);

result = assignVolumeBinFolder.CloneAssignVolumeBin(None)

MoveAssignVolumeBinTo(ISIAPIAssignVolumeBin, int)

Move an AssignVolumeBin to a new position in the same Folder.

bool MoveAssignVolumeBinTo(ISIAPIAssignVolumeBin assignVolumeBin, int newPosition)

Parameters

Name Type Description
assignVolumeBin ISIAPIAssignVolumeBin The AssignVolumeBin to move.
newPosition int The zero-based position that the AssignVolumeBin should be moved to.

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

Code samples 
bool result = assignVolumeBinFolder.MoveAssignVolumeBinTo(null, 0);

VARIANT_BOOL result;
assignVolumeBinFolder->MoveAssignVolumeBinTo(NULL, 0, &result);

result = assignVolumeBinFolder.MoveAssignVolumeBinTo(None, 0)

MoveAssignVolumeBinToFolder(ISIAPIAssignVolumeBin, ISIAPIAssignVolumeBinFolder)

Move an AssignVolumeBin from this Assign Volume Bin Folder to another Assign Volume Bin Folder in this Project.

bool MoveAssignVolumeBinToFolder(ISIAPIAssignVolumeBin assignVolumeBin, ISIAPIAssignVolumeBinFolder destFolder)

Parameters

Name Type Description
assignVolumeBin ISIAPIAssignVolumeBin The AssignVolumeBin to move.
destFolder ISIAPIAssignVolumeBinFolder The destination Assign Volume Bin Folder

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

Code samples 
bool result = assignVolumeBinFolder.MoveAssignVolumeBinToFolder(null, null);

VARIANT_BOOL result;
assignVolumeBinFolder->MoveAssignVolumeBinToFolder(NULL, NULL, &result);

result = assignVolumeBinFolder.MoveAssignVolumeBinToFolder(None, None)