IReleasableFolder interface
No description yet.
public interface IReleasableFolder
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| EnabledForRelease | bool | get; set | |
| ExistingGUID | string | get; set | |
| FolderTypeGUID | string | get; set | |
| HRID | string | get; set |
EnabledForRelease
No description yet.
bool GetEnabledForRelease();
void SetEnabledForRelease(bool argValue);
Type: bool · Access: read/write
ExistingGUID
No description yet.
string GetExistingGUID();
void SetExistingGUID(string argValue);
Type: string · Access: read/write
FolderTypeGUID
No description yet.
string GetFolderTypeGUID();
void SetFolderTypeGUID(string argValue);
Type: string · Access: read/write
HRID
No description yet.
string GetHRID();
void SetHRID(string argValue);
Type: string · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| AddGroup | void | |
| AddSubFolder | void | |
| AsyncCommit | void | |
| AsyncCommitContents | void | |
| CreateGroup | IReleasableGroup | |
| GetGroup | IReleasableGroup | |
| GetSubFolder | IReleasableFolder | |
| GroupCount | int | |
| RemoveGroup | void | |
| SubFolderCount | int |
AddGroup
No description yet.
void AddGroup(IReleasableGroup argGroup);
void AddGroup(object argGroup);
| Parameter | Type | Passing |
|---|---|---|
argGroup | IReleasableGroup | value |
Returns: nothing (void)
The first overload is an extension method of IReleasableFolderHelper (using DXP;) with typed parameters; the second is declared by the interface.
AddSubFolder
No description yet.
void AddSubFolder(IReleasableFolder argSubfolder);
void AddSubFolder(object argSubfolder);
| Parameter | Type | Passing |
|---|---|---|
argSubfolder | IReleasableFolder | value |
Returns: nothing (void)
The first overload is an extension method of IReleasableFolderHelper (using DXP;) with typed parameters; the second is declared by the interface.
AsyncCommit
No description yet.
void AsyncCommit(IEDMS_Vault argVault, IReleasableFolder argParentFolder);
void AsyncCommit(object argVault, object argParentFolder);
| Parameter | Type | Passing |
|---|---|---|
argVault | IEDMS_Vault | value |
argParentFolder | IReleasableFolder | value |
Returns: nothing (void)
The first overload is an extension method of IReleasableFolderHelper (using DXP;) with typed parameters; the second is declared by the interface.
AsyncCommitContents
No description yet.
void AsyncCommitContents(IEDMS_Vault argVault);
void AsyncCommitContents(object argVault);
| Parameter | Type | Passing |
|---|---|---|
argVault | IEDMS_Vault | value |
Returns: nothing (void)
The first overload is an extension method of IReleasableFolderHelper (using DXP;) with typed parameters; the second is declared by the interface.
CreateGroup
No description yet.
IReleasableGroup CreateGroup();
Returns: IReleasableGroup
Extension method of IReleasableFolderHelper (using DXP;).
GetGroup
No description yet.
IReleasableGroup GetGroup(int argI);
| Parameter | Type | Passing |
|---|---|---|
argI | int | value |
Returns: IReleasableGroup
Extension method of IReleasableFolderHelper (using DXP;).
GetSubFolder
No description yet.
IReleasableFolder GetSubFolder(int argI);
| Parameter | Type | Passing |
|---|---|---|
argI | int | value |
Returns: IReleasableFolder
Extension method of IReleasableFolderHelper (using DXP;).
GroupCount
No description yet.
int GroupCount();
Returns: int
RemoveGroup
No description yet.
void RemoveGroup(IReleasableGroup argGroup);
void RemoveGroup(object argGroup);
| Parameter | Type | Passing |
|---|---|---|
argGroup | IReleasableGroup | value |
Returns: nothing (void)
The first overload is an extension method of IReleasableFolderHelper (using DXP;) with typed parameters; the second is declared by the interface.
SubFolderCount
No description yet.
int SubFolderCount();
Returns: int
Returned by
IBatchRelease.CreateFolder, IBatchRelease.TopFolder