IEDesignDataInterface interface

No description yet.

public interface IEDesignDataInterface

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ReleaseManager	IEDesignData_ReleaseManager	get

ReleaseManager

No description yet.

IEDesignData_ReleaseManager GetState_ReleaseManager();

Type: IEDesignData_ReleaseManager · Access: read-only

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

Methods

Method	Returns	Description
CreateLinkToVaultFrame	ILinkToVaultFrame
CreateModel	IEDesignData_Item
CreateNewItem	bool
CreateNewItemExt	bool
CreatePermissionSetWrapper	bool
CreatePlannedRevision	IULB_ItemRevision
CreatePreviewFrame	IEDesignData_PreviewFrame
CreateSupplyChainFrame	IEDesignData_SupplyChainFrame
DeleteComponents	void
DeleteItems	void
EditItemProperties	bool
ExecuteFolderPermissionForm	bool
ExecuteManagedProjectPermissionForm	bool
ExecuteNewFolderPermissionForm	bool
FreeBynaryUpload	bool
GenerateItemHRIDList	void
GeneratorRegistry	IGeneratorRegistry
Get32x32ImagefileNameFromContentTypeGUID	string
Get32x32ImagefileNameFromFolderType	string
Get48x48ImagefileNameFromContentTypeGUID	string
GetCandidateItemName	string
GetCandidateItemNames	bool
GetFolderAspectManager	IFolderAspectManager
GetGUIActions	IEDesignData_GUIActions
GetHWPartDocumentByPath	IEDesignData_HWPartDocument
GetImageIndexesForDocumentKind	IIntegers
GetImageIndexesForFolderType	IIntegers
GetItemImageIndexesForContentTypeGUID	IIntegers
GetPartChoiceListDocumentByPath	IEDesignData_PartChoiceListDocument
GetPreparedImages	IWideStrings
GetPublishingManager	IPublishingManager
GetReleasedItemForm	IReleasedItemForm
GetRevisionAspectManager	IRevisionAspectManager
GetRevisionForRelease	IULB_ItemRevision
GetRevisionForReleaseSilent	IULB_ItemRevision
GetRevisionForReleaseSilentExt	IULB_ItemRevision
GetRevisionForReleaseSilentExt2	IULB_ItemRevision
GetStateSelected	void
GetSubFolderTypesFromFolderType	IStrings
GetVcsBasedProjectActions	IEDesignData_VcsBasedProjectActions
MakeNewItem	bool
PrepareRevisionForRelease	IULB_ItemRevision
PrepareRevisionForReleaseExt	IULB_ItemRevision
SetInitialRevisionId	void
ShowItemProperties	void
ShowItemRevisionDifferences	void
ShowRevisionProperties	void
UpdateRevision	bool
ValidateNamingScheme	bool

CreateLinkToVaultFrame

No description yet.

ILinkToVaultFrame CreateLinkToVaultFrame(bool argShowLinkOption, string argContentTypeGUIDsFilter, string argFolderTypeGUIDsFilter);

Parameter	Type	Passing
argShowLinkOption	bool	value
argContentTypeGUIDsFilter	string	value
argFolderTypeGUIDsFilter	string	value

Returns: ILinkToVaultFrame

Extension method of IEDesignDataInterfaceHelper (using DXP;).

CreateModel

No description yet.

IEDesignData_Item CreateModel();

Returns: IEDesignData_Item

Extension method of IEDesignDataInterfaceHelper (using DXP;).

CreateNewItem

No description yet.

bool CreateNewItem(IEDMS_Vault argVault, out IULB_Item argItem, out IULB_ItemRevision argRevision);
bool CreateNewItem(object argVault, out IULB_Item argItem, out IULB_ItemRevision argRevision);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argItem	IULB_Item	out
argRevision	IULB_ItemRevision	out

Returns: bool

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

CreateNewItemExt

No description yet.

