IHighlightedDocument interface

This IHighlightedDocument interface represents a mechanism that deals with highlighting of objects on a design document (especially Schematic and PCB documents) in Altium Designer when objects are being selected or deselected and when being masked or not.

public interface IHighlightedDocument : IServerDocument

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IServerDocument

Remarks

This interface and its methods are for internal use.

The IHighlightedDocument interface is inherited from the IServerDocument interface.

Methods

Method	Returns	Description
HL_Begin	void
HL_ChooseObjectGraphically	bool
HL_End	void
HL_GetHighlightedNet	INet
HL_GetLinkedObject	IDMObject
HL_HighlightMethod_Add	void
HL_HighlightMethod_Clear	void
HL_HighlightMethod_IsApplicable	bool
HL_HighlightMethod_Remove	void
HL_ObjectCount	int
HL_Objects	IDMObject
HL_Perform	void
HL_Register_Area	void
HL_Register_Bus	void
HL_Register_Component	void
HL_Register_DMObject	void
HL_Register_Net	void
HL_Register_NetItem	void
HL_Register_Part	void
HL_Register_VHDLEntity	void
HL_SetHighlightedNet	void
HL_UnRegister_AllObjects	void
HL_UnRegister_Object	void
HL_XProbeChooseObject	bool

HL_Begin

No description yet.

void HL_Begin();

Returns: nothing (void)

HL_ChooseObjectGraphically

No description yet.

bool HL_ChooseObjectGraphically(ref IDMObject argDMObject);
bool HL_ChooseObjectGraphically(ref object argDMObject);

Parameter	Type	Passing
argDMObject	IDMObject	ref

Returns: bool

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

HL_End

No description yet.

void HL_End();

Returns: nothing (void)

HL_GetHighlightedNet

No description yet.

INet HL_GetHighlightedNet();

Returns: INet

Extension method of IHighlightedDocumentHelper (using EDP;).

HL_GetLinkedObject

No description yet.

IDMObject HL_GetLinkedObject(IDMObject argDMObject);

Parameter	Type	Passing
argDMObject	IDMObject	value

Returns: IDMObject

Extension method of IHighlightedDocumentHelper (using EDP;).

HL_HighlightMethod_Add

No description yet.

void HL_HighlightMethod_Add(THighlightMethod argHighlightMethod);
void HL_HighlightMethod_Add(int argHighlightMethod);

Parameter	Type	Passing
argHighlightMethod	THighlightMethod	value

Returns: nothing (void)

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

HL_HighlightMethod_Clear

No description yet.

void HL_HighlightMethod_Clear(THighlightMethod argHighlightMethod);
void HL_HighlightMethod_Clear(int argHighlightMethod);

Parameter	Type	Passing
argHighlightMethod	THighlightMethod	value

Returns: nothing (void)

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

HL_HighlightMethod_IsApplicable

No description yet.

bool HL_HighlightMethod_IsApplicable(THighlightMethod argHighlightMethod);
bool HL_HighlightMethod_IsApplicable(int argHighlightMethod);

Parameter	Type	Passing
argHighlightMethod	THighlightMethod	value

Returns: bool

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

HL_HighlightMethod_Remove

No description yet.

void HL_HighlightMethod_Remove(THighlightMethod argHighlightMethod);
void HL_HighlightMethod_Remove(int argHighlightMethod);

Parameter	Type	Passing
argHighlightMethod	THighlightMethod	value

Returns: nothing (void)

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

HL_ObjectCount

No description yet.

int HL_ObjectCount();

Returns: int

HL_Objects

No description yet.

IDMObject HL_Objects(int argnIndex);

Parameter	Type	Passing
argnIndex	int	value

Returns: IDMObject

Extension method of IHighlightedDocumentHelper (using EDP;).

HL_Perform

No description yet.

void HL_Perform();

Returns: nothing (void)

HL_Register_Area

No description yet.

void HL_Register_Area(Rect argnArea);
void HL_Register_Area(IRect argnArea);

Parameter	Type	Passing
argnArea	Rect	value

Returns: nothing (void)

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

HL_Register_Bus

No description yet.

void HL_Register_Bus(IBus argBus);
void HL_Register_Bus(object argBus);

Parameter	Type	Passing
argBus	IBus	value

Returns: nothing (void)

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

HL_Register_Component

No description yet.

void HL_Register_Component(IComponent argComponent);
void HL_Register_Component(object argComponent);

Parameter	Type	Passing
argComponent	IComponent	value

Returns: nothing (void)

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

HL_Register_DMObject

No description yet.

void HL_Register_DMObject(IDMObject argnObject);
void HL_Register_DMObject(object argnObject);

Parameter	Type	Passing
argnObject	IDMObject	value

Returns: nothing (void)

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

HL_Register_Net

No description yet.

void HL_Register_Net(INet argNet);
void HL_Register_Net(object argNet);

Parameter	Type	Passing
argNet	INet	value

Returns: nothing (void)

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

HL_Register_NetItem

No description yet.

void HL_Register_NetItem(INetItem argNetItem);
void HL_Register_NetItem(object argNetItem);

Parameter	Type	Passing
argNetItem	INetItem	value

Returns: nothing (void)

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

HL_Register_Part

No description yet.

void HL_Register_Part(IPart argPart);
void HL_Register_Part(object argPart);

Parameter	Type	Passing
argPart	IPart	value

Returns: nothing (void)

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

HL_Register_VHDLEntity

No description yet.

void HL_Register_VHDLEntity(IVHDLEntity argVHDLEntity);
void HL_Register_VHDLEntity(object argVHDLEntity);

Parameter	Type	Passing
argVHDLEntity	IVHDLEntity	value

Returns: nothing (void)

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

HL_SetHighlightedNet

No description yet.

void HL_SetHighlightedNet(INet argNet);
void HL_SetHighlightedNet(object argNet);

Parameter	Type	Passing
argNet	INet	value

Returns: nothing (void)

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

HL_UnRegister_AllObjects

No description yet.

void HL_UnRegister_AllObjects();

Returns: nothing (void)

HL_UnRegister_Object

No description yet.

void HL_UnRegister_Object(IDMObject argnObject);
void HL_UnRegister_Object(object argnObject);

Parameter	Type	Passing
argnObject	IDMObject	value

Returns: nothing (void)

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

HL_XProbeChooseObject

No description yet.

bool HL_XProbeChooseObject(ref IDMObject argDMObject);
bool HL_XProbeChooseObject(ref object argDMObject);

Parameter	Type	Passing
argDMObject	IDMObject	ref

Returns: bool

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

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