Class TaggingOptions

Inheritance
System.Object
OptionsBase
TaggingOptions
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: pdftron.PDF
Assembly: PDFNetiOS.dll
Syntax
public class TaggingOptions : OptionsBase, IDisposable

Constructors

TaggingOptions()

Constructor.

Declaration
public TaggingOptions()

Methods

GetDescription()

Gets the value Description from the options object. Alternate description required by some standards. Default is empty, which will automatically attempt to fill it using contextual information (such as TU for Widgets), but explicitly setting this is recommended for better semantics.

Declaration
public string GetDescription()
Returns
Type Description
System.String

Alternate description required by some standards. Default is empty, which will automatically attempt to fill it using contextual information (such as TU for Widgets), but explicitly setting this is recommended for better semantics.

GetInsertIndex()

Gets the value InsertIndex from the options object. The index, in the parent SElement's kids array, at which to insert the new tag. The new element will be inserted before the element at the insert index, where the first element is at index 0. If insert index

= number of elements, it will be inserted at the end. Default inserts at the end.

Declaration
public int GetInsertIndex()
Returns
Type Description
System.Int32

The index, in the parent SElement's kids array, at which to insert the new tag. The new element will be inserted before the element at the insert index, where the first element is at index 0. If insert index >= number of elements, it will be inserted at the end. Default inserts at the end.

SetDescription(String)

Sets the value for Description in the options object. Alternate description required by some standards. Default is empty, which will automatically attempt to fill it using contextual information (such as TU for Widgets), but explicitly setting this is recommended for better semantics.

Declaration
public TaggingOptions SetDescription(string value)
Parameters
Type Name Description
System.String value

Alternate description required by some standards. Default is empty, which will automatically attempt to fill it using contextual information (such as TU for Widgets), but explicitly setting this is recommended for better semantics.
Returns
Type Description
TaggingOptions

This object, for call chaining.

SetInsertIndex(Int32)

Sets the value for InsertIndex in the options object. The index, in the parent SElement's kids array, at which to insert the new tag. The new element will be inserted before the element at the insert index, where the first element is at index 0. If insert index

= number of elements, it will be inserted at the end. Default inserts at the end.

Declaration
public TaggingOptions SetInsertIndex(int value)
Parameters
Type Name Description
System.Int32 value

The index, in the parent SElement's kids array, at which to insert the new tag. The new element will be inserted before the element at the insert index, where the first element is at index 0. If insert index >= number of elements, it will be inserted at the end. Default inserts at the end.
Returns
Type Description
TaggingOptions

This object, for call chaining.

Implements

System.IDisposable