IULB_Folder interface

No description yet.

public interface IULB_Folder : IEDM_ShareableRecord

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Inherits: IEDM_Object → IEDM_Record → IEDM_ShareableRecord

Properties

Property	Type	Access	Description
Attributes	int	get; set
Description	string	get; set
FolderTypeGUID	string	get; set
IsActive	bool	get; set
IsShared	bool	get; set
NamingScheme	string	get; set
ParentFolderGUID	string	get; set
SharedName	string	get; set
SharingControl	int	get; set
SubFolder	IULB_Folder	get; set
Weight	int	get; set

Attributes

No description yet.

int GetAttributes();
void SetAttributes(int argValue);

Type: int · Access: read/write

Description

No description yet.

string GetDescription();
void SetDescription(string argValue);

Type: string · Access: read/write

FolderTypeGUID

No description yet.

string GetFolderTypeGUID();
void SetFolderTypeGUID(string argValue);

Type: string · Access: read/write

IsActive

No description yet.

bool GetIsActive();
void SetIsActive(bool argValue);

Type: bool · Access: read/write

IsShared

No description yet.

bool GetIsShared();
void SetIsShared(bool argValue);

Type: bool · Access: read/write

NamingScheme

No description yet.

string GetNamingScheme();
void SetNamingScheme(string argValue);

Type: string · Access: read/write

ParentFolderGUID

No description yet.

string GetParentFolderGUID();
void SetParentFolderGUID(string argValue);

Type: string · Access: read/write

SharedName

No description yet.

string GetSharedName();
void SetSharedName(string argValue);

Type: string · Access: read/write

SharingControl

No description yet.

int GetSharingControl();
void SetSharingControl(int argValue);

Type: int · Access: read/write

SubFolder

No description yet.

IULB_Folder GetSubFolder(int argIndex);
void SetSubFolder(int argIndex, IULB_Folder argRecord);

Type: IULB_Folder · Access: read/write · Index: argIndex (int)

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

Weight

No description yet.

int GetWeight();
void SetWeight(int argValue);

Type: int · Access: read/write

Methods

Method	Returns	Description
AddFolderParameter	void
AddSubFolder	void
ClearSubFolders	void
DeleteSubFolder	void
FilterFolderTree	void
FindFolder	IULB_Folder
GetParameter	IULB_FolderParameter
GetParameterByGUID	IULB_FolderParameter
GetParameterCount	int
GetSubFolderCount	int
RemoveAllParameters	void
RemoveFolderParameter	void

AddFolderParameter

No description yet.

void AddFolderParameter(IULB_FolderParameter argParameter);
void AddFolderParameter(object argParameter);

Parameter	Type	Passing
argParameter	IULB_FolderParameter	value

Returns: nothing (void)

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

AddSubFolder

No description yet.

void AddSubFolder(IULB_Folder argRecord);
void AddSubFolder(object argRecord);

Parameter	Type	Passing
argRecord	IULB_Folder	value

Returns: nothing (void)

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

ClearSubFolders

No description yet.

void ClearSubFolders();

Returns: nothing (void)

DeleteSubFolder

No description yet.

void DeleteSubFolder(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

FilterFolderTree

No description yet.

void FilterFolderTree(string argContentTypes);

Parameter	Type	Passing
argContentTypes	string	value

Returns: nothing (void)

FindFolder

No description yet.

IULB_Folder FindFolder(string argGUID);

Parameter	Type	Passing
argGUID	string	value

Returns: IULB_Folder

Extension method of IULB_FolderHelper (using DXP;).

GetParameter

No description yet.

IULB_FolderParameter GetParameter(int argi);

Parameter	Type	Passing
argi	int	value

Returns: IULB_FolderParameter

Extension method of IULB_FolderHelper (using DXP;).

GetParameterByGUID

No description yet.

IULB_FolderParameter GetParameterByGUID(string argGUID);

Parameter	Type	Passing
argGUID	string	value

Returns: IULB_FolderParameter

Extension method of IULB_FolderHelper (using DXP;).

GetParameterCount

No description yet.

int GetParameterCount();

Returns: int

GetSubFolderCount

No description yet.

int GetSubFolderCount();

Returns: int

RemoveAllParameters

No description yet.

void RemoveAllParameters();

Returns: nothing (void)

RemoveFolderParameter

No description yet.

void RemoveFolderParameter(string argGUID);

Parameter	Type	Passing
argGUID	string	value

Returns: nothing (void)

Inherited members

• From IEDM_ShareableRecord: CanCreate, CanDelete, CanRead, CanUpdate
• From IEDM_Record: CreatedByGUID, CreatedByName, CreatedDate, GUID, HRID, LastModifiedByGUID, LastModifiedByName, LastModifiedDate
• From IEDM_Object: CopyTo, Replicate

Returned by

IEDMS_Vault.CreateFolder, IEDMS_Vault.FolderByGUID, IEDMS_Vault.FolderByHRID, IFolderDetailsFrame.CurrentFolder, IModalAction.GetCurrentFolder, IULB_FoldersResult.GetFirstFolder, IULB_FoldersResult.GetFolderByGUID, IVaultExplorerForm.CurrentFolder

Accepted by

IComponentLibraryManager.GenerateItemNames, IComponentLibraryManager.GetItemNameGenerator, IEDMS_PermissionSetWrapper.ExportToVault, IEDM_Script.AddFolder, IEDM_Script.UpdateFolder, IEDesignDataInterface.CreatePermissionSetWrapper, IEDesignDataInterface.ExecuteFolderPermissionForm, IEDesignDataInterface.ExecuteNewFolderPermissionForm, IEDesignDataInterface.GetCandidateItemName, IEDesignDataInterface.GetCandidateItemNames, IEDesignData_GUIActions.BrowseFolders, IEDesignData_VaultAspectItemsPopup.BatchEditItemRevision, IEDesignData_VaultAspectItemsPopup.CanCloneItemRevision, IEDesignData_VaultAspectItemsPopup.CanEditItemRevision, IEDesignData_VaultAspectItemsPopup.CloneItemRevision, IEDesignData_VaultAspectItemsPopup.CreateAndEditItem, IEDesignData_VaultAspectItemsPopup.EditItemRevision, IEDesignData_VaultAspectItemsPopup.Popup, IEDesignData_VaultAspectItemsPopup.PopupEx, IFolderAspectView.SetState, IFolderSelectionHandler.HandleEvent

Examples

Used in the SDK examples: Extension_GetVaultFolder.