Skip to main content
View as Markdown

ISch_HitTest interface

This ISch_HitTest interface returns you the number of objects and object type at a particular point on the schematic document.

public interface ISch_HitTest

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Remarks​

To specify the location where the objects can be checked on the schematic document, pass in the location (of TLocation type) and invoke the ISch_Document.CreateHitTest method. This location parameter can be set either programmatically or by the ISch_Document.ChooseLocationInteractively method.

Properties​

PropertyTypeAccessDescription
HitObjectISch_GraphicalObjectgetThis property returns you the indexed object at the particular point on the schematic document.
HitTestCountintgetThis property returns you the number of objects at the particular point on the schematic document.

HitObject​

This property returns you the indexed object at the particular point on the schematic document.

ISch_GraphicalObject GetState_HitObject(int argI);

Type: ISch_GraphicalObject · Access: read-only · Index: argI (int)

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

See also: ISch_HitTest.HitTestCount

HitTestCount​

This property returns you the number of objects at the particular point on the schematic document.

int GetState_HitTestCount();

Type: int · Access: read-only

Returned by​

ISch_Document.CreateHitTest, ISch_Document.PopupMenuHitTest