
# IPCB_DocumentPainterView interface

*No description yet.*

```csharp
public interface IPCB_DocumentPainterView
```

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

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [ViewConfigFromString](#viewconfigfromstring) | `string` | set |  |

### ViewConfigFromString

*No description yet.*

```csharp
bool SetState_ViewConfigFromString(string argConfigType, string argConfig);
```

**Type:** `string` · **Access:** write-only · **Index:** `argConfigType` (`string`)

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddOrUpdatePrim](#addorupdateprim) | `void` |  |
| [ClearSelection](#clearselection) | `void` |  |
| [ClientRect](#clientrect) | [Rect](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/Rect.md) |  |
| [FocusedPrimitive](#focusedprimitive) | [IPCB_Primitive](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_Primitive.md) |  |
| [FocusPrimitive](#focusprimitive) | `void` |  |
| [GetState_ViewConfigAsString](#getstate_viewconfigasstring) | `bool` |  |
| [KeyDown](#keydown) | `void` |  |
| [RunLayerConfigurationDialog](#runlayerconfigurationdialog) | `bool` |  |
| [SelectPrimitive](#selectprimitive) | `void` |  |
| [SetBoard](#setboard) | `void` |  |
| [SetBounds](#setbounds) | `void` |  |
| [SetCameraAngle](#setcameraangle) | `void` |  |
| [SetDegreeOfFreedom](#setdegreeoffreedom) | `void` |  |
| [SetDocumentPainterListener](#setdocumentpainterlistener) | `void` |  |
| [SetInteractive](#setinteractive) | `void` |  |
| [SetVariant](#setvariant) | `void` |  |
| [ShowFloorShadow](#showfloorshadow) | `void` |  |
| [Zoom](#zoom) | `void` |  |

### AddOrUpdatePrim

*No description yet.*

```csharp
void AddOrUpdatePrim(IPCB_Primitive argPrim);
void AddOrUpdatePrim(object argPrim);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPrim` | [IPCB_Primitive](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_Primitive.md) | value |

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

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

### ClearSelection

*No description yet.*

```csharp
void ClearSelection();
```

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

### ClientRect

*No description yet.*

```csharp
Rect ClientRect();
```

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

Extension method of `IPCB_DocumentPainterViewHelper` (`using PCB;`).

### FocusedPrimitive

*No description yet.*

```csharp
IPCB_Primitive FocusedPrimitive();
```

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

Extension method of `IPCB_DocumentPainterViewHelper` (`using PCB;`).

### FocusPrimitive

*No description yet.*

```csharp
void FocusPrimitive(IPCB_Primitive argPrim);
void FocusPrimitive(object argPrim);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPrim` | [IPCB_Primitive](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_Primitive.md) | value |

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

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

### GetState_ViewConfigAsString

*No description yet.*

```csharp
bool GetState_ViewConfigAsString(out string argConfigType, out string argConfig);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argConfigType` | `string` | out |
| `argConfig` | `string` | out |

**Returns:** `bool`

### KeyDown

*No description yet.*

```csharp
void KeyDown(ref ushort argKey, TShiftStateSet argShift);
void KeyDown(ref ushort argKey, ITransportSet argShift);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argKey` | `ushort` | ref |
| `argShift` | [TShiftStateSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TShiftStateSet.md) | value |

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

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

### RunLayerConfigurationDialog

*No description yet.*

```csharp
bool RunLayerConfigurationDialog();
```

**Returns:** `bool`

### SelectPrimitive

*No description yet.*

```csharp
void SelectPrimitive(IPCB_Primitive argPrim);
void SelectPrimitive(object argPrim);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPrim` | [IPCB_Primitive](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_Primitive.md) | value |

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

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

### SetBoard

*No description yet.*

```csharp
void SetBoard(IPCB_Board argBoard);
void SetBoard(object argBoard);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argBoard` | [IPCB_Board](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_Board.md) | value |

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

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

### SetBounds

*No description yet.*

```csharp
void SetBounds(int argLeft, int argTop, int argWidth, int argHeight);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argLeft` | `int` | value |
| `argTop` | `int` | value |
| `argWidth` | `int` | value |
| `argHeight` | `int` | value |

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

### SetCameraAngle

*No description yet.*

```csharp
void SetCameraAngle(double argLookAtX, double argLookAtY, double argLookAtZ, double argRotationX, double argRotationY, double argRotationZ, double argRotationW, double argZoomMultiplier);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argLookAtX` | `double` | value |
| `argLookAtY` | `double` | value |
| `argLookAtZ` | `double` | value |
| `argRotationX` | `double` | value |
| `argRotationY` | `double` | value |
| `argRotationZ` | `double` | value |
| `argRotationW` | `double` | value |
| `argZoomMultiplier` | `double` | value |

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

### SetDegreeOfFreedom

*No description yet.*

```csharp
void SetDegreeOfFreedom(TDegreeOfFreedom argDegreeOfFreedom);
void SetDegreeOfFreedom(int argDegreeOfFreedom);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDegreeOfFreedom` | [TDegreeOfFreedom](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/TDegreeOfFreedom.md) | value |

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

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

### SetDocumentPainterListener

*No description yet.*

```csharp
void SetDocumentPainterListener(IPCB_DocumentPainterListener argCameraMoveListener);
void SetDocumentPainterListener(object argCameraMoveListener);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCameraMoveListener` | [IPCB_DocumentPainterListener](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_DocumentPainterListener.md) | value |

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

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

### SetInteractive

*No description yet.*

```csharp
void SetInteractive(bool argValue);
```

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

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

### SetVariant

*No description yet.*

```csharp
void SetVariant(IProjectVariant argVariant);
void SetVariant(object argVariant);
```

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

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

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

### ShowFloorShadow

*No description yet.*

```csharp
void ShowFloorShadow(bool argEnabled);
```

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

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

### Zoom

*No description yet.*

```csharp
void Zoom(int argDelta);
```

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

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

## Returned by

[IPCB_ServerInterface.CreateDocumentPainter](https://altiumdeveloper.github.io/ad-sdk-docs/reference/pcb/IPCB_ServerInterface.md#createdocumentpainter)