bool CreateNewItemExt(IEDMS_Vault argVault, ref string argParameters, out IULB_Item argItem, out IULB_ItemRevision argRevision);
bool CreateNewItemExt(object argVault, ref string argParameters, out IULB_Item argItem, out IULB_ItemRevision argRevision);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argParameters	string	ref
argItem	IULB_Item	out
argRevision	IULB_ItemRevision	out

Returns: bool

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

CreatePermissionSetWrapper

No description yet.

bool CreatePermissionSetWrapper(IEDMS_Vault argVault, IULB_Folder argFolder, out IEDMS_PermissionSetWrapper argWrapper);
bool CreatePermissionSetWrapper(object argVault, object argFolder, out IEDMS_PermissionSetWrapper argWrapper);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argFolder	IULB_Folder	value
argWrapper	IEDMS_PermissionSetWrapper	out

Returns: bool

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

CreatePlannedRevision

No description yet.

IULB_ItemRevision CreatePlannedRevision(IEDMS_Vault argVault, IULB_LifeCycleState argState, IULB_ItemRevision argDItemRevision, string argCaption, string argReleasedItemId, string argncestorID, string argncestorGUID);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argState	IULB_LifeCycleState	value
argDItemRevision	IULB_ItemRevision	value
argCaption	string	value
argReleasedItemId	string	value
argncestorID	string	value
argncestorGUID	string	value

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

CreatePreviewFrame

No description yet.

IEDesignData_PreviewFrame CreatePreviewFrame();

Returns: IEDesignData_PreviewFrame

Extension method of IEDesignDataInterfaceHelper (using DXP;).

CreateSupplyChainFrame

No description yet.

IEDesignData_SupplyChainFrame CreateSupplyChainFrame();

Returns: IEDesignData_SupplyChainFrame

Extension method of IEDesignDataInterfaceHelper (using DXP;).

DeleteComponents

No description yet.

void DeleteComponents(bool argLoadItems, string argVaultGUID, IWideStrings argItemsGUIDs, IWideStrings argItemsHRIDs);
void DeleteComponents(bool argLoadItems, string argVaultGUID, object argItemsGUIDs, object argItemsHRIDs);

Parameter	Type	Passing
argLoadItems	bool	value
argVaultGUID	string	value
argItemsGUIDs	IWideStrings	value
argItemsHRIDs	IWideStrings	value

Returns: nothing (void)

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

DeleteItems

No description yet.

void DeleteItems(bool argLoadItems, string argVaultGUID, IWideStrings argItemsGUIDs, IWideStrings argItemsHRIDs);
void DeleteItems(bool argLoadItems, string argVaultGUID, object argItemsGUIDs, object argItemsHRIDs);

Parameter	Type	Passing
argLoadItems	bool	value
argVaultGUID	string	value
argItemsGUIDs	IWideStrings	value
argItemsHRIDs	IWideStrings	value

Returns: nothing (void)

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

EditItemProperties

No description yet.

bool EditItemProperties(IEDMS_Vault argVault, IULB_Item argItem, IULB_ItemRevision argRevision);
bool EditItemProperties(object argVault, object argItem, object argRevision);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argItem	IULB_Item	value
argRevision	IULB_ItemRevision	value

Returns: bool

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

ExecuteFolderPermissionForm

No description yet.

bool ExecuteFolderPermissionForm(IEDMS_Vault argVault, IULB_Folder argFolder);
bool ExecuteFolderPermissionForm(object argVault, object argFolder);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argFolder	IULB_Folder	value

Returns: bool

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

ExecuteManagedProjectPermissionForm

No description yet.

bool ExecuteManagedProjectPermissionForm(IEDMS_ManagedProject argProject);
bool ExecuteManagedProjectPermissionForm(object argProject);

Parameter	Type	Passing
argProject	IEDMS_ManagedProject	value

Returns: bool

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

ExecuteNewFolderPermissionForm

No description yet.

bool ExecuteNewFolderPermissionForm(IEDMS_Vault argVault, IULB_Folder argFolder, ref IEDMS_PermissionSetWrapper argPermissionSet);
bool ExecuteNewFolderPermissionForm(object argVault, object argFolder, ref object argPermissionSet);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argFolder	IULB_Folder	value
argPermissionSet	IEDMS_PermissionSetWrapper	ref

