IVaultExplorerForm interface

No description yet.

public interface IVaultExplorerForm

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
BrowseItemsOption	TBrowseItemsOptionSet	get; set
ContentTypeFilter	string	get; set
DetailsPanelHeight	int	get; set
FolderSelectionChange	IFolderSelectionHandler	get; set
FolderTypeFilter	string	get; set
ModalAction	IModalAction	get; set
ShowSearch	bool	get; set
ShowVaultRoot	bool	get; set
TreePanelWidth	int	get; set
Vault	bool	set
VisiblePanels	TVaultExplorerPanelsSet	get; set

BrowseItemsOption

No description yet.

TBrowseItemsOptionSet GetBrowseItemsOption();
void SetBrowseItemsOption(TBrowseItemsOptionSet argOptions);

Type: TBrowseItemsOptionSet · Access: read/write

The accessors are extension methods of IVaultExplorerFormHelper (using DXP;).

ContentTypeFilter

No description yet.

string GetContentTypeFilter();
void SetContentTypeFilter(string argValue);

Type: string · Access: read/write

DetailsPanelHeight

No description yet.

int GetDetailsPanelHeight();
void SetDetailsPanelHeight(int argHeight);

Type: int · Access: read/write

FolderSelectionChange

No description yet.

IFolderSelectionHandler GetFolderSelectionChange();
void SetFolderSelectionChange(IFolderSelectionHandler argValue);

Type: IFolderSelectionHandler · Access: read/write

The accessors are extension methods of IVaultExplorerFormHelper (using DXP;).

FolderTypeFilter

No description yet.

string GetFolderTypeFilter();
void SetFolderTypeFilter(string argValue);

Type: string · Access: read/write

ModalAction

No description yet.

IModalAction GetModalAction();
void SetModalAction(IModalAction argValue);

Type: IModalAction · Access: read/write

The accessors are extension methods of IVaultExplorerFormHelper (using DXP;).

ShowSearch

No description yet.

bool GetShowSearch();
void SetShowSearch(bool argShow);

Type: bool · Access: read/write

ShowVaultRoot

No description yet.

bool GetShowVaultRoot();
void SetShowVaultRoot(bool argShow);

Type: bool · Access: read/write

TreePanelWidth

No description yet.

int GetTreePanelWidth();
void SetTreePanelWidth(int argWidth);

Type: int · Access: read/write

Vault

No description yet.

void SetState_Vault(bool argWait, string argVaultGUID, string argFocusFolderGUID, string argItemGUID, string argRevisionGUID, int argPageInFolder, int argPageSize, bool argFiltered);

Type: bool · Access: write-only · Index: argWait (bool), argVaultGUID (string), argFocusFolderGUID (string), argItemGUID (string), argRevisionGUID (string), argPageInFolder (int), argPageSize (int)

VisiblePanels

No description yet.

TVaultExplorerPanelsSet GetVisiblePanels();
void SetVisiblePanels(TVaultExplorerPanelsSet argVisiblePanels);

Type: TVaultExplorerPanelsSet · Access: read/write

The accessors are extension methods of IVaultExplorerFormHelper (using DXP;).

Methods

Method	Returns	Description
AddNavigationWayPoint	void
AsForm	ICustomForm
ClearModalNavigation	void
CurrentFolder	IULB_Folder
CurrentFolderGUID	string
CurrentItem	IULB_Item
CurrentItemGUID	string
CurrentRevision	IULB_ItemRevision
CurrentRevisionGUID	string
CurrentVault	IEDMS_Vault
CurrentVaultGUID	string
EnsureFormInitialized	void
GetSelectedItemGUIDs	void
GetSelectedItemRevisionGUIDs	void
GetVisible	bool
ReceiveNotification	void
SectionNamePrefix	string
SetState_RefreshCurrentVault	void
ShowHidePanelButtons	void

AddNavigationWayPoint

No description yet.

void AddNavigationWayPoint(string argVaultGUID, string argFolderGUID, string argItemGUID, string argRevisionGUID, string argDescription, int argPageInFolder, int argPageSize, bool argFiltered);

Parameter	Type	Passing
argVaultGUID	string	value
argFolderGUID	string	value
argItemGUID	string	value
argRevisionGUID	string	value
argDescription	string	value
argPageInFolder	int	value
argPageSize	int	value
argFiltered	bool	value

Returns: nothing (void)

AsForm

No description yet.

ICustomForm AsForm();

Returns: ICustomForm

Extension method of IVaultExplorerFormHelper (using DXP;).

ClearModalNavigation

No description yet.

void ClearModalNavigation();

Returns: nothing (void)

CurrentFolder

No description yet.

IULB_Folder CurrentFolder();

Returns: IULB_Folder

Extension method of IVaultExplorerFormHelper (using DXP;).

CurrentFolderGUID

No description yet.

string CurrentFolderGUID();

Returns: string

CurrentItem

No description yet.

IULB_Item CurrentItem();

Returns: IULB_Item

Extension method of IVaultExplorerFormHelper (using DXP;).

CurrentItemGUID

No description yet.

string CurrentItemGUID();

Returns: string

CurrentRevision

No description yet.

IULB_ItemRevision CurrentRevision();

Returns: IULB_ItemRevision

Extension method of IVaultExplorerFormHelper (using DXP;).

CurrentRevisionGUID

No description yet.

string CurrentRevisionGUID();

Returns: string

CurrentVault

No description yet.

IEDMS_Vault CurrentVault();

Returns: IEDMS_Vault

Extension method of IVaultExplorerFormHelper (using DXP;).

CurrentVaultGUID

No description yet.

string CurrentVaultGUID();

Returns: string

EnsureFormInitialized

No description yet.

void EnsureFormInitialized(bool argctivateVault);

Parameter	Type	Passing
argctivateVault	bool	value

Returns: nothing (void)

GetSelectedItemGUIDs

No description yet.

void GetSelectedItemGUIDs(IStrings argItems);
void GetSelectedItemGUIDs(object argItems);

Parameter	Type	Passing
argItems	IStrings	value

Returns: nothing (void)

The first overload is an extension method of IVaultExplorerFormHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetSelectedItemRevisionGUIDs

No description yet.

void GetSelectedItemRevisionGUIDs(IStrings argItemRevisons);
void GetSelectedItemRevisionGUIDs(object argItemRevisons);

Parameter	Type	Passing
argItemRevisons	IStrings	value

Returns: nothing (void)

The first overload is an extension method of IVaultExplorerFormHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetVisible

No description yet.

bool GetVisible();

Returns: bool

ReceiveNotification

No description yet.

void ReceiveNotification(INotification argNotification);
void ReceiveNotification(object argNotification);

Parameter	Type	Passing
argNotification	INotification	value

Returns: nothing (void)

The first overload is an extension method of IVaultExplorerFormHelper (using DXP;) with typed parameters; the second is declared by the interface.

SectionNamePrefix

No description yet.

string SectionNamePrefix();

Returns: string

SetState_RefreshCurrentVault

No description yet.

void SetState_RefreshCurrentVault();

Returns: nothing (void)

ShowHidePanelButtons

No description yet.

void ShowHidePanelButtons(bool argShow);

Parameter	Type	Passing
argShow	bool	value

Returns: nothing (void)

Returned by

IVaultExplorerServer.ModalVaultExplorer, IVaultExplorerServer.SimpleVaultExplorer