IModalAction interface
No description yet.
public interface IModalAction
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Derived: IFolderModalAction
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| ModalActionResult | TModalActionResult | get; set | |
| OnFolderSelectionChange | IFolderSelectionHandler | get; set | |
| Vault | string | set |
ModalActionResult
No description yet.
TModalActionResult GetModalActionResult();
void SetModalActionResult(TModalActionResult argValue);
Type: TModalActionResult · Access: read/write
The accessors are extension methods of IModalActionHelper (using DXP;).
OnFolderSelectionChange
No description yet.
IFolderSelectionHandler GetOnFolderSelectionChange();
void SetOnFolderSelectionChange(IFolderSelectionHandler argValue);
Type: IFolderSelectionHandler · Access: read/write
The accessors are extension methods of IModalActionHelper (using DXP;).
Vault
No description yet.
void SetState_Vault(string argVaultGUID, string argFolderToFocusGUID, string argItemGUID, string argRevisionGUID);
Type: string · Access: write-only · Index: argVaultGUID (string), argFolderToFocusGUID (string), argItemGUID (string)
Methods
| Method | Returns | Description |
|---|---|---|
| CanExecute | bool | |
| Execute | bool | |
| GetCurrentFolder | IULB_Folder | |
| GetCurrentFolderGUID | string | |
| GetCurrentItemGUID | string | |
| GetCurrentItemGUIDs | void | |
| GetCurrentItemRevisionGUID | string | |
| GetCurrentItemRevisionGUIDs | void | |
| GetCurrentItemRevisionHRID | string | |
| GetCurrentVaultGUID | string | |
| PerformAction | bool | |
| ValidateInput | bool |
CanExecute
No description yet.
bool CanExecute();
Returns: bool
Execute
No description yet.
bool Execute();
Returns: bool
GetCurrentFolder
No description yet.
IULB_Folder GetCurrentFolder();
Returns: IULB_Folder
Extension method of IModalActionHelper (using DXP;).
GetCurrentFolderGUID
No description yet.
string GetCurrentFolderGUID();
Returns: string
GetCurrentItemGUID
No description yet.
string GetCurrentItemGUID();
Returns: string
GetCurrentItemGUIDs
No description yet.
void GetCurrentItemGUIDs(IStrings argItemGUIDs);
void GetCurrentItemGUIDs(object argItemGUIDs);
| Parameter | Type | Passing |
|---|---|---|
argItemGUIDs | IStrings | value |
Returns: nothing (void)
The first overload is an extension method of IModalActionHelper (using DXP;) with typed parameters; the second is declared by the interface.
GetCurrentItemRevisionGUID
No description yet.
string GetCurrentItemRevisionGUID();
Returns: string
GetCurrentItemRevisionGUIDs
No description yet.
void GetCurrentItemRevisionGUIDs(IStrings argItemRevisionGUIDs);
void GetCurrentItemRevisionGUIDs(object argItemRevisionGUIDs);
| Parameter | Type | Passing |
|---|---|---|
argItemRevisionGUIDs | IStrings | value |
Returns: nothing (void)
The first overload is an extension method of IModalActionHelper (using DXP;) with typed parameters; the second is declared by the interface.
GetCurrentItemRevisionHRID
No description yet.
string GetCurrentItemRevisionHRID();
Returns: string
GetCurrentVaultGUID
No description yet.
string GetCurrentVaultGUID();
Returns: string
PerformAction
No description yet.
bool PerformAction();
Returns: bool
ValidateInput
No description yet.
bool ValidateInput();
Returns: bool