# 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.

```csharp
public interface IHighlightedDocument : IServerDocument
```

**Namespace:** EDP · **Assembly:** Altium.SDK.Interfaces

**Inherits:** [IServerDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md)

## Remarks

This interface and its methods are for internal use.

The `IHighlightedDocument` interface is inherited from the [`IServerDocument`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md) interface.

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [HL_Begin](#hl_begin) | `void` |  |
| [HL_ChooseObjectGraphically](#hl_chooseobjectgraphically) | `bool` |  |
| [HL_End](#hl_end) | `void` |  |
| [HL_GetHighlightedNet](#hl_gethighlightednet) | [INet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/INet.md) |  |
| [HL_GetLinkedObject](#hl_getlinkedobject) | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) |  |
| [HL_HighlightMethod_Add](#hl_highlightmethod_add) | `void` |  |
| [HL_HighlightMethod_Clear](#hl_highlightmethod_clear) | `void` |  |
| [HL_HighlightMethod_IsApplicable](#hl_highlightmethod_isapplicable) | `bool` |  |
| [HL_HighlightMethod_Remove](#hl_highlightmethod_remove) | `void` |  |
| [HL_ObjectCount](#hl_objectcount) | `int` |  |
| [HL_Objects](#hl_objects) | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) |  |
| [HL_Perform](#hl_perform) | `void` |  |
| [HL_Register_Area](#hl_register_area) | `void` |  |
| [HL_Register_Bus](#hl_register_bus) | `void` |  |
| [HL_Register_Component](#hl_register_component) | `void` |  |
| [HL_Register_DMObject](#hl_register_dmobject) | `void` |  |
| [HL_Register_Net](#hl_register_net) | `void` |  |
| [HL_Register_NetItem](#hl_register_netitem) | `void` |  |
| [HL_Register_Part](#hl_register_part) | `void` |  |
| [HL_Register_VHDLEntity](#hl_register_vhdlentity) | `void` |  |
| [HL_SetHighlightedNet](#hl_sethighlightednet) | `void` |  |
| [HL_UnRegister_AllObjects](#hl_unregister_allobjects) | `void` |  |
| [HL_UnRegister_Object](#hl_unregister_object) | `void` |  |
| [HL_XProbeChooseObject](#hl_xprobechooseobject) | `bool` |  |

### HL_Begin

*No description yet.*

```csharp
void HL_Begin();
```

**Returns:** nothing (`void`)

### HL_ChooseObjectGraphically

*No description yet.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDMObject` | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) | 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.*

```csharp
void HL_End();
```

**Returns:** nothing (`void`)

### HL_GetHighlightedNet

*No description yet.*

```csharp
INet HL_GetHighlightedNet();
```

**Returns:** [INet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/INet.md)

Extension method of `IHighlightedDocumentHelper` (`using EDP;`).

### HL_GetLinkedObject

*No description yet.*

```csharp
IDMObject HL_GetLinkedObject(IDMObject argDMObject);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDMObject` | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) | value |

**Returns:** [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md)

Extension method of `IHighlightedDocumentHelper` (`using EDP;`).

### HL_HighlightMethod_Add

*No description yet.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHighlightMethod` | [THighlightMethod](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/THighlightMethod.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHighlightMethod` | [THighlightMethod](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/THighlightMethod.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHighlightMethod` | [THighlightMethod](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/THighlightMethod.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHighlightMethod` | [THighlightMethod](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/THighlightMethod.md) | 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.*

```csharp
int HL_ObjectCount();
```

**Returns:** `int`

### HL_Objects

*No description yet.*

```csharp
IDMObject HL_Objects(int argnIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnIndex` | `int` | value |

**Returns:** [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md)

Extension method of `IHighlightedDocumentHelper` (`using EDP;`).

### HL_Perform

*No description yet.*

```csharp
void HL_Perform();
```

**Returns:** nothing (`void`)

### HL_Register_Area

*No description yet.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnArea` | [Rect](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Rect.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argBus` | [IBus](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IBus.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argComponent` | [IComponent](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IComponent.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnObject` | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argNet` | [INet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/INet.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argNetItem` | [INetItem](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/INetItem.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPart` | [IPart](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IPart.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVHDLEntity` | [IVHDLEntity](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IVHDLEntity.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argNet` | [INet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/INet.md) | 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.*

```csharp
void HL_UnRegister_AllObjects();
```

**Returns:** nothing (`void`)

### HL_UnRegister_Object

*No description yet.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argnObject` | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) | 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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDMObject` | [IDMObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IDMObject.md) | 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](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md): [AcquireDataFileHandle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#acquiredatafilehandle), [AcquireFileOwnership](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#acquirefileownership), [AddView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#addview), [BeingClosed](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#beingclosed), [CanCreateSnippet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#cancreatesnippet), [CanPlaceSnippet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#canplacesnippet), [CreateSnippetFile](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#createsnippetfile), [DocumentDirectoryChanged](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#documentdirectorychanged), [DoFileLoad](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#dofileload), [DoFileSave](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#dofilesave), [DoSafeChangeFileNameAndSave](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#dosafechangefilenameandsave), [DoSafeFileSave](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#dosafefilesave), [FileModifiedDate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#filemodifieddate), [FileName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#filename), [Focus](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#focus), [GetCanClose](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getcanclose), [GetContextHelpTopicName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getcontexthelptopicname), [GetCount](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getcount), [GetDocumentModifiedDate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getdocumentmodifieddate), [GetKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getkind), [GetServerModule](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getservermodule), [GetSnippetView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getsnippetview), [GetSupportsOwnSave](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getsupportsownsave), [GetView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getview), [GetViewByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#getviewbyname), [IsShown](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#isshown), [Modified](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#modified), [NotifyViews](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#notifyviews), [OwnsFile](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#ownsfile), [PlaceSnippet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#placesnippet), [ReleaseDataFileHandle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#releasedatafilehandle), [ReleaseFileOwnership](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#releasefileownership), [SupportsReload](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#supportsreload), [UpdateModifiedDate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#updatemodifieddate), [WarnIfOwnedByOther](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#warnifownedbyother), [ZoomSnippetContents](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md#zoomsnippetcontents)