ISch_Lib interface

This interface represents an existing library document open in Altium Designer. A library is composed of library pages and each page represents the symbol (schematic library component).

public interface ISch_Lib : ISch_Document

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_ParametrizedGroup → ISch_Document

Remarks

You can modify or set the document's preference settings.

You can invoke the ChooseLocationInteractively or ChooseRectangleInteractively methods to obtain coordinates from the Schematic sheet or library sheet.

You can check whether objects exist on a particular point on a schematic or library document.

You can iterate design objects in a library document, with the library iterator. This iterator is created by the SchLibIterator_Create method.

You can invoke the LibIsEmpty method to check if the library is empty (ie no symbols in the library) or not.

Due to the nature of a library document, all symbols (library components) are displayed on their library pages, so you iterate through the library to fetch symbols.

Properties

Property	Type	Access	Description
Current_SchComponent	ISch_Component	get; set	This property gets or sets the component as the current component in the library document.
CurrentSchComponentDisplayMode	byte	get; set
CurrentSchComponentLibReference	string	get; set
CurrentSchComponentPartId	int	get; set
Description	string	get; set	This property gets or sets the description of the library document.
FolderGUID	string	get; set
LifeCycleDefinitionGUID	string	get; set
ReleaseVaultGUID	string	get; set
RevisionNamingSchemeGUID	string	get; set
SchComponentByLibRef	ISch_Component	get
ShowHiddenPins	bool	get; set	This property gets or sets the visible property of hidden pins of the component in the library document.

Current_SchComponent

This property gets or sets the component as the current component in the library document.

ISch_Component GetState_Current_SchComponent();
void SetState_Current_SchComponent(ISch_Component argValue);

Type: ISch_Component · Access: read/write

The accessors are extension methods of ISch_LibHelper (using SCH;).

Examples: Extension_CreateSchComponent

CurrentSchComponentDisplayMode

No description yet.

byte GetState_CurrentSchComponentDisplayMode();
void SetState_CurrentSchComponentDisplayMode(byte argDisplayMode);

Type: byte · Access: read/write

CurrentSchComponentLibReference

No description yet.

string GetState_CurrentSchComponentLibReference();
void SetState_CurrentSchComponentLibReference(string argValue);

Type: string · Access: read/write

CurrentSchComponentPartId

No description yet.

int GetState_CurrentSchComponentPartId();
void SetState_CurrentSchComponentPartId(int argPartId);

Type: int · Access: read/write

Description

This property gets or sets the description of the library document.

string GetState_Description();
void SetState_Description(string argValue);

Type: string · Access: read/write

FolderGUID

No description yet.

string GetState_FolderGUID();
void SetState_FolderGUID(string argValue);

Type: string · Access: read/write

LifeCycleDefinitionGUID

No description yet.

string GetState_LifeCycleDefinitionGUID();
void SetState_LifeCycleDefinitionGUID(string argValue);

Type: string · Access: read/write

ReleaseVaultGUID

No description yet.

string GetState_ReleaseVaultGUID();
void SetState_ReleaseVaultGUID(string argValue);

Type: string · Access: read/write

RevisionNamingSchemeGUID

No description yet.

string GetState_RevisionNamingSchemeGUID();
void SetState_RevisionNamingSchemeGUID(string argValue);

Type: string · Access: read/write

SchComponentByLibRef

No description yet.

ISch_Component GetState_SchComponentByLibRef(string argLibRef);

Type: ISch_Component · Access: read-only · Index: argLibRef (string)

The accessors are extension methods of ISch_LibHelper (using SCH;).

Examples: Extension_RemoveSchLibComponent

ShowHiddenPins

This property gets or sets the visible property of hidden pins of the component in the library document.

bool GetState_ShowHiddenPins();
void SetState_ShowHiddenPins(bool argValue);

Type: bool · Access: read/write

Methods

Method	Returns	Description
AddSchComponent	void
LibIsEmpty	bool
LinkDocumentToReleaseVault	bool
LoadFromFile	void
ReleaseDocument	bool
RemoveSchComponent	void
SaveToFile	void
Sch_LibraryRuleChecker_Create	ISch_LibraryRuleChecker
Sch_LibraryRuleChecker_Destroy	void
SchLibIterator_Create	ISch_Iterator
SetState_CurrentSchComponentAddDisplayMode	void
SetState_CurrentSchComponentAddPart	void
SetState_CurrentSchComponentRemoveDisplayMode	void
SetState_CurrentSchComponentRemovePart	void
SplitIntoComponents	void
TransferComponentsPrimitivesBackFromEditor	void
TransferComponentsPrimitivesToEditor	void

AddSchComponent

No description yet.

void AddSchComponent(ISch_Component argComponent);
void AddSchComponent(object argComponent);

Parameter	Type	Passing
argComponent	ISch_Component	value

Returns: nothing (void)

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

Examples: Extension_CreateSchComponent

LibIsEmpty

No description yet.

bool LibIsEmpty();

Returns: bool

Examples: Extension_RemoveSchLibComponent

LinkDocumentToReleaseVault

No description yet.

bool LinkDocumentToReleaseVault(string argParameters, ref string argErrorMsg);

Parameter	Type	Passing
argParameters	string	value
argErrorMsg	string	ref

Returns: bool

LoadFromFile

No description yet.

void LoadFromFile(string argVFSAddress);

Parameter	Type	Passing
argVFSAddress	string	value

Returns: nothing (void)

ReleaseDocument

No description yet.

bool ReleaseDocument(string argParameters, ref string argErrorMsg);

Parameter	Type	Passing
argParameters	string	value
argErrorMsg	string	ref

Returns: bool