Returns: bool

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

FreeBynaryUpload

No description yet.

bool FreeBynaryUpload(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: bool

GenerateItemHRIDList

No description yet.

void GenerateItemHRIDList(string argVaultGUID, string argSimpleScheme, int argCount, IStrings argHRIDList);
void GenerateItemHRIDList(string argVaultGUID, string argSimpleScheme, int argCount, object argHRIDList);

Parameter	Type	Passing
argVaultGUID	string	value
argSimpleScheme	string	value
argCount	int	value
argHRIDList	IStrings	value

Returns: nothing (void)

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

GeneratorRegistry

No description yet.

IGeneratorRegistry GeneratorRegistry();

Returns: IGeneratorRegistry

Extension method of IEDesignDataInterfaceHelper (using DXP;).

Get32x32ImagefileNameFromContentTypeGUID

No description yet.

string Get32x32ImagefileNameFromContentTypeGUID(string argContentTypeGUID);

Parameter	Type	Passing
argContentTypeGUID	string	value

Returns: string

Get32x32ImagefileNameFromFolderType

No description yet.

string Get32x32ImagefileNameFromFolderType(string argFolderTypeGUID);

Parameter	Type	Passing
argFolderTypeGUID	string	value

Returns: string

Get48x48ImagefileNameFromContentTypeGUID

No description yet.

string Get48x48ImagefileNameFromContentTypeGUID(string argContentTypeGUID);

Parameter	Type	Passing
argContentTypeGUID	string	value

Returns: string

GetCandidateItemName

No description yet.

string GetCandidateItemName(IEDMS_Vault argVault, IULB_Folder argFolder, IULB_ContentType argItemContentType, int argFirstIndex);
string GetCandidateItemName(object argVault, object argFolder, object argItemContentType, int argFirstIndex);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argFolder	IULB_Folder	value
argItemContentType	IULB_ContentType	value
argFirstIndex	int	value

Returns: string

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

GetCandidateItemNames

No description yet.

bool GetCandidateItemNames(IEDMS_Vault argVault, IULB_Folder argFolder, IULB_ContentType argItemContentType, int argCount, IStrings argList, int argFirstIndex);
bool GetCandidateItemNames(object argVault, object argFolder, object argItemContentType, int argCount, object argList, int argFirstIndex);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argFolder	IULB_Folder	value
argItemContentType	IULB_ContentType	value
argCount	int	value
argList	IStrings	value
argFirstIndex	int	value

Returns: bool

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

GetFolderAspectManager

No description yet.

IFolderAspectManager GetFolderAspectManager();

Returns: IFolderAspectManager

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetGUIActions

No description yet.

IEDesignData_GUIActions GetGUIActions();

Returns: IEDesignData_GUIActions

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetHWPartDocumentByPath

No description yet.

IEDesignData_HWPartDocument GetHWPartDocumentByPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: IEDesignData_HWPartDocument

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetImageIndexesForDocumentKind

No description yet.

IIntegers GetImageIndexesForDocumentKind(IWideStrings argDocumentKinds);

Parameter	Type	Passing
argDocumentKinds	IWideStrings	value

Returns: IIntegers

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetImageIndexesForFolderType

No description yet.

IIntegers GetImageIndexesForFolderType(IWideStrings argFolderTypes);

Parameter	Type	Passing
argFolderTypes	IWideStrings	value

Returns: IIntegers

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetItemImageIndexesForContentTypeGUID

No description yet.

IIntegers GetItemImageIndexesForContentTypeGUID(IWideStrings argContentTypes);

Parameter	Type	Passing
argContentTypes	IWideStrings	value

Returns: IIntegers

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetPartChoiceListDocumentByPath

No description yet.

IEDesignData_PartChoiceListDocument GetPartChoiceListDocumentByPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: IEDesignData_PartChoiceListDocument

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetPreparedImages

No description yet.

IWideStrings GetPreparedImages(string argTargetPath, IIntegers argImageIndexList);

Parameter	Type	Passing
argTargetPath	string	value
argImageIndexList	IIntegers	value

Returns: IWideStrings

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetPublishingManager

No description yet.

IPublishingManager GetPublishingManager();

Returns: IPublishingManager

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetReleasedItemForm

No description yet.

IReleasedItemForm GetReleasedItemForm(TReleasedItemFormType argFormType, IEDMS_Vault argVault);

Parameter	Type	Passing
argFormType	TReleasedItemFormType	value
argVault	IEDMS_Vault	value

Returns: IReleasedItemForm

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetRevisionAspectManager

No description yet.

IRevisionAspectManager GetRevisionAspectManager();

Returns: IRevisionAspectManager

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetRevisionForRelease

No description yet.

IULB_ItemRevision GetRevisionForRelease(string argVaultGUID, string argnAncestorRevisionGUID, string argComment, string argDescription, TRevisionLevel argIncrementLevel, out string argReleaseNotes, out bool argNeedCreateItemRevision, out IInterfaceList argItemRevisionList);

Parameter	Type	Passing
argVaultGUID	string	value
argnAncestorRevisionGUID	string	value
argComment	string	value
argDescription	string	value
argIncrementLevel	TRevisionLevel	value
argReleaseNotes	string	out
argNeedCreateItemRevision	bool	out
argItemRevisionList	IInterfaceList	out

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetRevisionForReleaseSilent

No description yet.

IULB_ItemRevision GetRevisionForReleaseSilent(string argVaultGUID, string argnAncestorRevisionGUID, string argComment, string argDescription, TRevisionLevel argIncrementLevel, out bool argNeedCreateItemRevision);

Parameter	Type	Passing
argVaultGUID	string	value
argnAncestorRevisionGUID	string	value
argComment	string	value
argDescription	string	value
argIncrementLevel	TRevisionLevel	value
argNeedCreateItemRevision	bool	out

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetRevisionForReleaseSilentExt

No description yet.

IULB_ItemRevision GetRevisionForReleaseSilentExt(string argVaultGUID, string argnAncestorRevisionGUID, string argComment, string argDescription, TRevisionLevel argIncrementLevel, IULB_RevisionNamingScheme argRevisionNamingScheme, IULB_LifeCycleDefinition argLifeCycleDefinition, out bool argNeedCreateItemRevision);

Parameter	Type	Passing
argVaultGUID	string	value
argnAncestorRevisionGUID	string	value
argComment	string	value
argDescription	string	value
argIncrementLevel	TRevisionLevel	value
argRevisionNamingScheme	IULB_RevisionNamingScheme	value
argLifeCycleDefinition	IULB_LifeCycleDefinition	value
argNeedCreateItemRevision	bool	out

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetRevisionForReleaseSilentExt2

No description yet.

IULB_ItemRevision GetRevisionForReleaseSilentExt2(string argVaultGUID, string argnAncestorRevisionGUID, string argComment, string argDescription, TRevisionLevel argIncrementLevel, IULB_RevisionNamingScheme argRevisionNamingScheme, IULB_LifeCycleDefinition argLifeCycleDefinition, out bool argNeedCreateItemRevision, out string argErrorMsg);

Parameter	Type	Passing
argVaultGUID	string	value
argnAncestorRevisionGUID	string	value
argComment	string	value
argDescription	string	value
argIncrementLevel	TRevisionLevel	value
argRevisionNamingScheme	IULB_RevisionNamingScheme	value
argLifeCycleDefinition	IULB_LifeCycleDefinition	value
argNeedCreateItemRevision	bool	out
argErrorMsg	string	out

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetStateSelected

No description yet.

void GetStateSelected(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

GetSubFolderTypesFromFolderType

No description yet.

IStrings GetSubFolderTypesFromFolderType(string argFolderTypeGUID);

Parameter	Type	Passing
argFolderTypeGUID	string	value

Returns: IStrings

Extension method of IEDesignDataInterfaceHelper (using DXP;).

GetVcsBasedProjectActions

No description yet.

IEDesignData_VcsBasedProjectActions GetVcsBasedProjectActions();

Returns: IEDesignData_VcsBasedProjectActions

Extension method of IEDesignDataInterfaceHelper (using DXP;).

MakeNewItem

No description yet.

bool MakeNewItem(IEDMS_Vault argVault, IULB_Item argItem, IULB_ItemRevision argRevision, out string argNewItemGUID, out string argNewItemFolderGUID);
bool MakeNewItem(object argVault, object argItem, object argRevision, out string argNewItemGUID, out string argNewItemFolderGUID);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argItem	IULB_Item	value
argRevision	IULB_ItemRevision	value
argNewItemGUID	string	out
argNewItemFolderGUID	string	out

Returns: bool

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

PrepareRevisionForRelease

No description yet.

IULB_ItemRevision PrepareRevisionForRelease(IULB_ItemRevision argInitialRevision, ref string argParameters, out bool argNeedCreateItemRevision, out IInterfaceList argItemRevisionList);

Parameter	Type	Passing
argInitialRevision	IULB_ItemRevision	value
argParameters	string	ref
argNeedCreateItemRevision	bool	out
argItemRevisionList	IInterfaceList	out

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

PrepareRevisionForReleaseExt

No description yet.

IULB_ItemRevision PrepareRevisionForReleaseExt(IULB_ItemRevision argInitialRevision, ref string argParameters, IStrings argSkipRelatedItemGUIDList, out bool argNeedCreateItemRevision, out IInterfaceList argItemRevisionList);

Parameter	Type	Passing
argInitialRevision	IULB_ItemRevision	value
argParameters	string	ref
argSkipRelatedItemGUIDList	IStrings	value
argNeedCreateItemRevision	bool	out
argItemRevisionList	IInterfaceList	out

Returns: IULB_ItemRevision

Extension method of IEDesignDataInterfaceHelper (using DXP;).

SetInitialRevisionId

No description yet.

void SetInitialRevisionId(IULB_ItemRevision argRevision, IULB_RevisionNamingScheme argRevisionScheme);
void SetInitialRevisionId(object argRevision, object argRevisionScheme);

Parameter	Type	Passing
argRevision	IULB_ItemRevision	value
argRevisionScheme	IULB_RevisionNamingScheme	value

Returns: nothing (void)

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

ShowItemProperties

No description yet.

void ShowItemProperties(IEDMS_Vault argVault, IULB_Item argItem, IULB_ItemRevision argRevision);
void ShowItemProperties(object argVault, object argItem, object argRevision);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argItem	IULB_Item	value
argRevision	IULB_ItemRevision	value

Returns: nothing (void)

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

ShowItemRevisionDifferences

No description yet.

void ShowItemRevisionDifferences(IEDMS_Vault argVault, string argRevisionGUID1, string argRevisionGUID2);
void ShowItemRevisionDifferences(object argVault, string argRevisionGUID1, string argRevisionGUID2);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argRevisionGUID1	string	value
argRevisionGUID2	string	value

Returns: nothing (void)

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

ShowRevisionProperties

No description yet.

void ShowRevisionProperties(IEDMS_Vault argVault, IULB_ItemRevision argRevision);
void ShowRevisionProperties(object argVault, object argRevision);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argRevision	IULB_ItemRevision	value

Returns: nothing (void)

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

UpdateRevision

No description yet.

bool UpdateRevision(IEDMS_Vault argVault, IULB_ItemRevision argRevision);
bool UpdateRevision(object argVault, object argRevision);

Parameter	Type	Passing
argVault	IEDMS_Vault	value
argRevision	IULB_ItemRevision	value

Returns: bool

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

ValidateNamingScheme

No description yet.

bool ValidateNamingScheme(string argNamingScheme);

Parameter	Type	Passing
argNamingScheme	string	value

Returns: bool

Returned by

GlobalVars.EDesignData