# OutputIntent

## Content

# Class: OutputIntent

Represents an output intent for a PDF document.
Output intents provide information about the intended output device or production condition.

## Extends

- [`ObjectBase`](ObjectBase)

## Constructors

### Constructor

```ts
new OutputIntent(om): OutputIntent;
```

Creates a new OutputIntent object.

#### Parameters

##### om

[`ObjectManager`](ObjectManager)

An object manager that controls the lifetime of the OutputIntent object.

#### Returns

`OutputIntent`

#### Overrides

```ts
ObjectBase.constructor
```

### Constructor

```ts
new OutputIntent(): OutputIntent;
```

Creates a new OutputIntent object.

#### Returns

`OutputIntent`

#### Overrides

```ts
ObjectBase.constructor
```

## Properties

### GTS\_PDFA1

```ts
readonly static GTS_PDFA1: "GTS_PDFA1" = "GTS_PDFA1";
```

The string representing the GTS_PDFA1 output intent subtype.

***

### GTS\_PDFX

```ts
readonly static GTS_PDFX: "GTS_PDFX" = "GTS_PDFX";
```

The string representing the GTS_PDFX output intent subtype.

***

### ISO\_PDFE1

```ts
readonly static ISO_PDFE1: "ISO_PDFE1" = "ISO_PDFE1";
```

The string representing the ISO_PDFE1 output intent subtype.

## Accessors

### destOutputProfile

#### Get Signature

```ts
get destOutputProfile(): IccProfile;
```

Gets or sets an ICC profile color space defining the transformation from the PDF document's source colors
to output device colorants.

##### Returns

[`IccProfile`](IccProfile)

#### Set Signature

```ts
set destOutputProfile(value): void;
```

Gets or sets an ICC profile color space defining the transformation from the PDF document's source colors
to output device colorants.

##### Parameters

###### value

[`IccProfile`](IccProfile)

##### Returns

`void`

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`ObjectBase`](ObjectBase).[`id`](ObjectBase#id)

***

### info

#### Get Signature

```ts
get info(): string;
```

Gets or sets the human-readable text string containing additional information or comments about the intended output device or production condition.

##### Returns

`string`

#### Set Signature

```ts
set info(value): void;
```

Gets or sets the info string.

##### Parameters

###### value

`string`

##### Returns

`void`

***

### om

#### Get Signature

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`ObjectBase`](ObjectBase).[`om`](ObjectBase#om)

***

### outputCondition

#### Get Signature

```ts
get outputCondition(): string;
```

Gets or sets the output condition.
A text string concisely identifying the intended output device or production condition in human-readable form.

##### Returns

`string`

#### Set Signature

```ts
set outputCondition(value): void;
```

Gets or sets the output condition.

##### Parameters

###### value

`string`

##### Returns

`void`

***

### outputConditionIdentifier

#### Get Signature

```ts
get outputConditionIdentifier(): string;
```

Gets or sets the output condition identifier.
This is a string identifying the intended output device or production condition in human or machine readable form.

##### Returns

`string`

#### Set Signature

```ts
set outputConditionIdentifier(value): void;
```

Gets or sets the output condition identifier.

##### Parameters

###### value

`string`

##### Returns

`void`

***

### registryName

#### Get Signature

```ts
get registryName(): string;
```

Gets or sets the registry name identifying the registry in which the condition designated by OutputConditionIdentifier is defined.

##### Returns

`string`

#### Set Signature

```ts
set registryName(value): void;
```

Gets or sets the registry name.

##### Parameters

###### value

`string`

##### Returns

`void`

***

### subtype

#### Get Signature

```ts
get subtype(): string;
```

Gets or sets the output intent subtype.
Common values include "GTS_PDFX" for PDF/X and "GTS_PDFA1" for PDF/A.

##### Returns

`string`

#### Set Signature

```ts
set subtype(value): void;
```

Gets or sets the output intent subtype.

##### Parameters

###### value

`string`

##### Returns

`void`

## Methods

### createDefaultForPdfA()

```ts
static createDefaultForPdfA(om?): OutputIntent;
```

Creates a default OutputIntent for PDF/A compliance with sRGB color space.

#### Parameters

##### om?

[`ObjectManager`](ObjectManager)

An object manager that controls the lifetime of the OutputIntent object.

#### Returns

`OutputIntent`

A new OutputIntent configured for PDF/A compliance.

***

### free()

```ts
free(): void;
```

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`free`](ObjectBase#free)

***

### rebind()

```ts
rebind(omTo): void;
```

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`rebind`](ObjectBase#rebind)