RemoveSchComponent

No description yet.

void RemoveSchComponent(ISch_Component argComponent);
void RemoveSchComponent(object argComponent);

Parameter	Type	Passing
argComponent	ISch_Component	value

Returns: nothing (void)

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

SaveToFile

No description yet.

void SaveToFile(string argVFSAddress);

Parameter	Type	Passing
argVFSAddress	string	value

Returns: nothing (void)

Sch_LibraryRuleChecker_Create

No description yet.

ISch_LibraryRuleChecker Sch_LibraryRuleChecker_Create();

Returns: ISch_LibraryRuleChecker

Extension method of ISch_LibHelper (using SCH;).

Sch_LibraryRuleChecker_Destroy

No description yet.

void Sch_LibraryRuleChecker_Destroy(ref ISch_LibraryRuleChecker argRuleChecker);
void Sch_LibraryRuleChecker_Destroy(ref object argRuleChecker);

Parameter	Type	Passing
argRuleChecker	ISch_LibraryRuleChecker	ref

Returns: nothing (void)

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

SchLibIterator_Create

No description yet.

ISch_Iterator SchLibIterator_Create();

Returns: ISch_Iterator

Extension method of ISch_LibHelper (using SCH;).

SetState_CurrentSchComponentAddDisplayMode

No description yet.

void SetState_CurrentSchComponentAddDisplayMode();

Returns: nothing (void)

SetState_CurrentSchComponentAddPart

No description yet.

void SetState_CurrentSchComponentAddPart();

Returns: nothing (void)

SetState_CurrentSchComponentRemoveDisplayMode

No description yet.

void SetState_CurrentSchComponentRemoveDisplayMode();

Returns: nothing (void)

SetState_CurrentSchComponentRemovePart

No description yet.

void SetState_CurrentSchComponentRemovePart();

Returns: nothing (void)

SplitIntoComponents

No description yet.

void SplitIntoComponents(string argOutputDirectoryPath, bool argOverwriteExistingFile, bool argRemoveParameter, bool argRemoveModel, bool argRemoveBadCharactersFromName);

Parameter	Type	Passing
argOutputDirectoryPath	string	value
argOverwriteExistingFile	bool	value
argRemoveParameter	bool	value
argRemoveModel	bool	value
argRemoveBadCharactersFromName	bool	value

Returns: nothing (void)

TransferComponentsPrimitivesBackFromEditor

No description yet.

void TransferComponentsPrimitivesBackFromEditor();

Returns: nothing (void)

TransferComponentsPrimitivesToEditor

No description yet.

void TransferComponentsPrimitivesToEditor();

Returns: nothing (void)

Inherited members

• From ISch_Document: BorderOn, BoundingRectangle_Selected, ChooseLocationInteractively, ChooseRectangleInteractively, CountContextMenuObjects, CreateHitTest, CreateLibraryFromProject, CustomMarginWidth, CustomSheetStyle, CustomX, CustomXZones, CustomY, CustomYZones, DocumentBorderStyle, DocumentName, GenerateUniqueID, GetPropsRevisionGUID, GetPropsVaultGUID, GetTemplateItemGUID, GetTemplateRevisionGUID, GetTemplateRevisionHRID, GetTemplateVaultGUID, GetTemplateVaultHRID, Graphical_VirtualRectangle, GridCoordinateClosest, GridCoordinateUp, HasServerDocument, HotspotGridOn, HotspotGridSize, InternalTolerance, IsInEditorView, LoadFormat, LockViewUpdate, MinorVersion, Notify_FullUpdate, ObjectReferenceZone, PopupMenuHitTest, RecreateHandles, RedrawToDC, ReferenceZonesOn, RegisterSchObjectInContainer, SchDocID, SetPreferencesInfo, SetTemplateInfo, SheetMarginWidth, SheetSizeX, SheetSizeY, SheetStyle, SheetZonesX, SheetZonesY, ShowTemplateGraphics, SnapGridOn, SnapGridSize, SystemFont, TemplateFileName, TitleBlockOn, Unit, UnitSystem, UnLockViewUpdate, UnregisterAndFreeAllConnectionLines, UnRegisterSchObjectFromContainer, UpdateDisplayForCurrentSheet, UpdateDocumentProperties, UseCustomSheet, VisibleGridOn, VisibleGridSize, WorkspaceOrientation
• From ISch_ParametrizedGroup: Import_FromUser_Parameters, ResetAllSchParametersPosition
• From ISch_GraphicalObject: AddErrorString, AreaColor, BoundingRectangle, BoundingRectangle_Full, Color, CompilationMasked, Dimmed, Disabled, DisplayError, EnableDraw, ErrorColor, ErrorKind, ErrorString, GetHash, GraphicallyInvalidate, LiveHighlightValue, Location, Mirror, MoveByXY, MoveToXY, OwnerPartDisplayMode, OwnerPartId, ResetErrorFields, RotateBy90, Selection, SetState_xSizeySize
• From ISch_BasicContainer: AddAndPositionSchObject, AddSchObject, CopyTo, DeleteAll, DescriptionString, ExportToParameters, FreeAllContainedObjects, Handle, IdentifierString, Import_FromUser, ObjectId, OwnerSchDocument, RemoveSchObject, Replicate, SchBasicContainer, SchIterator_Create, SchIterator_Destroy, SchParameterByName, Setstate_Default, Text, UniqueId, WiringDiagramOriginUniqueId

Returned by

ISch_ServerInterface.CreateSchLibrary

Accepted by

ISch_ServerInterface.DestroySchLibrary

Examples

Used in the SDK examples: Extension_CreateSchComponent, Extension_RemoveSchLibComponent.