Show / Hide Table of Contents

# Class PDFUAOptions

##### Inheritance

object
OptionsBase
PDFUAOptions

##### Implements

IDisposable

##### Inherited Members

OptionsBase.mObjSet
OptionsBase.mDict
OptionsBase.ColorPtToNumber(ColorPt)
OptionsBase.ColorPtFromNumber(double)
OptionsBase.GetArray(string)
OptionsBase.PutNumber(string, double)
OptionsBase.PutBool(string, bool)
OptionsBase.PutText(string, string)
OptionsBase.PutRect(string, Rect)
OptionsBase.PushBackNumber(string, double)
OptionsBase.PushBackBool(string, bool)
OptionsBase.PushBackText(string, string)
OptionsBase.PushBackRect(string, Rect)
OptionsBase.RectFromArray(Obj)
OptionsBase.insertRectCollection(string, RectCollection, int)
OptionsBase.GetInternalObj()
OptionsBase.Dispose()
OptionsBase.Dispose(bool)
OptionsBase.Destroy()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF.PDFUA

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class PDFUAOptions : OptionsBase, IDisposable

### Constructors

#### PDFUAOptions()

Constructor.

##### Declaration

    public PDFUAOptions()

### Methods

#### GetConformanceLevel()

Gets the value ConformanceLevel from the options object. The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Declaration

    public PDFUAConformance.Level GetConformanceLevel()

##### Returns

Type | Description
--- | ---
PDFUAConformance.Level | The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

#### GetDefaultLangCode()

Gets the value DefaultLangCode from the options object. The natural language code to set on the document if it is missing.

##### Declaration

    public string GetDefaultLangCode()

##### Returns

Type | Description
--- | ---
string | The current value for DefaultLangCode.

#### GetFigureAltTextPrefix()

Gets the value FigureAltTextPrefix from the options object. The prefix to use when setting Alt for Image and Graphic tags. By default, and when this is empty, the tag name will be used.

##### Declaration

    public string GetFigureAltTextPrefix()

##### Returns

Type | Description
--- | ---
string | The current value for FigureAltTextPrefix.

#### GetFirstStop()

Gets the value FirstStop from the options object. Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Declaration

    public bool GetFirstStop()

##### Returns

Type | Description
--- | ---
bool | Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

#### GetMaxRefObjs()

Gets the value MaxRefObjs from the options object. The maximum number of object references per error condition. This is 10 by default.

##### Declaration

    public int GetMaxRefObjs()

##### Returns

Type | Description
--- | ---
int | The maximum number of object references per error condition. This is 10 by default.

#### GetPassword()

Gets the value Password from the options object. The password to be used for encrypted PDF documents. By default, no password is used.

##### Declaration

    public string GetPassword()

##### Returns

Type | Description
--- | ---
string | The password to be used for encrypted PDF documents. By default, no password is used.

#### GetSaveLinearized()

Gets the value SaveLinearized from the options object. Whether to linearize when saving converted output. By default, the output is not linearized.

##### Declaration

    public bool GetSaveLinearized()

##### Returns

Type | Description
--- | ---
bool | Whether to linearize when saving converted output. By default, the output is not linearized.

#### SetConformanceLevel(Level)

Sets the value for ConformanceLevel in the options object. The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Declaration

    public PDFUAOptions SetConformanceLevel(PDFUAConformance.Level value)

##### Parameters

Type | Name | Description
--- | --- | ---
PDFUAConformance.Level | value | The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

#### SetDefaultLangCode(string)

Sets the value for DefaultLangCode in the options object. The natural language code to set on the document if it is missing.

##### Declaration

    public PDFUAOptions SetDefaultLangCode(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | The new value for DefaultLangCode.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

#### SetFigureAltTextPrefix(string)

Sets the value for FigureAltTextPrefix in the options object. The prefix to use when setting Alt for Image and Graphic tags. By default, and when this is empty, the tag name will be used.

##### Declaration

    public PDFUAOptions SetFigureAltTextPrefix(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | The new value for FigureAltTextPrefix.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

#### SetFirstStop(bool)

Sets the value for FirstStop in the options object. Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Declaration

    public PDFUAOptions SetFirstStop(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

#### SetMaxRefObjs(int)

Sets the value for MaxRefObjs in the options object. The maximum number of object references per error condition. This is 10 by default.

##### Declaration

    public PDFUAOptions SetMaxRefObjs(int value)

##### Parameters

Type | Name | Description
--- | --- | ---
int | value | The maximum number of object references per error condition. This is 10 by default.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

#### SetPassword(string)

Sets the value for Password in the options object. The password to be used for encrypted PDF documents. By default, no password is used.

##### Declaration

    public PDFUAOptions SetPassword(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | The password to be used for encrypted PDF documents. By default, no password is used.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

#### SetSaveLinearized(bool)

Sets the value for SaveLinearized in the options object. Whether to linearize when saving converted output. By default, the output is not linearized.

##### Declaration

    public PDFUAOptions SetSaveLinearized(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | Whether to linearize when saving converted output. By default, the output is not linearized.

##### Returns

Type | Description
--- | ---
PDFUAOptions | This object, for call chaining.

### Implements

IDisposable