
# IDocumentPreviewHint interface

*No description yet.*

```csharp
public interface IDocumentPreviewHint
```

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

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [ActivatedPath](#activatedpath) | `string` | get |  |
| [ActivatedPos](#activatedpos) | [Point](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Point.md) | get |  |

### ActivatedPath

*No description yet.*

```csharp
string Get_ActivatedPath();
```

**Type:** `string` · **Access:** read-only

### ActivatedPos

*No description yet.*

```csharp
Point Get_ActivatedPos();
```

**Type:** [Point](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Point.md) · **Access:** read-only

The accessors are extension methods of `IDocumentPreviewHintHelper` (`using DXP;`).

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [ActivateDocumentChooser](#activatedocumentchooser) | `void` |  |
| [ActivateDocumentPath](#activatedocumentpath) | `void` |  |
| [ActivateDocumentPreview](#activatedocumentpreview) | `void` |  |
| [DeActivate](#deactivate) | `void` |  |

### ActivateDocumentChooser

*No description yet.*

```csharp
void ActivateDocumentChooser(string argProjectPath, Point argPos);
void ActivateDocumentChooser(string argProjectPath, IPoint argPos);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProjectPath` | `string` | value |
| `argPos` | [Point](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Point.md) | value |

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

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

### ActivateDocumentPath

*No description yet.*

```csharp
void ActivateDocumentPath(string argDocumentPath, Point argPos);
void ActivateDocumentPath(string argDocumentPath, IPoint argPos);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocumentPath` | `string` | value |
| `argPos` | [Point](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Point.md) | value |

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

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

### ActivateDocumentPreview

*No description yet.*

```csharp
void ActivateDocumentPreview(string argDocumentPath, Point argPos, int argMouseGap);
void ActivateDocumentPreview(string argDocumentPath, IPoint argPos, int argMouseGap);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocumentPath` | `string` | value |
| `argPos` | [Point](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Point.md) | value |
| `argMouseGap` | `int` | value |

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

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

### DeActivate

*No description yet.*

```csharp
void DeActivate(bool argImmediate);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argImmediate` | `bool` | value |

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

## Returned by

[IClient.GetDocumentPreviewHint](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md#getdocumentpreviewhint)
