IComponentLibraryDocument interface

No description yet.

public interface IComponentLibraryDocument : IServerDocument

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Inherits: IServerDocument

Properties

Property	Type	Access	Description
CommandHandler	IComponentLibraryCommandHandler	get; set
ComponentSet	IComponentSet	get; set

CommandHandler

No description yet.

IComponentLibraryCommandHandler GetCommandHandler();
void SetCommandHandler(IComponentLibraryCommandHandler argHandler);

Type: IComponentLibraryCommandHandler · Access: read/write

The accessors are extension methods of IComponentLibraryDocumentHelper (using ComponentLib;).

ComponentSet

No description yet.

IComponentSet GetComponentSet();
void SetComponentSet(IComponentSet argValue);

Type: IComponentSet · Access: read/write

The accessors are extension methods of IComponentLibraryDocumentHelper (using ComponentLib;).

Methods

Method	Returns	Description
CreateComponentDefinition	IComponentDefinition
CreateComponentSet	IComponentSet
CreateGroup	IGroup
CreateModelChoice	IModelChoice
CreateModelLink	IModelLink
CreateParameter	IParameter
CreatePartChoice	IPartChoice
CreatePartChoiceData	IPartChoiceData
CreatePartChoiceDatas	IPartChoiceDataList
CreatePartChoiceListChoice	IPartChoiceListChoice
CreatePartChoiceListLink	IPartChoiceListLink
CreateRequiredModel	IRequiredModel
CreateRequiredParameter	IRequiredParameter
CreateRequiredPartChoice	IRequiredPartChoice
DestroyAbstractObject	void
GetIsSingleEditorMode	bool
GetModelDisplayName	string
GetSelectedComponents	IComponentDefinitionList
Refresh	void
SetModelDisplayName	void
SwitchEditorView	void
UpdateItemToLatestRevision	void

CreateComponentDefinition

No description yet.

IComponentDefinition CreateComponentDefinition();

Returns: IComponentDefinition

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateComponentSet

No description yet.

IComponentSet CreateComponentSet();

Returns: IComponentSet

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateGroup

No description yet.

IGroup CreateGroup();

Returns: IGroup

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateModelChoice

No description yet.

IModelChoice CreateModelChoice();

Returns: IModelChoice

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateModelLink

No description yet.

IModelLink CreateModelLink();

Returns: IModelLink

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateParameter

No description yet.

IParameter CreateParameter();

Returns: IParameter

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreatePartChoice

No description yet.

IPartChoice CreatePartChoice();

Returns: IPartChoice

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreatePartChoiceData

No description yet.

IPartChoiceData CreatePartChoiceData();

Returns: IPartChoiceData

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreatePartChoiceDatas

No description yet.

IPartChoiceDataList CreatePartChoiceDatas();

Returns: IPartChoiceDataList

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreatePartChoiceListChoice

No description yet.

IPartChoiceListChoice CreatePartChoiceListChoice();

Returns: IPartChoiceListChoice

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreatePartChoiceListLink

No description yet.

IPartChoiceListLink CreatePartChoiceListLink();

Returns: IPartChoiceListLink

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateRequiredModel

No description yet.

IRequiredModel CreateRequiredModel();

Returns: IRequiredModel

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateRequiredParameter

No description yet.

IRequiredParameter CreateRequiredParameter();

Returns: IRequiredParameter

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

CreateRequiredPartChoice

No description yet.

IRequiredPartChoice CreateRequiredPartChoice();

Returns: IRequiredPartChoice

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

DestroyAbstractObject

No description yet.

void DestroyAbstractObject(IAbstractObject argbstractObject);
void DestroyAbstractObject(object argbstractObject);

Parameter	Type	Passing
argbstractObject	IAbstractObject	value

Returns: nothing (void)

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

GetIsSingleEditorMode

No description yet.

bool GetIsSingleEditorMode();

Returns: bool

GetModelDisplayName

No description yet.

string GetModelDisplayName(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: string

GetSelectedComponents

No description yet.

IComponentDefinitionList GetSelectedComponents();

Returns: IComponentDefinitionList

Extension method of IComponentLibraryDocumentHelper (using ComponentLib;).

Refresh

No description yet.

void Refresh(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

SetModelDisplayName

No description yet.

void SetModelDisplayName(string argFileName, string argDisplayName, bool argNeedToSave);

Parameter	Type	Passing
argFileName	string	value
argDisplayName	string	value
argNeedToSave	bool	value

Returns: nothing (void)

SwitchEditorView

No description yet.

void SwitchEditorView(bool argClassicView);

Parameter	Type	Passing
argClassicView	bool	value

Returns: nothing (void)

UpdateItemToLatestRevision

No description yet.

void UpdateItemToLatestRevision(string argItemGUID);

Parameter	Type	Passing
argItemGUID	string	value

Returns: nothing (void)

Inherited members

• From IServerDocument: AcquireDataFileHandle, AcquireFileOwnership, AddView, BeingClosed, CanCreateSnippet, CanPlaceSnippet, CreateSnippetFile, DocumentDirectoryChanged, DoFileLoad, DoFileSave, DoSafeChangeFileNameAndSave, DoSafeFileSave, FileModifiedDate, FileName, Focus, GetCanClose, GetContextHelpTopicName, GetCount, GetDocumentModifiedDate, GetKind, GetServerModule, GetSnippetView, GetSupportsOwnSave, GetView, GetViewByName, IsShown, Modified, NotifyViews, OwnsFile, PlaceSnippet, ReleaseDataFileHandle, ReleaseFileOwnership, SupportsReload, UpdateModifiedDate, WarnIfOwnedByOther, ZoomSnippetContents

Returned by

IComponentLibraryManager.CreateComponentLibrary, IComponentLibraryManager.GetComponentLibraryByFileName, IComponentLibraryManager.GetCurrentComponentLibrary