# GroupDocs API References — Complete API Reference

> Class library reference for GroupDocs document-processing SDKs across .NET, Java, Node.js, and Python.

This file concatenates the entire API reference for every product, with navigation boilerplate removed. One top-level section per product, grouped by platform.


# GroupDocs.Annotation

> Add, edit, and remove annotations — comments, highlights, shapes, and stamps.

## Java

### GroupDocs.Annotation for Java
Path: https://reference.groupdocs.com/annotation/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.annotation | The namespace provides classes to annotate documents for all popular document formats. |
| com.groupdocs.annotation.cache | The namespace provides classes for customizing caching behaviour. |
| com.groupdocs.annotation.exceptions | The namespace provides different exceptions classes. |
| com.groupdocs.annotation.licenses |  |
| com.groupdocs.annotation.localization | The namespace provides classes checking supported locales. |
| com.groupdocs.annotation.logging | The namespace provides classes for working with integrated or your own logger. |
| com.groupdocs.annotation.models | The namespace provides annotation data classes. |
| com.groupdocs.annotation.models.annotationmodels | The namespace provides annotation models data classes. |
| com.groupdocs.annotation.models.annotationmodels.interfaces.annotations | The namespace provides annotation models interfaces. |
| com.groupdocs.annotation.models.annotationmodels.interfaces.properties | The namespace provides annotation properties interfaces. |
| com.groupdocs.annotation.models.formatspecificcomponents.pdf | The namespace provides format specific component models |
| com.groupdocs.annotation.options | The namespace provides classes to specify additional options when loading, annotating and saving documents. |
| com.groupdocs.annotation.options.export | The namespace provides classes to specify additional options when saving documents. |
| com.groupdocs.annotation.options.pagepreview | The namespace provides classes to preview document pages. |

### com.groupdocs.annotation.cache
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.cache.md

The namespace provides classes for customizing caching behaviour.

#### Classes

| Class | Description |
| --- | --- |
| FileCache | Represents a local on-disk cache. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICache | Defines methods required for storing rendered document and document resources cache. |

### FileCache
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.cache/filecache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.annotation.cache.ICache
```
public class FileCache implements ICache
```

Represents a local on-disk cache.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileCache() | Initializes new instance of FileCache class. |
| FileCache(String path) | Initializes new instance of FileCache class. |
#### Methods

| Method | Description |
| --- | --- |
| getKeys(String filter) | Returns all file names that contains filter in filename. |
| set(String key, Object value) | Serializes data to the local disk. |
##### FileCache()
```
public FileCache()
```

Initializes new instance of FileCache class.

##### FileCache(String path)
```
public FileCache(String path)
```

Initializes new instance of FileCache class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | Path where cache data will be saved |

##### getKeys(String filter)
```
public final System.Collections.Generic.IGenericEnumerable<String> getKeys(String filter)
```

Returns all file names that contains filter in filename.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | The filter to use. |

**Returns:**
com.aspose.ms.System.Collections.Generic.IGenericEnumerable<java.lang.String> - File names that contains filter in filename.
##### set(String key, Object value)
```
public final void set(String key, Object value)
```

Serializes data to the local disk.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | An unique identifier for the cache entry. |
| value | java.lang.Object | The object to serialize. |

### ICache
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.cache/icache.md

### com.groupdocs.annotation.exceptions
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.exceptions.md

The namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| AnnotatorException | Represents errors that occur during document processing. |
| ConvertFileException | The exception that is thrown when file conversion failed. |
| CorruptedOrDamagedFileException | The exception that is thrown when file is corrupted or damaged. |
| FileTypeNotSupportedException | The exception that is thrown when file type is not supported. |
| IOException | The exception that is thrown when file processing is failed. |

### AnnotatorException
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.exceptions/annotatorexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.foundation.exception.GroupDocsException
```
public class AnnotatorException extends GroupDocsException
```

Represents errors that occur during document processing.
#### Constructors

| Constructor | Description |
| --- | --- |
| AnnotatorException(Throwable throwable) | Initializes a new instance of the AnnotatorException class. |
| AnnotatorException(String message) | Initializes a new instance of the AnnotatorException class. |
| AnnotatorException(String message, Exception innerException) | Initializes a new instance of the AnnotatorException class. |
##### AnnotatorException(Throwable throwable)
```
public AnnotatorException(Throwable throwable)
```

Initializes a new instance of the AnnotatorException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | the error object. |

##### AnnotatorException(String message)
```
public AnnotatorException(String message)
```

Initializes a new instance of the AnnotatorException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### AnnotatorException(String message, Exception innerException)
```
public AnnotatorException(String message, Exception innerException)
```

Initializes a new instance of the AnnotatorException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message that explains the reason for the exception. |
| innerException | java.lang.Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### ConvertFileException
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.exceptions/convertfileexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.annotation.exceptions.AnnotatorException
```
public class ConvertFileException extends AnnotatorException
```

The exception that is thrown when file conversion failed.
#### Constructors

| Constructor | Description |
| --- | --- |
| ConvertFileException(String message) | Initializes a new instance of the ConvertFileException class. |
| ConvertFileException(String message, RuntimeException innerException) | Initializes a new instance of the ConvertFileException class. |
##### ConvertFileException(String message)
```
public ConvertFileException(String message)
```

Initializes a new instance of the ConvertFileException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### ConvertFileException(String message, RuntimeException innerException)
```
public ConvertFileException(String message, RuntimeException innerException)
```

Initializes a new instance of the ConvertFileException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message that explains the reason for the exception. |
| innerException | java.lang.RuntimeException | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### CorruptedOrDamagedFileException
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.exceptions/corruptedordamagedfileexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.annotation.exceptions.AnnotatorException
```
public class CorruptedOrDamagedFileException extends AnnotatorException
```

The exception that is thrown when file is corrupted or damaged.
#### Constructors

| Constructor | Description |
| --- | --- |
| CorruptedOrDamagedFileException(String message) | Initializes a new instance of the CorruptedOrDamagedFileException class. |
| CorruptedOrDamagedFileException(String message, Exception innerException) | Initializes a new instance of the CorruptedOrDamagedFileException class. |
##### CorruptedOrDamagedFileException(String message)
```
public CorruptedOrDamagedFileException(String message)
```

Initializes a new instance of the CorruptedOrDamagedFileException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### CorruptedOrDamagedFileException(String message, Exception innerException)
```
public CorruptedOrDamagedFileException(String message, Exception innerException)
```

Initializes a new instance of the CorruptedOrDamagedFileException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message that explains the reason for the exception. |
| innerException | java.lang.Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.exceptions/filetypenotsupportedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.annotation.exceptions.AnnotatorException
```
public class FileTypeNotSupportedException extends AnnotatorException
```

The exception that is thrown when file type is not supported.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileTypeNotSupportedException(String message) | Initializes a new instance of the FileTypeNotSupportedException class. |
| FileTypeNotSupportedException(String message, RuntimeException innerException) | Initializes a new instance of the FileTypeNotSupportedException class. |
##### FileTypeNotSupportedException(String message)
```
public FileTypeNotSupportedException(String message)
```

Initializes a new instance of the FileTypeNotSupportedException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### FileTypeNotSupportedException(String message, RuntimeException innerException)
```
public FileTypeNotSupportedException(String message, RuntimeException innerException)
```

Initializes a new instance of the FileTypeNotSupportedException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message that explains the reason for the exception. |
| innerException | java.lang.RuntimeException | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### IOException
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.exceptions/ioexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.annotation.exceptions.AnnotatorException
```
public class IOException extends AnnotatorException
```

The exception that is thrown when file processing is failed.
#### Constructors

| Constructor | Description |
| --- | --- |
| IOException(String message) | Initializes a new instance of the IOException class. |
| IOException(String message, RuntimeException innerException) | Initializes a new instance of the IOException class. |
##### IOException(String message)
```
public IOException(String message)
```

Initializes a new instance of the IOException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### IOException(String message, RuntimeException innerException)
```
public IOException(String message, RuntimeException innerException)
```

Initializes a new instance of the IOException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message that explains the reason for the exception. |
| innerException | java.lang.RuntimeException | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### com.groupdocs.annotation.licenses
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.licenses.md

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |
| Metered | Provides methods for applying  Metered  license. |

### License
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.licenses/license.md

**Inheritance:**
java.lang.Object
```
public class License
```

Provides methods to license the component. Learn more about licensing  here .

#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| isValidMeteredLicense() |  |
| isValidLicense() | Gets a value indicating whether this instance is valid license. |
| setLicense(InputStream licenseStream) | Licenses the component. |
| setLicenseInternal(System.IO.Stream licenseStream) |  |
| setMeteredLicense() |  |
| setLicense(Path licensePath) | Licenses the component. |
| setLicense(String licensePath) | Licenses the component. |
| resetLicense() |  |
##### License()
```
public License()
```

##### isValidMeteredLicense()
```
public static boolean isValidMeteredLicense()
```

**Returns:**
boolean
##### isValidLicense()
```
public static boolean isValidLicense()
```

Gets a value indicating whether this instance is valid license.

Value:  true  if this instance is valid license; otherwise,  false .

**Returns:**
boolean
##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream. |

##### setLicenseInternal(System.IO.Stream licenseStream)
```
public void setLicenseInternal(System.IO.Stream licenseStream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | com.aspose.ms.System.IO.Stream |  |

##### setMeteredLicense()
```
public final void setMeteredLicense()
```

##### setLicense(Path licensePath)
```
public final void setLicense(Path licensePath)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.nio.file.Path | The license path. |

##### setLicense(String licensePath)
```
public final void setLicense(String licensePath)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path. |

##### resetLicense()
```
public static void resetLicense()
```

### Metered
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.licenses/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying  Metered  license.

#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() | Initializes a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| setMeteredKey(String publicKey, String privateKey) | Activates product with Metered keys. |
| getConsumptionQuantity() | Retrieves amount of MBs processed. |
| getConsumptionCredit() | Retrieves count of credits consumed. |
| increaseBytesCount(double length) |  |
| increaseCreditsByBytesCount(double length) |  |
| increaseCreditsByOne() |  |
##### Metered()
```
public Metered()
```

Initializes a new instance of this class.

##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Activates product with Metered keys.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | public key |
| privateKey | java.lang.String | private key |

##### getConsumptionQuantity()
```
public static double getConsumptionQuantity()
```

Retrieves amount of MBs processed.

**Returns:**
double - consumption quantity
##### getConsumptionCredit()
```
public static double getConsumptionCredit()
```

Retrieves count of credits consumed.

**Returns:**
double - consumption credit
##### increaseBytesCount(double length)
```
public static void increaseBytesCount(double length)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| length | double |  |

##### increaseCreditsByBytesCount(double length)
```
public static void increaseCreditsByBytesCount(double length)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| length | double |  |

##### increaseCreditsByOne()
```
public static void increaseCreditsByOne()
```

### com.groupdocs.annotation.localization
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.localization.md

The namespace provides classes checking supported locales.

#### Classes

| Class | Description |
| --- | --- |
| SupportedLocales | Class that provides methods for checking GroupDocs.Annotation supported locales. |

### SupportedLocales
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.localization/supportedlocales.md

**Inheritance:**
java.lang.Object
```
public class SupportedLocales
```

Class that provides methods for checking GroupDocs.Annotation supported locales.
#### Methods

| Method | Description |
| --- | --- |
| isLocaleSupported(String culture) | Determines whether [is locale supported] [the specified culture]. |
| isLocaleSupported(System.Globalization.CultureInfo culture) | Determines whether [is locale supported] [the specified culture]. |
##### isLocaleSupported(String culture)
```
public static boolean isLocaleSupported(String culture)
```

Determines whether [is locale supported] [the specified culture].

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| culture | java.lang.String | The culture. |

**Returns:**
boolean -
##### isLocaleSupported(System.Globalization.CultureInfo culture)
```
public static boolean isLocaleSupported(System.Globalization.CultureInfo culture)
```

Determines whether [is locale supported] [the specified culture].

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| culture | com.aspose.ms.System.Globalization.CultureInfo | The culture. |

**Returns:**
boolean -

### com.groupdocs.annotation.logging
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.logging.md

The namespace provides classes for working with integrated or your own logger.

### com.groupdocs.annotation.models.annotationmodels.interfaces.annotations
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.md

The namespace provides annotation models interfaces.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAreaAnnotation | Defines Area annotation properties |
| IArrowAnnotation | Defines Arrow annotation properties |
| IDistanceAnnotation | Defines Distance annotation properties |
| IEllipseAnnotation | Defines Ellipse annotation properties |
| IHighlightAnnotation | Defines Highlight annotation properties |
| IImageAnnotation |  |
| ILinkAnnotation | Defines Link annotation properties |
| IPointAnnotation | Defines Point annotation properties |
| IPolylineAnnotation | Defines Polyline annotation properties |
| IReplacementAnnotation | Defines Replacement annotation properties |
| IResourcesRedactionAnnotation | Defines Resourse redaction annotation properties |
| ISearchTextFragment | Defines Search Text Fragment annotation properties |
| ISquigglyAnnotation | Defines Squiggly annotation properties |
| IStrikeoutAnnotation | Defines Strikeout annotation properties |
| ITextFieldAnnotation | Defines Text field annotation properties |
| ITextRedactionAnnotation | Defines Text redaction annotation properties |
| IUnderlineAnnotation | Defines Underline annotation properties |
| IWatermarkAnnotation | Defines Watermark annotation properties |

### IAreaAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iareaannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenStyle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenWidth
```
public interface IAreaAnnotation extends IBackgroundColor, IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

Defines Area annotation properties

### IArrowAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iarrowannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenStyle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenWidth
```
public interface IArrowAnnotation extends IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

Defines Arrow annotation properties

### IDistanceAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/idistanceannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenStyle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenWidth
```
public interface IDistanceAnnotation extends IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

Defines Distance annotation properties

### IEllipseAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iellipseannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenStyle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenWidth
```
public interface IEllipseAnnotation extends IBackgroundColor, IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

Defines Ellipse annotation properties

### IHighlightAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/ihighlightannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints
```
public interface IHighlightAnnotation extends IBackgroundColor, IFontColor, IOpacity, IPoints
```

Defines Highlight annotation properties

### IImageAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iimageannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IAngle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity
```
public interface IImageAnnotation extends IAngle, IBox, IOpacity
```

### ILinkAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/ilinkannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IUrl
```
public interface ILinkAnnotation extends IFontColor, IBackgroundColor, IOpacity, IPoints, IUrl
```

Defines Link annotation properties

### IPointAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/ipointannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox
```
public interface IPointAnnotation extends IBox
```

Defines Point annotation properties

### IPolylineAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/ipolylineannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenStyle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenWidth, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.ISvgPath
```
public interface IPolylineAnnotation extends IBox, IOpacity, IPenColor, IPenStyle, IPenWidth, ISvgPath
```

Defines Polyline annotation properties

### IReplacementAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/ireplacementannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontSize, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.ITextToReplace
```
public interface IReplacementAnnotation extends IFontColor, IFontSize, IBackgroundColor, IOpacity, IPoints, ITextToReplace
```

Defines Replacement annotation properties

### IResourcesRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iresourcesredactionannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox
```
public interface IResourcesRedactionAnnotation extends IBox
```

Defines Resourse redaction annotation properties

### ISearchTextFragment
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/isearchtextfragment.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontSize, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontFamily, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IText
```
public interface ISearchTextFragment extends IFontColor, IFontSize, IFontFamily, IBackgroundColor, IText
```

Defines Search Text Fragment annotation properties

### ISquigglyAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/isquigglyannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints
```
public interface ISquigglyAnnotation extends IFontColor, IOpacity, IPoints
```

Defines Squiggly annotation properties

### IStrikeoutAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/istrikeoutannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints
```
public interface IStrikeoutAnnotation extends IFontColor, IBackgroundColor, IOpacity, IPoints
```

Defines Strikeout annotation properties

### ITextFieldAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/itextfieldannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IText, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.ITextHAlignment, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontFamily, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontSize, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenStyle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPenWidth
```
public interface ITextFieldAnnotation extends IBackgroundColor, IBox, IText, ITextHAlignment, IFontColor, IFontFamily, IFontSize, IOpacity, IPenColor, IPenStyle, IPenWidth
```

Defines Text field annotation properties

### ITextRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/itextredactionannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints
```
public interface ITextRedactionAnnotation extends IFontColor, IPoints
```

Defines Text redaction annotation properties

### IUnderlineAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iunderlineannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IPoints, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBackgroundColor
```
public interface IUnderlineAnnotation extends IFontColor, IOpacity, IPoints, IBackgroundColor
```

Defines Underline annotation properties

### IWatermarkAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.annotations/iwatermarkannotation.md

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IBox, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IText, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontColor, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontFamily, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IFontSize, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IOpacity, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IAngle, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IHorizontalAlignment, com.groupdocs.annotation.models.annotationmodels.interfaces.properties.IVerticalAlignment
```
public interface IWatermarkAnnotation extends IBox, IText, IFontColor, IFontFamily, IFontSize, IOpacity, IAngle, IHorizontalAlignment, IVerticalAlignment
```

Defines Watermark annotation properties

### com.groupdocs.annotation.models.annotationmodels.interfaces.properties
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties.md

The namespace provides annotation properties interfaces.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAngle | Defines annotation rotation angle |
| IBackgroundColor | Defines annotation background color |
| IBox | Defines annotation position |
| IFontColor | Defines annotation text font color |
| IFontFamily | Defines annotation text font family |
| IFontSize | Defines annotation text font size |
| IOpacity | Defines annotation opacity |
| IPenColor | Defines annotation pen color |
| IPenStyle | Defines annotation pen style |
| IPenWidth | Defines annotation pen width |
| IPoints | Defines annotation position |
| ISvgPath | Defines annotation svg path coordinates array |
| IText | Defines annotation text |
| ITextToReplace | Defines annotation text for replace |
| IUrl | Defines annotation link url |

### IAngle
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/iangle.md

### IBackgroundColor
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ibackgroundcolor.md

### IBox
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ibox.md

### IFontColor
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontcolor.md

### IFontFamily
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontfamily.md

### IFontSize
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontsize.md

### IOpacity
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/iopacity.md

### IPenColor
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ipencolor.md

### IPenStyle
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ipenstyle.md

### IPenWidth
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ipenwidth.md

### IPoints
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/ipoints.md

### ISvgPath
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/isvgpath.md

### IText
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/itext.md

### ITextToReplace
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/itexttoreplace.md

### IUrl
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.interfaces.properties/iurl.md

### com.groupdocs.annotation.models.annotationmodels
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels.md

The namespace provides annotation models data classes.

#### Classes

| Class | Description |
| --- | --- |
| AnnotationBase | Base class for all annotation types |
| AreaAnnotation | Represents area annotation properties |
| ArrowAnnotation | Represents Arrow annotation properties |
| DistanceAnnotation | Represents Distance annotation properties |
| EllipseAnnotation | Represents Ellipse annotation properties |
| HighlightAnnotation | Represents Highlight annotation properties |
| ImageAnnotation | Represents image annotation properties |
| LinkAnnotation | Represents Link annotation properties |
| PointAnnotation | Represents Point annotation properties |
| PolylineAnnotation | Represents Polyline annotation properties |
| ReplacementAnnotation | Represents Replacement annotation properties |
| ResourcesRedactionAnnotation | Represents Resources redaction annotation properties |
| SearchTextFragment | Represents Search Text annotation properties |
| SquigglyAnnotation | Represents squiggly annotation properties |
| StrikeoutAnnotation | Represents Strikeout annotation properties |
| TextFieldAnnotation | Represents Text field annotation properties |
| TextRedactionAnnotation | Represents Text redaction annotation properties |
| UnderlineAnnotation | Represents Underline annotation properties |
| WatermarkAnnotation | Represents Watermark annotation properties |

### AnnotationBase
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/annotationbase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.ICloneable, java.lang.Cloneable, com.aspose.ms.System.IEquatable
```
public abstract class AnnotationBase implements System.ICloneable, Cloneable, System.IEquatable<AnnotationBase>
```

Base class for all annotation types
#### Constructors

| Constructor | Description |
| --- | --- |
| AnnotationBase() |  |
#### Methods

| Method | Description |
| --- | --- |
| getCounter() |  |
| setCounter(int counter) |  |
| getId() | Gets or sets annotation unique identifier |
| setId(int value) | Gets or sets annotation unique identifier |
| getCreatedOn() | Gets or sets annotation creation date |
| setCreatedOn(Date value) | Gets or sets annotation creation date |
| getMessage() | Gets or sets annotation message |
| setMessage(String value) | Gets or sets annotation message |
| getPageNumber() | Gets or sets page number to be annotated |
| setPageNumber(Integer value) | Gets or sets page number to be annotated |
| getReplies() | Represents annotation replies collection |
| setReplies(List<Reply> value) | Represents annotation replies collection |
| getStateBeforeAnnotation() | Text state before annotation |
| setStateBeforeAnnotation(Object value) | Text state before annotation |
| getType() | Gets or sets annotation type |
| setType(int value) | Gets or sets annotation type |
| getUser() | Gets or sets annotation creator |
| setUser(User value) | Gets or sets annotation creator |
| equals(AnnotationBase other) | Compares Base Annotations using IEquatable Equals method |
| equals(Object obj) | Compares Base Annotations using standard object Equals method |
| hashCode() | Returns HashCode of AnnotationBase Message, PageNumber and Type Properties |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### AnnotationBase()
```
public AnnotationBase()
```

##### getCounter()
```
public static int getCounter()
```

**Returns:**
int
##### setCounter(int counter)
```
public static void setCounter(int counter)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| counter | int |  |

##### getId()
```
public final int getId()
```

Gets or sets annotation unique identifier

**Returns:**
int -
##### setId(int value)
```
public final void setId(int value)
```

Gets or sets annotation unique identifier

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCreatedOn()
```
public final Date getCreatedOn()
```

Gets or sets annotation creation date

**Returns:**
java.util.Date -
##### setCreatedOn(Date value)
```
public final void setCreatedOn(Date value)
```

Gets or sets annotation creation date

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getMessage()
```
public final String getMessage()
```

Gets or sets annotation message

**Returns:**
java.lang.String -
##### setMessage(String value)
```
public final void setMessage(String value)
```

Gets or sets annotation message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPageNumber()
```
public final Integer getPageNumber()
```

Gets or sets page number to be annotated

**Returns:**
java.lang.Integer -
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Gets or sets page number to be annotated

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getReplies()
```
public final List<Reply> getReplies()
```

Represents annotation replies collection

**Returns:**
java.util.List<com.groupdocs.annotation.models.Reply> -
##### setReplies(List<Reply> value)
```
public final void setReplies(List<Reply> value)
```

Represents annotation replies collection

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.Reply> |  |

##### getStateBeforeAnnotation()
```
public final Object getStateBeforeAnnotation()
```

Text state before annotation

**Returns:**
java.lang.Object -
##### setStateBeforeAnnotation(Object value)
```
public final void setStateBeforeAnnotation(Object value)
```

Text state before annotation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### getType()
```
public final int getType()
```

Gets or sets annotation type

**Returns:**
int -
##### setType(int value)
```
public final void setType(int value)
```

Gets or sets annotation type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getUser()
```
public final User getUser()
```

Gets or sets annotation creator

**Returns:**
User -
##### setUser(User value)
```
public final void setUser(User value)
```

Gets or sets annotation creator

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | User |  |

##### equals(AnnotationBase other)
```
public final boolean equals(AnnotationBase other)
```

Compares Base Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | AnnotationBase | The AnnotationBase object to compare with the current object |

**Returns:**
boolean -
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Compares Base Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of AnnotationBase Message, PageNumber and Type Properties

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### AreaAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/areaannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase, com.groupdocs.annotation.models.annotationmodels.AnnotationBaseProps

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IAreaAnnotation
```
public class AreaAnnotation extends AnnotationBaseProps implements IAreaAnnotation
```

Represents area annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| AreaAnnotation() | Initializes new instance of AreaAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getPenStyle() | Gets or sets annotation pen style |
| setPenStyle(Byte value) | Gets or sets annotation pen style |
| equals(AreaAnnotation other) | Compares Area Annotations using IEquatable Equals method |
| deepClone() | Returns new Instance with same values |
| equals(Object o) |  |
| hashCode() |  |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### AreaAnnotation()
```
public AreaAnnotation()
```

Initializes new instance of AreaAnnotation class.

##### getPenStyle()
```
public final Byte getPenStyle()
```

Gets or sets annotation pen style

**Returns:**
java.lang.Byte -
##### setPenStyle(Byte value)
```
public final void setPenStyle(Byte value)
```

Gets or sets annotation pen style

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(AreaAnnotation other)
```
public final boolean equals(AreaAnnotation other)
```

Compares Area Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | AreaAnnotation | The AreaAnnotation object to compare with the current object |

**Returns:**
boolean -
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Base Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of AnnotationBase Message, PageNumber and Type Properties

**Returns:**
int
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### ArrowAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/arrowannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IArrowAnnotation
```
public class ArrowAnnotation extends AnnotationBase implements IArrowAnnotation
```

Represents Arrow annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| ArrowAnnotation() | Initializes new instance of ArrowAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets annotation position |
| setBox(Rectangle value) | Gets or sets annotation position |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getPenColor() | Gets or sets annotation pen color |
| setPenColor(Integer value) | Gets or sets annotation pen color |
| getPenStyle() | Gets or sets annotation pen style |
| setPenStyle(Byte value) | Gets or sets annotation pen style |
| getPenWidth() | Gets or sets annotation pen width |
| setPenWidth(Byte value) | Gets or sets annotation pen width |
| equals(ArrowAnnotation other) | Compares Area Annotations using IEquatable Equals method |
| equals(Object o) | Compares Arrow Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Arrow Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### ArrowAnnotation()
```
public ArrowAnnotation()
```

Initializes new instance of ArrowAnnotation class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets annotation position

**Returns:**
Rectangle -
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets annotation position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPenColor()
```
public final Integer getPenColor()
```

Gets or sets annotation pen color

**Returns:**
java.lang.Integer -
##### setPenColor(Integer value)
```
public final void setPenColor(Integer value)
```

Gets or sets annotation pen color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPenStyle()
```
public final Byte getPenStyle()
```

Gets or sets annotation pen style

**Returns:**
java.lang.Byte -
##### setPenStyle(Byte value)
```
public final void setPenStyle(Byte value)
```

Gets or sets annotation pen style

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### getPenWidth()
```
public final Byte getPenWidth()
```

Gets or sets annotation pen width

**Returns:**
java.lang.Byte -
##### setPenWidth(Byte value)
```
public final void setPenWidth(Byte value)
```

Gets or sets annotation pen width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(ArrowAnnotation other)
```
public final boolean equals(ArrowAnnotation other)
```

Compares Area Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ArrowAnnotation | The ArrowAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Arrow Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Arrow Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### DistanceAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/distanceannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IDistanceAnnotation
```
public class DistanceAnnotation extends AnnotationBase implements IDistanceAnnotation
```

Represents Distance annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| DistanceAnnotation() | Initializes new instance of DistanceAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets annotation position |
| setBox(Rectangle value) | Gets or sets annotation position |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getPenColor() | Gets or sets annotation pen color |
| setPenColor(Integer value) | Gets or sets annotation pen color |
| getPenStyle() | Gets or sets annotation pen style |
| setPenStyle(Byte value) | Gets or sets annotation pen style |
| getPenWidth() | Gets or sets annotation pen width |
| setPenWidth(Byte value) | Gets or sets annotation pen width |
| equals(DistanceAnnotation other) | Compares Distance Annotations using IEquatable Equals method |
| equals(Object o) | Compares Distance Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Distance Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### DistanceAnnotation()
```
public DistanceAnnotation()
```

Initializes new instance of DistanceAnnotation class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets annotation position

**Returns:**
Rectangle -
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets annotation position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPenColor()
```
public final Integer getPenColor()
```

Gets or sets annotation pen color

**Returns:**
java.lang.Integer -
##### setPenColor(Integer value)
```
public final void setPenColor(Integer value)
```

Gets or sets annotation pen color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPenStyle()
```
public final Byte getPenStyle()
```

Gets or sets annotation pen style

**Returns:**
java.lang.Byte -
##### setPenStyle(Byte value)
```
public final void setPenStyle(Byte value)
```

Gets or sets annotation pen style

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### getPenWidth()
```
public final Byte getPenWidth()
```

Gets or sets annotation pen width

**Returns:**
java.lang.Byte -
##### setPenWidth(Byte value)
```
public final void setPenWidth(Byte value)
```

Gets or sets annotation pen width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(DistanceAnnotation other)
```
public final boolean equals(DistanceAnnotation other)
```

Compares Distance Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | DistanceAnnotation | The DistanceAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Distance Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Distance Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### EllipseAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/ellipseannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase, com.groupdocs.annotation.models.annotationmodels.AnnotationBaseProps

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IEllipseAnnotation
```
public class EllipseAnnotation extends AnnotationBaseProps implements IEllipseAnnotation
```

Represents Ellipse annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| EllipseAnnotation() | Initializes new instance of EllipseAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getPenStyle() | Gets or sets annotation pen style |
| setPenStyle(Byte value) | Gets or sets annotation pen style |
| equals(EllipseAnnotation other) | Compares Ellipse Annotations using IEquatable Equals method |
| equals(Object o) | Compares Ellipse Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Ellipse Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### EllipseAnnotation()
```
public EllipseAnnotation()
```

Initializes new instance of EllipseAnnotation class.

##### getPenStyle()
```
public final Byte getPenStyle()
```

Gets or sets annotation pen style

**Returns:**
java.lang.Byte -
##### setPenStyle(Byte value)
```
public final void setPenStyle(Byte value)
```

Gets or sets annotation pen style

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(EllipseAnnotation other)
```
public final boolean equals(EllipseAnnotation other)
```

Compares Ellipse Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | EllipseAnnotation | The EllipseAnnotation object to compare with the current object |

**Returns:**
boolean
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Ellipse Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Ellipse Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### HighlightAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/highlightannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IHighlightAnnotation
```
public class HighlightAnnotation extends AnnotationBase implements IHighlightAnnotation
```

Represents Highlight annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| HighlightAnnotation() | Initializes new instance of HighlightAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBackgroundColor() | Gets or sets annotation background color |
| setBackgroundColor(Integer value) | Gets or sets annotation background color |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getPoints() | Gets or sets collection of points that describe rectangles with text |
| setPoints(List<Point> value) | Gets or sets collection of points that describe rectangles with text |
| equals(HighlightAnnotation other) | Compares Highlight Annotations using IEquatable Equals method |
| equals(Object obj) | Compares Highlight Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Highlight Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### HighlightAnnotation()
```
public HighlightAnnotation()
```

Initializes new instance of HighlightAnnotation class.

##### getBackgroundColor()
```
public final Integer getBackgroundColor()
```

Gets or sets annotation background color

**Returns:**
java.lang.Integer
##### setBackgroundColor(Integer value)
```
public final void setBackgroundColor(Integer value)
```

Gets or sets annotation background color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPoints()
```
public final List<Point> getPoints()
```

Gets or sets collection of points that describe rectangles with text

**Returns:**
java.util.List<com.groupdocs.annotation.models.Point> -
##### setPoints(List<Point> value)
```
public final void setPoints(List<Point> value)
```

Gets or sets collection of points that describe rectangles with text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.Point> |  |

##### equals(HighlightAnnotation other)
```
public final boolean equals(HighlightAnnotation other)
```

Compares Highlight Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | HighlightAnnotation | The HighlightAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Compares Highlight Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Highlight Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### ImageAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/imageannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IImageAnnotation
```
public class ImageAnnotation extends AnnotationBase implements IImageAnnotation
```

Represents image annotation properties

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageAnnotation() | Initializes new instance of ImageAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets annotation position |
| setBox(Rectangle value) | Gets or sets annotation position |
| getImagePath() | Gets or sets image path |
| setImagePath(String value) | Gets or sets image path |
| getImageData() | Gets or sets image data |
| setImageData(String value) | Gets or sets image data |
| getImageExtension() | Gets or sets image data |
| setImageExtension(String value) |  |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getAngle() | Gets or sets annotation rotation angle |
| setAngle(Double value) | Gets or sets annotation rotation angle |
| getZIndex() | Gets or sets z-index. |
| setZIndex(Integer value) | Gets or sets annotation pen color |
| getImage() | Gets image object |
| equals(ImageAnnotation other) | Compares Image Annotations using IEquatable Equals method |
| equals(Object o) | Compares Image Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Image Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### ImageAnnotation()
```
public ImageAnnotation()
```

Initializes new instance of ImageAnnotation class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets annotation position

**Returns:**
Rectangle
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets annotation position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getImagePath()
```
public final String getImagePath()
```

Gets or sets image path

**Returns:**
java.lang.String -
##### setImagePath(String value)
```
public final void setImagePath(String value)
```

Gets or sets image path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageData()
```
public final String getImageData()
```

Gets or sets image data

**Returns:**
java.lang.String -
##### setImageData(String value)
```
public final void setImageData(String value)
```

Gets or sets image data

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageExtension()
```
public final String getImageExtension()
```

Gets or sets image data

**Returns:**
java.lang.String -
##### setImageExtension(String value)
```
public final void setImageExtension(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getAngle()
```
public final Double getAngle()
```

Gets or sets annotation rotation angle

**Returns:**
java.lang.Double
##### setAngle(Double value)
```
public final void setAngle(Double value)
```

Gets or sets annotation rotation angle

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getZIndex()
```
public final Integer getZIndex()
```

Gets or sets z-index. Default value is 0

The  **z-index**  property specifies the stack order of an element.

**Returns:**
java.lang.Integer -
##### setZIndex(Integer value)
```
public final void setZIndex(Integer value)
```

Gets or sets annotation pen color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getImage()
```
public final System.Drawing.Image getImage()
```

Gets image object

**Returns:**
com.aspose.ms.System.Drawing.Image -
##### equals(ImageAnnotation other)
```
public final boolean equals(ImageAnnotation other)
```

Compares Image Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ImageAnnotation | The ImageAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Image Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Image Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### LinkAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/linkannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.ILinkAnnotation
```
public class LinkAnnotation extends AnnotationBase implements ILinkAnnotation
```

Represents Link annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| LinkAnnotation() | Initializes new instance of LinkAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getBackgroundColor() | Gets or sets annotation text font color |
| setBackgroundColor(Integer value) | Gets or sets annotation text font color |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getPoints() | Coordinates |
| setPoints(List<Point> value) | Coordinates |
| getUrl() | Gets or sets annotation link url |
| setUrl(String value) | Gets or sets annotation link url |
| equals(LinkAnnotation other) | Compares Link Annotations using IEquatable Equals method |
| equals(Object o) | Compares Link Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Link Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### LinkAnnotation()
```
public LinkAnnotation()
```

Initializes new instance of LinkAnnotation class.

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getBackgroundColor()
```
public final Integer getBackgroundColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setBackgroundColor(Integer value)
```
public final void setBackgroundColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPoints()
```
public final List<Point> getPoints()
```

Coordinates

**Returns:**
java.util.List<com.groupdocs.annotation.models.Point> -
##### setPoints(List<Point> value)
```
public final void setPoints(List<Point> value)
```

Coordinates

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.Point> |  |

##### getUrl()
```
public final String getUrl()
```

Gets or sets annotation link url

**Returns:**
java.lang.String -
##### setUrl(String value)
```
public final void setUrl(String value)
```

Gets or sets annotation link url

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(LinkAnnotation other)
```
public final boolean equals(LinkAnnotation other)
```

Compares Link Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | LinkAnnotation | The LinkAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Link Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Link Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### PointAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/pointannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IPointAnnotation
```
public class PointAnnotation extends AnnotationBase implements IPointAnnotation
```

Represents Point annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| PointAnnotation() | Initializes new instance of PointAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets annotation position |
| setBox(Rectangle value) | Gets or sets annotation position |
| equals(PointAnnotation other) | Compares Point Annotations using IEquatable Equals method |
| equals(Object o) | Compares Point Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Point Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### PointAnnotation()
```
public PointAnnotation()
```

Initializes new instance of PointAnnotation class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets annotation position

**Returns:**
Rectangle
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets annotation position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### equals(PointAnnotation other)
```
public final boolean equals(PointAnnotation other)
```

Compares Point Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | PointAnnotation | The PointAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Point Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Point Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### PolylineAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/polylineannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase, com.groupdocs.annotation.models.annotationmodels.AnnotationBasePropsV3

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IPolylineAnnotation
```
public class PolylineAnnotation extends AnnotationBasePropsV3 implements IPolylineAnnotation
```

Represents Polyline annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| PolylineAnnotation() | Initializes new instance of AreaAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getSvgPath() | Gets or sets annotation SVG path |
| setSvgPath(String value) | Gets or sets annotation SVG path |
| equals(PolylineAnnotation other) | Compares Polyline Annotations using IEquatable Equals method |
| equals(Object o) | Compares Polyline Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Polyline Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### PolylineAnnotation()
```
public PolylineAnnotation()
```

Initializes new instance of AreaAnnotation class.

##### getSvgPath()
```
public final String getSvgPath()
```

Gets or sets annotation SVG path

**Returns:**
java.lang.String -
##### setSvgPath(String value)
```
public final void setSvgPath(String value)
```

Gets or sets annotation SVG path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(PolylineAnnotation other)
```
public final boolean equals(PolylineAnnotation other)
```

Compares Polyline Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | PolylineAnnotation | The PolylineAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Polyline Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Polyline Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### ReplacementAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/replacementannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IReplacementAnnotation
```
public class ReplacementAnnotation extends AnnotationBase implements IReplacementAnnotation
```

Represents Replacement annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| ReplacementAnnotation() | Initializes new instance of ReplacementAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getBackgroundColor() | Gets annotation background color |
| setBackgroundColor(Integer value) | Sets annotation background color |
| getFontSize() | Gets or sets annotation text font size |
| setFontSize(Double value) | Gets or sets annotation text font size |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getPoints() | Gets or sets collection of points that describe rectangles with text |
| setPoints(List<Point> value) | Gets or sets collection of points that describe rectangles with text |
| getTextToReplace() | Gets or sets text to be replaced |
| setTextToReplace(String value) | Gets or sets text to be replaced |
| equals(ReplacementAnnotation other) | Compares Replacement Annotations using IEquatable Equals method |
| equals(Object o) | Compares Replacement Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Replacement Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### ReplacementAnnotation()
```
public ReplacementAnnotation()
```

Initializes new instance of ReplacementAnnotation class.

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getBackgroundColor()
```
public final Integer getBackgroundColor()
```

Gets annotation background color

**Returns:**
java.lang.Integer -
##### setBackgroundColor(Integer value)
```
public final void setBackgroundColor(Integer value)
```

Sets annotation background color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getFontSize()
```
public final Double getFontSize()
```

Gets or sets annotation text font size

**Returns:**
java.lang.Double -
##### setFontSize(Double value)
```
public final void setFontSize(Double value)
```

Gets or sets annotation text font size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPoints()
```
public final List<Point> getPoints()
```

Gets or sets collection of points that describe rectangles with text

**Returns:**
java.util.List<com.groupdocs.annotation.models.Point> -
##### setPoints(List<Point> value)
```
public final void setPoints(List<Point> value)
```

Gets or sets collection of points that describe rectangles with text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.Point> |  |

##### getTextToReplace()
```
public final String getTextToReplace()
```

Gets or sets text to be replaced

**Returns:**
java.lang.String -
##### setTextToReplace(String value)
```
public final void setTextToReplace(String value)
```

Gets or sets text to be replaced

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(ReplacementAnnotation other)
```
public final boolean equals(ReplacementAnnotation other)
```

Compares Replacement Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ReplacementAnnotation | The ReplacementAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Replacement Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Replacement Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### ResourcesRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/resourcesredactionannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IResourcesRedactionAnnotation
```
public class ResourcesRedactionAnnotation extends AnnotationBase implements IResourcesRedactionAnnotation
```

Represents Resources redaction annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| ResourcesRedactionAnnotation() | Initializes new instance of ResourcesRedactionAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets annotation position |
| setBox(Rectangle value) | Gets or sets annotation position |
| equals(ResourcesRedactionAnnotation other) | Compares Resources Redaction Annotations using IEquatable Equals method |
| equals(Object o) | Compares Resources Redaction Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Resources Redaction Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### ResourcesRedactionAnnotation()
```
public ResourcesRedactionAnnotation()
```

Initializes new instance of ResourcesRedactionAnnotation class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets annotation position

**Returns:**
Rectangle -
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets annotation position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### equals(ResourcesRedactionAnnotation other)
```
public final boolean equals(ResourcesRedactionAnnotation other)
```

Compares Resources Redaction Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ResourcesRedactionAnnotation | The ResourcesRedactionAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Resources Redaction Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Resources Redaction Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### SearchTextFragment
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/searchtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.ISearchTextFragment
```
public class SearchTextFragment extends AnnotationBase implements ISearchTextFragment
```

Represents Search Text annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| SearchTextFragment() | Initializes new instance of SearchTextFragment class. |
#### Methods

| Method | Description |
| --- | --- |
| getBackgroundColor() | Gets or sets annotation background color |
| setBackgroundColor(Integer value) | Gets or sets annotation background color |
| getText() | Gets or sets text |
| setText(String value) | Gets or sets text |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getFontFamily() | Gets or sets annotation text font family |
| setFontFamily(String value) | Gets or sets annotation text font family |
| getFontSize() | Gets or sets annotation text font size |
| setFontSize(Double value) | Gets or sets annotation text font size |
| equals(SearchTextFragment other) | Compares Search Text Annotations using IEquatable Equals method |
| equals(Object o) | Compares Search Text Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Search Text Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### SearchTextFragment()
```
public SearchTextFragment()
```

Initializes new instance of SearchTextFragment class.

##### getBackgroundColor()
```
public final Integer getBackgroundColor()
```

Gets or sets annotation background color

**Returns:**
java.lang.Integer
##### setBackgroundColor(Integer value)
```
public final void setBackgroundColor(Integer value)
```

Gets or sets annotation background color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getText()
```
public final String getText()
```

Gets or sets text

**Returns:**
java.lang.String -
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getFontFamily()
```
public final String getFontFamily()
```

Gets or sets annotation text font family

**Returns:**
java.lang.String -
##### setFontFamily(String value)
```
public final void setFontFamily(String value)
```

Gets or sets annotation text font family

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSize()
```
public final Double getFontSize()
```

Gets or sets annotation text font size

**Returns:**
java.lang.Double -
##### setFontSize(Double value)
```
public final void setFontSize(Double value)
```

Gets or sets annotation text font size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### equals(SearchTextFragment other)
```
public final boolean equals(SearchTextFragment other)
```

Compares Search Text Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | SearchTextFragment | The SearchTextFragment object to compare with the current object |

**Returns:**
boolean
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Search Text Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Search Text Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### SquigglyAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/squigglyannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.ISquigglyAnnotation
```
public class SquigglyAnnotation extends AnnotationBase implements ISquigglyAnnotation
```

Represents squiggly annotation properties

#### Constructors

| Constructor | Description |
| --- | --- |
| SquigglyAnnotation() | Initializes new instance of SquigglyAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getBackgroundColor() | Gets or sets annotation text font color |
| setBackgroundColor(Integer value) | Gets or sets annotation text font color |
| getSquigglyColor() | Gets or sets annotation text font color |
| setSquigglyColor(Integer value) | Gets or sets annotation text font color |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getPoints() | Coordinates |
| setPoints(List<Point> value) | Coordinates |
| equals(SquigglyAnnotation other) | Compares squiggly Annotations using IEquatable Equals method |
| equals(Object obj) | Compares Squiggly Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Squiggly Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### SquigglyAnnotation()
```
public SquigglyAnnotation()
```

Initializes new instance of SquigglyAnnotation class.

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getBackgroundColor()
```
public final Integer getBackgroundColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setBackgroundColor(Integer value)
```
public final void setBackgroundColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getSquigglyColor()
```
public final Integer getSquigglyColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setSquigglyColor(Integer value)
```
public final void setSquigglyColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPoints()
```
public final List<Point> getPoints()
```

Coordinates

**Returns:**
java.util.List<com.groupdocs.annotation.models.Point> -
##### setPoints(List<Point> value)
```
public final void setPoints(List<Point> value)
```

Coordinates

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.Point> |  |

##### equals(SquigglyAnnotation other)
```
public final boolean equals(SquigglyAnnotation other)
```

Compares squiggly Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | SquigglyAnnotation | The SquigglyAnnotation object to compare with the current object |

**Returns:**
boolean
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Compares Squiggly Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Squiggly Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### StrikeoutAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/strikeoutannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase, com.groupdocs.annotation.models.annotationmodels.AnnotationBasePropsV2

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IStrikeoutAnnotation
```
public class StrikeoutAnnotation extends AnnotationBasePropsV2 implements IStrikeoutAnnotation
```

Represents Strikeout annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| StrikeoutAnnotation() | Initializes new instance of StrikeoutAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| equals(StrikeoutAnnotation other) | Compares Strikeout Annotations using IEquatable Equals method |
| equals(Object o) | Compares Strikeout Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Strikeout Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### StrikeoutAnnotation()
```
public StrikeoutAnnotation()
```

Initializes new instance of StrikeoutAnnotation class.

##### equals(StrikeoutAnnotation other)
```
public final boolean equals(StrikeoutAnnotation other)
```

Compares Strikeout Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | StrikeoutAnnotation | The StrikeoutAnnotation object to compare with the current object |

**Returns:**
boolean
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Strikeout Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Strikeout Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### TextFieldAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/textfieldannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase, com.groupdocs.annotation.models.annotationmodels.AnnotationBaseProps

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.ITextFieldAnnotation
```
public class TextFieldAnnotation extends AnnotationBaseProps implements ITextFieldAnnotation
```

Represents Text field annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| TextFieldAnnotation() | Initializes new instance of TextFieldAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets or sets text |
| setText(String value) | Gets or sets text |
| getTextHorizontalAlignment() | Gets or sets text horizontal alignment |
| setTextHorizontalAlignment(Integer value) | Gets or sets text horizontal alignment |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getFontFamily() | Gets or sets annotation text font family |
| setFontFamily(String value) | Gets or sets annotation text font family |
| getFontSize() | Gets or sets annotation text font size |
| setFontSize(Double value) | Gets or sets annotation text font size |
| getPenStyle() | Gets or sets annotation pen style |
| setPenStyle(Byte value) | Gets or sets annotation pen style |
| equals(TextFieldAnnotation other) | Compares Text Field Annotations using IEquatable Equals method |
| equals(Object o) | Compares Text Field Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Text Field Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### TextFieldAnnotation()
```
public TextFieldAnnotation()
```

Initializes new instance of TextFieldAnnotation class.

##### getText()
```
public final String getText()
```

Gets or sets text

**Returns:**
java.lang.String -
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTextHorizontalAlignment()
```
public final Integer getTextHorizontalAlignment()
```

Gets or sets text horizontal alignment

**Returns:**
java.lang.Integer -
##### setTextHorizontalAlignment(Integer value)
```
public final void setTextHorizontalAlignment(Integer value)
```

Gets or sets text horizontal alignment

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getFontFamily()
```
public final String getFontFamily()
```

Gets or sets annotation text font family

**Returns:**
java.lang.String -
##### setFontFamily(String value)
```
public final void setFontFamily(String value)
```

Gets or sets annotation text font family

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSize()
```
public final Double getFontSize()
```

Gets or sets annotation text font size

**Returns:**
java.lang.Double -
##### setFontSize(Double value)
```
public final void setFontSize(Double value)
```

Gets or sets annotation text font size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getPenStyle()
```
public final Byte getPenStyle()
```

Gets or sets annotation pen style

**Returns:**
java.lang.Byte -
##### setPenStyle(Byte value)
```
public final void setPenStyle(Byte value)
```

Gets or sets annotation pen style

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(TextFieldAnnotation other)
```
public final boolean equals(TextFieldAnnotation other)
```

Compares Text Field Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TextFieldAnnotation | The TextFieldAnnotation object to compare with the current object |

**Returns:**
boolean
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Text Field Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Text Field Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### TextRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/textredactionannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.ITextRedactionAnnotation
```
public class TextRedactionAnnotation extends AnnotationBase implements ITextRedactionAnnotation
```

Represents Text redaction annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| TextRedactionAnnotation() | Initializes new instance of TextRedactionAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getFontColor() | Gets or sets annotation text font color |
| setFontColor(Integer value) | Gets or sets annotation text font color |
| getPoints() | Gets or sets collection of points that describe rectangles with text |
| setPoints(List<Point> value) | Gets or sets collection of points that describe rectangles with text |
| equals(TextRedactionAnnotation other) | Compares Text Redaction Annotations using IEquatable Equals method |
| equals(Object o) | Compares Text Redaction Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Text Redaction Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### TextRedactionAnnotation()
```
public TextRedactionAnnotation()
```

Initializes new instance of TextRedactionAnnotation class.

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPoints()
```
public final List<Point> getPoints()
```

Gets or sets collection of points that describe rectangles with text

**Returns:**
java.util.List<com.groupdocs.annotation.models.Point> -
##### setPoints(List<Point> value)
```
public final void setPoints(List<Point> value)
```

Gets or sets collection of points that describe rectangles with text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.Point> |  |

##### equals(TextRedactionAnnotation other)
```
public final boolean equals(TextRedactionAnnotation other)
```

Compares Text Redaction Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TextRedactionAnnotation | The TextRedactionAnnotation object to compare with the current object |

**Returns:**
boolean
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Text Redaction Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Text Redaction Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### UnderlineAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/underlineannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase, com.groupdocs.annotation.models.annotationmodels.AnnotationBasePropsV2

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IUnderlineAnnotation
```
public class UnderlineAnnotation extends AnnotationBasePropsV2 implements IUnderlineAnnotation
```

Represents Underline annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| UnderlineAnnotation() | Initializes new instance of UnderlineAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getUnderlineColor() | Gets or sets annotation text font color |
| setUnderlineColor(Integer value) | Gets or sets annotation text font color |
| equals(UnderlineAnnotation other) | Compares Underline Annotations using IEquatable Equals method |
| equals(Object o) | Compares Underline Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Underline Annotation |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### UnderlineAnnotation()
```
public UnderlineAnnotation()
```

Initializes new instance of UnderlineAnnotation class.

##### getUnderlineColor()
```
public final Integer getUnderlineColor()
```

Gets or sets annotation text font color

**Returns:**
java.lang.Integer -
##### setUnderlineColor(Integer value)
```
public final void setUnderlineColor(Integer value)
```

Gets or sets annotation text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### equals(UnderlineAnnotation other)
```
public final boolean equals(UnderlineAnnotation other)
```

Compares Underline Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | UnderlineAnnotation | The UnderlineAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Underline Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Underline Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### WatermarkAnnotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.annotationmodels/watermarkannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.annotationmodels.interfaces.annotations.IWatermarkAnnotation
```
public class WatermarkAnnotation extends AnnotationBase implements IWatermarkAnnotation
```

Represents Watermark annotation properties
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkAnnotation() | Initializes new instance of WatermarkAnnotation class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets annotation position |
| setBox(Rectangle value) | Gets or sets annotation position |
| getAutoScale() | Gets or sets auto scale for watermar |
| setAutoScale(Boolean value) | Gets or sets auto scale for watermar |
| getText() | Gets or sets watermark text |
| setText(String value) | Gets or sets watermark text |
| getFontColor() | Gets or sets watermark text font color |
| setFontColor(Integer value) | Gets or sets watermark text font color |
| getFontFamily() | Gets or sets watermark text font family |
| setFontFamily(String value) | Gets or sets watermark text font family |
| getFontSize() | Gets or sets watermark text font size |
| setFontSize(Double value) | Gets or sets watermark text font size |
| getOpacity() | Gets or sets annotation opacity |
| setOpacity(Double value) | Gets or sets annotation opacity |
| getAngle() | Gets or sets watermark rotation angle |
| setAngle(Double value) | Gets or sets watermark rotation angle |
| equals(WatermarkAnnotation other) | Compares Watermark Annotations using IEquatable Equals method |
| equals(Object o) | Compares Watermark Annotations using standard object Equals method |
| hashCode() | Returns HashCode of Watermark Annotation |
| deepClone() | Returns new Instance with same values |
| getHorizontalAlignment() | Gets or sets watermark horizontal alignment on document |
| setHorizontalAlignment(Integer value) | Gets or sets watermark horizontal alignment on document |
| getVerticalAlignment() | Gets or sets watermark vertical alignment on document |
| setVerticalAlignment(Integer value) | Gets or sets watermark vertical alignment on document |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### WatermarkAnnotation()
```
public WatermarkAnnotation()
```

Initializes new instance of WatermarkAnnotation class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets annotation position

**Returns:**
Rectangle
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets annotation position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getAutoScale()
```
public final Boolean getAutoScale()
```

Gets or sets auto scale for watermar

**Returns:**
java.lang.Boolean -
##### setAutoScale(Boolean value)
```
public final void setAutoScale(Boolean value)
```

Gets or sets auto scale for watermar

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  |

##### getText()
```
public final String getText()
```

Gets or sets watermark text

**Returns:**
java.lang.String -
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets watermark text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontColor()
```
public final Integer getFontColor()
```

Gets or sets watermark text font color

**Returns:**
java.lang.Integer -
##### setFontColor(Integer value)
```
public final void setFontColor(Integer value)
```

Gets or sets watermark text font color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getFontFamily()
```
public final String getFontFamily()
```

Gets or sets watermark text font family

**Returns:**
java.lang.String -
##### setFontFamily(String value)
```
public final void setFontFamily(String value)
```

Gets or sets watermark text font family

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSize()
```
public final Double getFontSize()
```

Gets or sets watermark text font size

**Returns:**
java.lang.Double -
##### setFontSize(Double value)
```
public final void setFontSize(Double value)
```

Gets or sets watermark text font size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getOpacity()
```
public final Double getOpacity()
```

Gets or sets annotation opacity

**Returns:**
java.lang.Double -
##### setOpacity(Double value)
```
public final void setOpacity(Double value)
```

Gets or sets annotation opacity

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### getAngle()
```
public final Double getAngle()
```

Gets or sets watermark rotation angle

**Returns:**
java.lang.Double -
##### setAngle(Double value)
```
public final void setAngle(Double value)
```

Gets or sets watermark rotation angle

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### equals(WatermarkAnnotation other)
```
public final boolean equals(WatermarkAnnotation other)
```

Compares Watermark Annotations using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | WatermarkAnnotation | The WatermarkAnnotation object to compare with the current object |

**Returns:**
boolean -
##### equals(Object o)
```
public boolean equals(Object o)
```

Compares Watermark Annotations using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Watermark Annotation

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### getHorizontalAlignment()
```
public final Integer getHorizontalAlignment()
```

Gets or sets watermark horizontal alignment on document

**Returns:**
java.lang.Integer -
##### setHorizontalAlignment(Integer value)
```
public final void setHorizontalAlignment(Integer value)
```

Gets or sets watermark horizontal alignment on document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getVerticalAlignment()
```
public final Integer getVerticalAlignment()
```

Gets or sets watermark vertical alignment on document

**Returns:**
java.lang.Integer -
##### setVerticalAlignment(Integer value)
```
public final void setVerticalAlignment(Integer value)
```

Gets or sets watermark vertical alignment on document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### com.groupdocs.annotation.models.formatspecificcomponents.pdf
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.formatspecificcomponents.pdf.md

The namespace provides format specific component models

#### Classes

| Class | Description |
| --- | --- |
| ButtonComponent | Represents Button properties |
| CheckBoxComponent | Represents CheckBox properties |
| DropdownComponent | Represents dropdown component properties |

### ButtonComponent
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces.IButtonComponent
```
public class ButtonComponent extends AnnotationBase implements IButtonComponent
```

Represents Button properties

#### Constructors

| Constructor | Description |
| --- | --- |
| ButtonComponent() | Initializes new instance of ButtonComponent class. |
#### Methods

| Method | Description |
| --- | --- |
| getBox() | Gets or sets component position |
| setBox(Rectangle value) | Gets or sets component position |
| getStyle() | Gets or sets annotation border |
| setStyle(Byte value) | Gets or sets annotation border |
| getBorderWidth() | Gets or sets annotation border width |
| setBorderWidth(Integer value) | Gets or sets annotation border width |
| getBorderColor() | Gets or sets annotation border color |
| setBorderColor(Integer value) | Gets or sets annotation border color |
| getAlternateName() | Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat. |
| setAlternateName(String value) | Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat. |
| getPartialName() | Gets or sets component partial name |
| setPartialName(String value) | Gets or sets component partial name |
| getNormalCaption() | Gets or sets component normal caption |
| setNormalCaption(String value) | Gets or sets component normal caption |
| getRolloverCaption() | Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. |
| setRolloverCaption(String value) | Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. |
| getPenColor() | Gets or sets component pen color |
| setPenColor(Integer value) | Gets or sets component pen color |
| getButtonColor() | Gets or sets component color |
| setButtonColor(Integer value) | Gets or sets component color |
| equals(ButtonComponent other) | Compares Button Components using IEquatable Equals method |
| equals(Object obj) | Compares Button Components using standard object Equals method |
| hashCode() | Returns HashCode of Button Component |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### ButtonComponent()
```
public ButtonComponent()
```

Initializes new instance of ButtonComponent class.

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets component position

**Returns:**
Rectangle
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets component position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getStyle()
```
public final Byte getStyle()
```

Gets or sets annotation border

**Returns:**
java.lang.Byte -
##### setStyle(Byte value)
```
public final void setStyle(Byte value)
```

Gets or sets annotation border

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### getBorderWidth()
```
public final Integer getBorderWidth()
```

Gets or sets annotation border width

**Returns:**
java.lang.Integer -
##### setBorderWidth(Integer value)
```
public final void setBorderWidth(Integer value)
```

Gets or sets annotation border width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getBorderColor()
```
public final Integer getBorderColor()
```

Gets or sets annotation border color

**Returns:**
java.lang.Integer -
##### setBorderColor(Integer value)
```
public final void setBorderColor(Integer value)
```

Gets or sets annotation border color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getAlternateName()
```
public final String getAlternateName()
```

Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat.

**Returns:**
java.lang.String -
##### setAlternateName(String value)
```
public final void setAlternateName(String value)
```

Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPartialName()
```
public final String getPartialName()
```

Gets or sets component partial name

**Returns:**
java.lang.String -
##### setPartialName(String value)
```
public final void setPartialName(String value)
```

Gets or sets component partial name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNormalCaption()
```
public final String getNormalCaption()
```

Gets or sets component normal caption

**Returns:**
java.lang.String -
##### setNormalCaption(String value)
```
public final void setNormalCaption(String value)
```

Gets or sets component normal caption

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRolloverCaption()
```
public final String getRolloverCaption()
```

Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.

**Returns:**
java.lang.String -
##### setRolloverCaption(String value)
```
public final void setRolloverCaption(String value)
```

Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPenColor()
```
public final Integer getPenColor()
```

Gets or sets component pen color

**Returns:**
java.lang.Integer -
##### setPenColor(Integer value)
```
public final void setPenColor(Integer value)
```

Gets or sets component pen color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getButtonColor()
```
public final Integer getButtonColor()
```

Gets or sets component color

**Returns:**
java.lang.Integer -
##### setButtonColor(Integer value)
```
public final void setButtonColor(Integer value)
```

Gets or sets component color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### equals(ButtonComponent other)
```
public final boolean equals(ButtonComponent other)
```

Compares Button Components using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ButtonComponent | The ButtonComponent object to compare with the current object |

**Returns:**
boolean -
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Compares Button Components using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Button Component

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### CheckBoxComponent
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces.ICheckBoxComponent
```
public class CheckBoxComponent extends AnnotationBase implements ICheckBoxComponent
```

Represents CheckBox properties

#### Constructors

| Constructor | Description |
| --- | --- |
| CheckBoxComponent() | Initializes new instance of CheckBoxComponent class. |
#### Methods

| Method | Description |
| --- | --- |
| getChecked() | Gets or sets component checked |
| setChecked(boolean value) | Gets or sets component checked |
| getBox() | Gets or sets component position |
| setBox(Rectangle value) | Gets or sets component position |
| getPenColor() | Gets or sets component color |
| setPenColor(Integer value) | Gets or sets component color |
| getStyle() | Gets or sets style box |
| setStyle(Byte value) | Gets or sets style box |
| equals(CheckBoxComponent other) | Compares CheckBox Components using IEquatable Equals method |
| equals(Object obj) | Compares CheckBox Components using standard object Equals method |
| hashCode() | Returns HashCode of CheckBox Component |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### CheckBoxComponent()
```
public CheckBoxComponent()
```

Initializes new instance of CheckBoxComponent class.

##### getChecked()
```
public final boolean getChecked()
```

Gets or sets component checked

**Returns:**
boolean -
##### setChecked(boolean value)
```
public final void setChecked(boolean value)
```

Gets or sets component checked

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets component position

**Returns:**
Rectangle
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets component position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getPenColor()
```
public final Integer getPenColor()
```

Gets or sets component color

**Returns:**
java.lang.Integer -
##### setPenColor(Integer value)
```
public final void setPenColor(Integer value)
```

Gets or sets component color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getStyle()
```
public final Byte getStyle()
```

Gets or sets style box

**Returns:**
java.lang.Byte -
##### setStyle(Byte value)
```
public final void setStyle(Byte value)
```

Gets or sets style box

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(CheckBoxComponent other)
```
public final boolean equals(CheckBoxComponent other)
```

Compares CheckBox Components using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | CheckBoxComponent | The CheckBoxComponent object to compare with the current object |

**Returns:**
boolean -
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Compares CheckBox Components using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of CheckBox Component

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### DropdownComponent
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent.md

**Inheritance:**
java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase

**All Implemented Interfaces:**
com.groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces.IDropdownComponent
```
public class DropdownComponent extends AnnotationBase implements IDropdownComponent
```

Represents dropdown component properties

#### Constructors

| Constructor | Description |
| --- | --- |
| DropdownComponent() | Initializes new instance of CheckBoxComponent class. |
#### Methods

| Method | Description |
| --- | --- |
| getOptions() | List of options (drop down items) to be shown when component is clicked |
| setOptions(List<String> value) | List of options (drop down items) to be shown when component is clicked |
| getSelectedOption() | Number of option to be selected by default |
| setSelectedOption(Integer value) | Number of option to be selected by default |
| getPlaceholder() | Text to shown when no options has been selected yet |
| setPlaceholder(String value) | Text to shown when no options has been selected yet |
| getBox() | Gets or sets component position |
| setBox(Rectangle value) | Gets or sets component position |
| getPenColor() | Gets or sets component pen color |
| setPenColor(Integer value) | Gets or sets component pen color |
| getPenStyle() | Gets or sets component pen style |
| setPenStyle(Byte value) | Gets or sets component pen style |
| getPenWidth() | Gets or sets component pen width |
| setPenWidth(Byte value) | Gets or sets component pen width |
| equals(DropdownComponent other) | Compares Dropdown component using IEquatable Equals method |
| equals(Object obj) | Compares Dropdown Components using standard object Equals method |
| hashCode() | Returns HashCode of Dropdown Component |
| deepClone() | Returns new Instance with same values |
| toString() |  |
| toString(ToStringStyle toStringStyle) |  |
##### DropdownComponent()
```
public DropdownComponent()
```

Initializes new instance of CheckBoxComponent class.

##### getOptions()
```
public final List<String> getOptions()
```

List of options (drop down items) to be shown when component is clicked

**Returns:**
java.util.List<java.lang.String> -
##### setOptions(List<String> value)
```
public final void setOptions(List<String> value)
```

List of options (drop down items) to be shown when component is clicked

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### getSelectedOption()
```
public final Integer getSelectedOption()
```

Number of option to be selected by default

**Returns:**
java.lang.Integer
##### setSelectedOption(Integer value)
```
public final void setSelectedOption(Integer value)
```

Number of option to be selected by default

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPlaceholder()
```
public final String getPlaceholder()
```

Text to shown when no options has been selected yet

**Returns:**
java.lang.String
##### setPlaceholder(String value)
```
public final void setPlaceholder(String value)
```

Text to shown when no options has been selected yet

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBox()
```
public final Rectangle getBox()
```

Gets or sets component position

**Returns:**
Rectangle
##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Gets or sets component position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle |  |

##### getPenColor()
```
public final Integer getPenColor()
```

Gets or sets component pen color

**Returns:**
java.lang.Integer
##### setPenColor(Integer value)
```
public final void setPenColor(Integer value)
```

Gets or sets component pen color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPenStyle()
```
public final Byte getPenStyle()
```

Gets or sets component pen style

**Returns:**
java.lang.Byte
##### setPenStyle(Byte value)
```
public final void setPenStyle(Byte value)
```

Gets or sets component pen style

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### getPenWidth()
```
public final Byte getPenWidth()
```

Gets or sets component pen width

**Returns:**
java.lang.Byte
##### setPenWidth(Byte value)
```
public final void setPenWidth(Byte value)
```

Gets or sets component pen width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### equals(DropdownComponent other)
```
public final boolean equals(DropdownComponent other)
```

Compares Dropdown component using IEquatable Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | DropdownComponent | The DropdownComponent object to compare with the current object |

**Returns:**
boolean -
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Compares Dropdown Components using standard object Equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Returns HashCode of Dropdown Component

**Returns:**
int
##### deepClone()
```
public Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### toString(ToStringStyle toStringStyle)
```
public String toString(ToStringStyle toStringStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |  |

**Returns:**
java.lang.String

### com.groupdocs.annotation.models
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models.md

The namespace provides annotation data classes.

#### Classes

| Class | Description |
| --- | --- |
| PageInfo | Represents Document Page Information. |
| PenStyle | Pen style |
| Point | Represents point. |
| Rectangle | Represents rectangle. |
| Reply | Represents annotation reply. |
| User | Represents user properties. |

#### Enumerations

| Enum | Description |
| --- | --- |
| DocumentType | The annotation document type |

### DocumentType
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/documenttype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum DocumentType extends Enum<DocumentType>
```

The annotation document type
#### Fields

| Field | Description |
| --- | --- |
| UNDEFINED | The undefined |
| PDF | Represents Pdf format |
| CELLS | Represents Excel format |
| SLIDES | Represents Powerpoint format |
| WORDS | Represents Word format |
| IMAGES | Represents Image format |
| EMAIL | Represents Email format |
| HTML | Represents HTML format |
| DIAGRAM | Represents Diagram format |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### UNDEFINED
```
public static final DocumentType UNDEFINED
```

The undefined

##### PDF
```
public static final DocumentType PDF
```

Represents Pdf format

##### CELLS
```
public static final DocumentType CELLS
```

Represents Excel format

##### SLIDES
```
public static final DocumentType SLIDES
```

Represents Powerpoint format

##### WORDS
```
public static final DocumentType WORDS
```

Represents Word format

##### IMAGES
```
public static final DocumentType IMAGES
```

Represents Image format

##### EMAIL
```
public static final DocumentType EMAIL
```

Represents Email format

##### HTML
```
public static final DocumentType HTML
```

Represents HTML format

##### DIAGRAM
```
public static final DocumentType DIAGRAM
```

Represents Diagram format

##### values()
```
public static DocumentType[] values()
```

**Returns:**
com.groupdocs.annotation.models.DocumentType[]
##### valueOf(String name)
```
public static DocumentType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
DocumentType

### PageInfo
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

Represents Document Page Information.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo() |  |
| PageInfo(int width, int height) | Initializes new instance of PageInfo class. |
| PageInfo(PageInfo pageInfo) | Initializes new instance of PageInfo class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Page width |
| setWidth(int value) | Page width |
| getHeight() | Page height |
| setHeight(int value) | Page height |
| getPageNumber() | Page number |
| setPageNumber(int value) | Page number |
| getTextLines() | Text lines information |
| setTextLines(List<TextLineInfo> value) | Text lines information |
| equals(Object obj) |  |
| equals(PageInfo obj1, PageInfo obj2) |  |
| hashCode() |  |
##### PageInfo()
```
public PageInfo()
```

##### PageInfo(int width, int height)
```
public PageInfo(int width, int height)
```

Initializes new instance of PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | Page Width. |
| height | int | Page Height. |

##### PageInfo(PageInfo pageInfo)
```
public PageInfo(PageInfo pageInfo)
```

Initializes new instance of PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageInfo | PageInfo | Page Info source. |

##### getWidth()
```
public final int getWidth()
```

Page width

**Returns:**
int -
##### setWidth(int value)
```
public final void setWidth(int value)
```

Page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Page height

**Returns:**
int -
##### setHeight(int value)
```
public final void setHeight(int value)
```

Page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageNumber()
```
public final int getPageNumber()
```

Page number

**Returns:**
int -
##### setPageNumber(int value)
```
public final void setPageNumber(int value)
```

Page number

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextLines()
```
public final List<TextLineInfo> getTextLines()
```

Text lines information

**Returns:**
java.util.List<com.groupdocs.annotation.models.TextLineInfo> -
##### setTextLines(List<TextLineInfo> value)
```
public final void setTextLines(List<TextLineInfo> value)
```

Text lines information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.models.TextLineInfo> |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### equals(PageInfo obj1, PageInfo obj2)
```
public static boolean equals(PageInfo obj1, PageInfo obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | PageInfo |  |
| obj2 | PageInfo |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### PenStyle
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/penstyle.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
```
public final class PenStyle extends System.Enum
```

Pen style
#### Fields

| Field | Description |
| --- | --- |
| SOLID | Specifies a solid line |
| DASH | Specifies a line consisting of dashes |
| DASH_DOT | Specifies a line consisting of dashes and dots |
| DOT | Specifies a line consisting of dots |
| LONG_DASH | Specifies a line consisting of long dashes |
| DASH_DOT_DOT | Specifies a line consisting of dashes and two dots |
#### Methods

| Method | Description |
| --- | --- |
| numbers() |  |
| getName(Byte type) |  |
##### SOLID
```
public static final Byte SOLID
```

Specifies a solid line

##### DASH
```
public static final Byte DASH
```

Specifies a line consisting of dashes

##### DASH_DOT
```
public static final Byte DASH_DOT
```

Specifies a line consisting of dashes and dots

##### DOT
```
public static final Byte DOT
```

Specifies a line consisting of dots

##### LONG_DASH
```
public static final Byte LONG_DASH
```

Specifies a line consisting of long dashes

##### DASH_DOT_DOT
```
public static final Byte DASH_DOT_DOT
```

Specifies a line consisting of dashes and two dots

##### numbers()
```
public static Byte[] numbers()
```

**Returns:**
java.lang.Byte[]
##### getName(Byte type)
```
public static String getName(Byte type)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Byte |  |

**Returns:**
java.lang.String

### Point
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/point.md

**Inheritance:**
java.lang.Object
```
public class Point
```

Represents point.
#### Constructors

| Constructor | Description |
| --- | --- |
| Point() |  |
| Point(float x, float y) | Initializes a new instance of the Point struct. |
| Point(Point point) | Initializes a new instance of Point class. |
#### Methods

| Method | Description |
| --- | --- |
| isPointCollectionsEqual(List<Point> points1, List<Point> points2) |  |
| opEquality(Point left, Point right) | Compares two Point objects. |
| opInequality(Point left, Point right) | Compares two Point objects. |
| equals(Point obj1, Point obj2) |  |
| getX() | Gets or sets the x. |
| setX(float value) | Gets or sets the x. |
| getY() | Gets or sets the y. |
| setY(float value) | Gets or sets the y. |
| equals(Object obj) | Determines whether the specified point is equal to the current point. |
| hashCode() | Serves as the default hash function. |
| toString() |  |
##### Point()
```
public Point()
```

##### Point(float x, float y)
```
public Point(float x, float y)
```

Initializes a new instance of the Point struct.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| x | float | The x. |
| y | float | The y. |

##### Point(Point point)
```
public Point(Point point)
```

Initializes a new instance of Point class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| point | Point | The point source. |

##### isPointCollectionsEqual(List<Point> points1, List<Point> points2)
```
public static boolean isPointCollectionsEqual(List<Point> points1, List<Point> points2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| points1 | java.util.List<com.groupdocs.annotation.models.Point> |  |
| points2 | java.util.List<com.groupdocs.annotation.models.Point> |  |

**Returns:**
boolean
##### opEquality(Point left, Point right)
```
public static boolean opEquality(Point left, Point right)
```

Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Point | A Point to compare. |
| right | Point | A Point to compare. |

**Returns:**
boolean - true if the Point.X and Point.Y values of left and right are equal; otherwise, false.
##### opInequality(Point left, Point right)
```
public static boolean opInequality(Point left, Point right)
```

Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Point | A Point to compare. |
| right | Point | A Point to compare. |

**Returns:**
boolean - true if the Point.X and Point.Y values of left and right are not equal; otherwise, false.
##### equals(Point obj1, Point obj2)
```
public static boolean equals(Point obj1, Point obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | Point |  |
| obj2 | Point |  |

**Returns:**
boolean
##### getX()
```
public final float getX()
```

Gets or sets the x.

Value: The x.

**Returns:**
float -
##### setX(float value)
```
public final void setX(float value)
```

Gets or sets the x.

Value: The x.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getY()
```
public final float getY()
```

Gets or sets the y.

Value: The y.

**Returns:**
float -
##### setY(float value)
```
public final void setY(float value)
```

Gets or sets the y.

Value: The y.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified point is equal to the current point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The point to compare with the current point. |

**Returns:**
boolean -   if the specified point is equal to the current point; otherwise,  .
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current point.
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### Rectangle
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/rectangle.md

**Inheritance:**
java.lang.Object
```
public class Rectangle
```

Represents rectangle.
#### Constructors

| Constructor | Description |
| --- | --- |
| Rectangle() |  |
| Rectangle(float x, float y, float width, float height) | Initializes a new instance of the Rectangle class. |
| Rectangle(Rectangle rectangle) | Initializes a new instance of Rectangle class. |
#### Methods

| Method | Description |
| --- | --- |
| opEquality(Rectangle left, Rectangle right) | Compares two Rectangle objects. |
| opInequality(Rectangle left, Rectangle right) | Compares two Rectangle objects. |
| equals(Rectangle obj1, Rectangle obj2) |  |
| getX() | Gets or sets the x. |
| setX(float value) | Gets or sets the x. |
| getY() | Gets or sets the y. |
| setY(float value) | Gets or sets the y. |
| getWidth() | Gets or sets the width. |
| setWidth(float value) | Gets or sets the width. |
| getHeight() | Gets or sets the height. |
| setHeight(float value) | Gets or sets the height. |
| equals(Object obj) | Determines whether the specified rectangle is equal to the current rectangle. |
| hashCode() | Serves as the default hash function. |
| toString() |  |
##### Rectangle()
```
public Rectangle()
```

##### Rectangle(float x, float y, float width, float height)
```
public Rectangle(float x, float y, float width, float height)
```

Initializes a new instance of the Rectangle class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| x | float | The x. |
| y | float | The y. |
| width | float | The width. |
| height | float | The height. |

##### Rectangle(Rectangle rectangle)
```
public Rectangle(Rectangle rectangle)
```

Initializes a new instance of Rectangle class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangle. |

##### opEquality(Rectangle left, Rectangle right)
```
public static boolean opEquality(Rectangle left, Rectangle right)
```

Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Rectangle | A Rectangle to compare. |
| right | Rectangle | A Rectangle to compare. |

**Returns:**
boolean - true if the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values of left and right are equal; otherwise, false.
##### opInequality(Rectangle left, Rectangle right)
```
public static boolean opInequality(Rectangle left, Rectangle right)
```

Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Rectangle | A Rectangle to compare. |
| right | Rectangle | A Rectangle to compare. |

**Returns:**
boolean - true if the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values of left and right are not equal; otherwise, false.
##### equals(Rectangle obj1, Rectangle obj2)
```
public static boolean equals(Rectangle obj1, Rectangle obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | Rectangle |  |
| obj2 | Rectangle |  |

**Returns:**
boolean
##### getX()
```
public final float getX()
```

Gets or sets the x.

Value: The x.

**Returns:**
float -
##### setX(float value)
```
public final void setX(float value)
```

Gets or sets the x.

Value: The x.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getY()
```
public final float getY()
```

Gets or sets the y.

Value: The y.

**Returns:**
float -
##### setY(float value)
```
public final void setY(float value)
```

Gets or sets the y.

Value: The y.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getWidth()
```
public final float getWidth()
```

Gets or sets the width.

Value: The width.

**Returns:**
float -
##### setWidth(float value)
```
public final void setWidth(float value)
```

Gets or sets the width.

Value: The width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getHeight()
```
public final float getHeight()
```

Gets or sets the height.

Value: The height.

**Returns:**
float -
##### setHeight(float value)
```
public final void setHeight(float value)
```

Gets or sets the height.

Value: The height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified rectangle is equal to the current rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The rectangle to compare with the current rectangle. |

**Returns:**
boolean -   if the specified rectangle is equal to the current rectangle; otherwise,  .
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current rectangle.
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### Reply
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/reply.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.ICloneable, java.lang.Cloneable
```
public class Reply implements System.ICloneable, Cloneable
```

Represents annotation reply.
#### Constructors

| Constructor | Description |
| --- | --- |
| Reply() |  |
#### Methods

| Method | Description |
| --- | --- |
| getId() | Reply Id |
| setId(int value) | Reply Id |
| getUser() | Reply creator |
| setUser(User value) | Reply creator |
| getComment() | Reply comment |
| setComment(String value) | Reply comment |
| getRepliedOn() | Reply creation date |
| setRepliedOn(Date value) | Reply creation date |
| getParentReply() | Parent reply |
| setParentReply(Reply value) | Parent reply |
| deepClone() | Returns new Instance with same values |
| clone() |  |
| toString() |  |
##### Reply()
```
public Reply()
```

##### getId()
```
public final int getId()
```

Reply Id

**Returns:**
int -
##### setId(int value)
```
public final void setId(int value)
```

Reply Id

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getUser()
```
public final User getUser()
```

Reply creator

**Returns:**
User -
##### setUser(User value)
```
public final void setUser(User value)
```

Reply creator

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | User |  |

##### getComment()
```
public final String getComment()
```

Reply comment

**Returns:**
java.lang.String -
##### setComment(String value)
```
public final void setComment(String value)
```

Reply comment

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRepliedOn()
```
public final Date getRepliedOn()
```

Reply creation date

**Returns:**
java.util.Date -
##### setRepliedOn(Date value)
```
public final void setRepliedOn(Date value)
```

Reply creation date

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getParentReply()
```
public final Reply getParentReply()
```

Parent reply

**Returns:**
Reply -
##### setParentReply(Reply value)
```
public final void setParentReply(Reply value)
```

Parent reply

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Reply |  |

##### deepClone()
```
public final Object deepClone()
```

Returns new Instance with same values

**Returns:**
java.lang.Object -
##### clone()
```
public Object clone()
```

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### User
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.models/user.md

**Inheritance:**
java.lang.Object
```
public class User
```

Represents user properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| User() | Initializes new instance of User class. |
| User(int id, String name, Role role) | Initializes new instance of User class. |
#### Methods

| Method | Description |
| --- | --- |
| getId() | User Id |
| setId(int value) | User Id |
| getName() | User name |
| setName(String value) | User name |
| getEmail() | Email |
| setEmail(String value) | Email |
| getRole() | Role |
| setRole(Role value) | Role |
| toString() |  |
##### User()
```
public User()
```

Initializes new instance of User class.

##### User(int id, String name, Role role)
```
public User(int id, String name, Role role)
```

Initializes new instance of User class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int | The user id. |
| name | java.lang.String | The user name. |
| role | Role | The user role. |

##### getId()
```
public final int getId()
```

User Id

**Returns:**
int -
##### setId(int value)
```
public final void setId(int value)
```

User Id

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getName()
```
public final String getName()
```

User name

**Returns:**
java.lang.String -
##### setName(String value)
```
public final void setName(String value)
```

User name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Email

**Returns:**
java.lang.String -
##### setEmail(String value)
```
public final void setEmail(String value)
```

Email

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRole()
```
public final Role getRole()
```

Role

**Returns:**
Role -
##### setRole(Role value)
```
public final void setRole(Role value)
```

Role

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Role |  |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### com.groupdocs.annotation.options.export
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.export.md

The namespace provides classes to specify additional options when saving documents.

#### Classes

| Class | Description |
| --- | --- |
| AnnotationType | Annotation types |
| SaveOptions | Allows to specify additional options (such as password) when saving annotated document. |

### AnnotationType
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.export/annotationtype.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
```
public final class AnnotationType extends System.Enum
```

Annotation types
#### Fields

| Field | Description |
| --- | --- |
| NONE | Default value |
| AREA | The area annotation type that highlights rectangular area within the document page |
| ARROW | The annotation type that draws an arrow on the document page |
| DISTANCE | The annotation type that measures distance between elements of a document page |
| ELLIPSE | The annotation of elliptic form that marks parts of document content |
| LINK | The annotation type that represents a hyperlink to a remote resource |
| POINT | The point annotation type that sticks a comment to an any place within document page |
| POLYLINE | The polyline annotation type that allows add drawing shapes and freehand lines to a document page |
| RESOURCES_REDACTION | The annotation type that hides textual content behind black rectangle |
| TEXT_FIELD | The text field annotation type represents textual comment inside colored frame |
| TEXT_HIGHLIGHT | The annotation type that highlights and comments selected text |
| TEXT_REDACTION | The annotation type that fills part of selected text with black rectangle. |
| TEXT_REPLACEMENT | The annotation type that replaces original text with other provided text fragment |
| TEXT_STRIKEOUT | The annotation type that marks text fragment with a strikethrough styling |
| TEXT_UNDERLINE | The annotation type that marks text with a underline styling |
| WATERMARK | The annotation type that adds textual watermark over document page |
| IMAGE | The annotation type that adds image overlay over document page content |
| DROPDOWN | The component type that adds dropdown component for pdf document  **only**  |
| CHECKBOX | The annotation type that adds checkbox for pdf document |
| BUTTON | The annotation type that adds button for pdf document |
| TEXT_SQUIGGLY | The annotation type that squiggly and comments selected text |
| SEARCH_TEXT | The annotation type that search fragment text in document |
| ALL | All |
#### Methods

| Method | Description |
| --- | --- |
| numbers() |  |
| getName(int type) |  |
##### NONE
```
public static final int NONE
```

Default value

##### AREA
```
public static final int AREA
```

The area annotation type that highlights rectangular area within the document page

##### ARROW
```
public static final int ARROW
```

The annotation type that draws an arrow on the document page

##### DISTANCE
```
public static final int DISTANCE
```

The annotation type that measures distance between elements of a document page

##### ELLIPSE
```
public static final int ELLIPSE
```

The annotation of elliptic form that marks parts of document content

##### LINK
```
public static final int LINK
```

The annotation type that represents a hyperlink to a remote resource

##### POINT
```
public static final int POINT
```

The point annotation type that sticks a comment to an any place within document page

##### POLYLINE
```
public static final int POLYLINE
```

The polyline annotation type that allows add drawing shapes and freehand lines to a document page

##### RESOURCES_REDACTION
```
public static final int RESOURCES_REDACTION
```

The annotation type that hides textual content behind black rectangle

##### TEXT_FIELD
```
public static final int TEXT_FIELD
```

The text field annotation type represents textual comment inside colored frame

##### TEXT_HIGHLIGHT
```
public static final int TEXT_HIGHLIGHT
```

The annotation type that highlights and comments selected text

##### TEXT_REDACTION
```
public static final int TEXT_REDACTION
```

The annotation type that fills part of selected text with black rectangle.

##### TEXT_REPLACEMENT
```
public static final int TEXT_REPLACEMENT
```

The annotation type that replaces original text with other provided text fragment

##### TEXT_STRIKEOUT
```
public static final int TEXT_STRIKEOUT
```

The annotation type that marks text fragment with a strikethrough styling

##### TEXT_UNDERLINE
```
public static final int TEXT_UNDERLINE
```

The annotation type that marks text with a underline styling

##### WATERMARK
```
public static final int WATERMARK
```

The annotation type that adds textual watermark over document page

##### IMAGE
```
public static final int IMAGE
```

The annotation type that adds image overlay over document page content

##### DROPDOWN
```
public static final int DROPDOWN
```

The component type that adds dropdown component for pdf document  **only**

##### CHECKBOX
```
public static final int CHECKBOX
```

The annotation type that adds checkbox for pdf document

##### BUTTON
```
public static final int BUTTON
```

The annotation type that adds button for pdf document

##### TEXT_SQUIGGLY
```
public static final int TEXT_SQUIGGLY
```

The annotation type that squiggly and comments selected text

##### SEARCH_TEXT
```
public static final int SEARCH_TEXT
```

The annotation type that search fragment text in document

##### ALL
```
public static final int ALL
```

All

##### numbers()
```
public static int[] numbers()
```

**Returns:**
int[]
##### getName(int type)
```
public static String getName(int type)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | int |  |

**Returns:**
java.lang.String

### SaveOptions
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.export/saveoptions.md

**Inheritance:**
java.lang.Object
```
public class SaveOptions
```

Allows to specify additional options (such as password) when saving annotated document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAnnotationTypes() | Defines what annotations will be in resultant document. |
| setAnnotationTypes(int value) | Defines what annotations will be in resultant document. |
| getOnlyAnnotatedPages() | Indicates whether to save only annotated pages or not;. |
| setOnlyAnnotatedPages(boolean value) | Indicates whether to save only annotated pages or not;. |
| getFirstPage() | First page number when saving page range. |
| setFirstPage(int value) | First page number when saving page range. |
| getLastPage() | Last page number when saving page range. |
| setLastPage(int value) | Last page number when saving page range. |
| getVersion() | Version Key that will be used to access current version |
| setVersion(Object value) | Version Key that will be used to access current version |
##### SaveOptions()
```
public SaveOptions()
```

##### getAnnotationTypes()
```
public final int getAnnotationTypes()
```

Defines what annotations will be in resultant document.

**Returns:**
int -
##### setAnnotationTypes(int value)
```
public final void setAnnotationTypes(int value)
```

Defines what annotations will be in resultant document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getOnlyAnnotatedPages()
```
public final boolean getOnlyAnnotatedPages()
```

Indicates whether to save only annotated pages or not;.

**Returns:**
boolean -
##### setOnlyAnnotatedPages(boolean value)
```
public final void setOnlyAnnotatedPages(boolean value)
```

Indicates whether to save only annotated pages or not;.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFirstPage()
```
public final int getFirstPage()
```

First page number when saving page range.

**Returns:**
int -
##### setFirstPage(int value)
```
public final void setFirstPage(int value)
```

First page number when saving page range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLastPage()
```
public final int getLastPage()
```

Last page number when saving page range.

**Returns:**
int -
##### setLastPage(int value)
```
public final void setLastPage(int value)
```

Last page number when saving page range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVersion()
```
public final Object getVersion()
```

Version Key that will be used to access current version

**Returns:**
java.lang.Object -
##### setVersion(Object value)
```
public final void setVersion(Object value)
```

Version Key that will be used to access current version

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

### com.groupdocs.annotation.options.pagepreview
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.pagepreview.md

The namespace provides classes to preview document pages.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Delegate that defines method to create output page preview stream. |
| PreviewOptions | Represents document preview options. |
| ReleasePageStream | Delegate that defines method to release output page preview stream. |
| WorksheetColumnsRange | Represents a range of columns for a specified worksheet |

#### Interfaces

| Interface | Description |
| --- | --- |
| PageStreamFactory | Interface that defines method to create / release output page preview stream. |

### CreatePageStream
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.pagepreview/createpagestream.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class CreatePageStream extends System.MulticastDelegate
```

Delegate that defines method to create output page preview stream.
#### Constructors

| Constructor | Description |
| --- | --- |
| CreatePageStream() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(int pageNumber) |  |
| beginInvoke(int pageNumber, System.AsyncCallback callback, Object state) |  |
| endInvoke(System.IAsyncResult result) |  |
##### CreatePageStream()
```
public CreatePageStream()
```

##### invoke(int pageNumber)
```
public abstract OutputStream invoke(int pageNumber)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |

**Returns:**
java.io.OutputStream
##### beginInvoke(int pageNumber, System.AsyncCallback callback, Object state)
```
public final System.IAsyncResult beginInvoke(int pageNumber, System.AsyncCallback callback, Object state)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |
| callback | com.aspose.ms.System.AsyncCallback |  |
| state | java.lang.Object |  |

**Returns:**
com.aspose.ms.System.IAsyncResult
##### endInvoke(System.IAsyncResult result)
```
public final OutputStream endInvoke(System.IAsyncResult result)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| result | com.aspose.ms.System.IAsyncResult |  |

**Returns:**
java.io.OutputStream

### PageStreamFactory
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.pagepreview/pagestreamfactory.md

### PreviewOptions
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.pagepreview/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Represents document preview options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(CreatePageStream createPageStream) | Initializes a new instance of PreviewOptions class. |
| PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of PreviewOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getCreatePageStream() | Delegate which defines method to create output page preview stream. |
| setCreatePageStream(CreatePageStream value) | Delegate which defines method to create output page preview stream. |
| getReleasePageStream() | Delegate which defines method to remove output page preview stream |
| setReleasePageStream(ReleasePageStream value) | Delegate which defines method to remove output page preview stream |
| getWidth() | Page preview width. |
| setWidth(int value) | Page preview width. |
| getHeight() | Page preview height. |
| setHeight(int value) | Page preview height. |
| getPageNumbers() | Page numbers that will be previewed. |
| setPageNumbers(int[] value) | Page numbers that will be previewed. |
| getPreviewFormat() | Preview image format. |
| setPreviewFormat(int value) | Preview image format. |
| getResolution() |  |
| setResolution(int value) |  |
| getRenderComments() | The property that controls whether comments will be generated on the preview. |
| setRenderComments(boolean value) | The property that controls whether comments will be generated on the preview. |
| getRenderAnnotations() | The property that controls whether annotations will be generated on the preview. |
| setRenderAnnotations(boolean value) | The property that controls whether annotations will be generated on the preview. |
| getWorksheetColumns() | Worksheet columns to generate. |
| getWorksheetColumnsInternal() |  |
| setWorksheetColumns(List<WorksheetColumnsRange> value) | Worksheet columns to generate. |
| setWorksheetColumnsInternal(System.Collections.Generic.List<WorksheetColumnsRange> value) |  |
##### PreviewOptions(CreatePageStream createPageStream)
```
public PreviewOptions(CreatePageStream createPageStream)
```

Initializes a new instance of PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |

##### PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |
| releasePageStream | ReleasePageStream | Delegate which defines method to release output page preview stream. |

##### getCreatePageStream()
```
public final CreatePageStream getCreatePageStream()
```

Delegate which defines method to create output page preview stream.

**Returns:**
CreatePageStream -
##### setCreatePageStream(CreatePageStream value)
```
public final void setCreatePageStream(CreatePageStream value)
```

Delegate which defines method to create output page preview stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | CreatePageStream |  |

##### getReleasePageStream()
```
public final ReleasePageStream getReleasePageStream()
```

Delegate which defines method to remove output page preview stream

**Returns:**
ReleasePageStream -
##### setReleasePageStream(ReleasePageStream value)
```
public final void setReleasePageStream(ReleasePageStream value)
```

Delegate which defines method to remove output page preview stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ReleasePageStream |  |

##### getWidth()
```
public final int getWidth()
```

Page preview width.

**Returns:**
int -
##### setWidth(int value)
```
public final void setWidth(int value)
```

Page preview width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Page preview height.

**Returns:**
int -
##### setHeight(int value)
```
public final void setHeight(int value)
```

Page preview height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Page numbers that will be previewed.

**Returns:**
int[] -
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Page numbers that will be previewed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] |  |

##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Preview image format.

**Returns:**
int -
##### setPreviewFormat(int value)
```
public final void setPreviewFormat(int value)
```

Preview image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getResolution()
```
public int getResolution()
```

**Returns:**
int
##### setResolution(int value)
```
public void setResolution(int value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRenderComments()
```
public final boolean getRenderComments()
```

The property that controls whether comments will be generated on the preview. Default State - true. Now Supported only in MS Word document

**Returns:**
boolean -
##### setRenderComments(boolean value)
```
public final void setRenderComments(boolean value)
```

The property that controls whether comments will be generated on the preview. Default State - true. Now Supported only in MS Word document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRenderAnnotations()
```
public final boolean getRenderAnnotations()
```

The property that controls whether annotations will be generated on the preview. Default State - true.

**Returns:**
boolean -
##### setRenderAnnotations(boolean value)
```
public final void setRenderAnnotations(boolean value)
```

The property that controls whether annotations will be generated on the preview. Default State - true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getWorksheetColumns()
```
public final List<WorksheetColumnsRange> getWorksheetColumns()
```

Worksheet columns to generate. Generation proceeds in the specified order.

**Returns:**
java.util.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> -
##### getWorksheetColumnsInternal()
```
public System.Collections.Generic.List<WorksheetColumnsRange> getWorksheetColumnsInternal()
```

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange>
##### setWorksheetColumns(List<WorksheetColumnsRange> value)
```
public final void setWorksheetColumns(List<WorksheetColumnsRange> value)
```

Worksheet columns to generate. Generation proceeds in the specified order.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> |  |

##### setWorksheetColumnsInternal(System.Collections.Generic.List<WorksheetColumnsRange> value)
```
public void setWorksheetColumnsInternal(System.Collections.Generic.List<WorksheetColumnsRange> value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> |  |

### ReleasePageStream
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.pagepreview/releasepagestream.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ReleasePageStream extends System.MulticastDelegate
```

Delegate that defines method to release output page preview stream.
#### Constructors

| Constructor | Description |
| --- | --- |
| ReleasePageStream() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(int pageNumber, OutputStream pageStream) |  |
| beginInvoke(int pageNumber, OutputStream pageStream, System.AsyncCallback callback, Object state) |  |
| endInvoke(System.IAsyncResult result) |  |
##### ReleasePageStream()
```
public ReleasePageStream()
```

##### invoke(int pageNumber, OutputStream pageStream)
```
public abstract void invoke(int pageNumber, OutputStream pageStream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |
| pageStream | java.io.OutputStream |  |

##### beginInvoke(int pageNumber, OutputStream pageStream, System.AsyncCallback callback, Object state)
```
public final System.IAsyncResult beginInvoke(int pageNumber, OutputStream pageStream, System.AsyncCallback callback, Object state)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |
| pageStream | java.io.OutputStream |  |
| callback | com.aspose.ms.System.AsyncCallback |  |
| state | java.lang.Object |  |

**Returns:**
com.aspose.ms.System.IAsyncResult
##### endInvoke(System.IAsyncResult result)
```
public final void endInvoke(System.IAsyncResult result)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| result | com.aspose.ms.System.IAsyncResult |  |

### WorksheetColumnsRange
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.pagepreview/worksheetcolumnsrange.md

**Inheritance:**
java.lang.Object
```
public class WorksheetColumnsRange
```

Represents a range of columns for a specified worksheet
#### Constructors

| Constructor | Description |
| --- | --- |
| WorksheetColumnsRange(int worksheetIndex, int firstColumn, int lastColumn) | Initializes a new instance of WorksheetColumnsRange class. |
| WorksheetColumnsRange(String worksheetName, int firstColumn, int lastColumn) | Initializes a new instance of WorksheetColumnsRange class. |
#### Fields

| Field | Description |
| --- | --- |
| firstColumn |  |
| lastColumn |  |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheetIndex() |  |
| getWorksheetName() |  |
##### WorksheetColumnsRange(int worksheetIndex, int firstColumn, int lastColumn)
```
public WorksheetColumnsRange(int worksheetIndex, int firstColumn, int lastColumn)
```

Initializes a new instance of WorksheetColumnsRange class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | int | Worksheet index |
| firstColumn | int | First column |
| lastColumn | int | Last column |

##### WorksheetColumnsRange(String worksheetName, int firstColumn, int lastColumn)
```
public WorksheetColumnsRange(String worksheetName, int firstColumn, int lastColumn)
```

Initializes a new instance of WorksheetColumnsRange class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheetName | java.lang.String | Worksheet name |
| firstColumn | int | First column |
| lastColumn | int | Last column |

##### firstColumn
```
public final int firstColumn
```

##### lastColumn
```
public final int lastColumn
```

##### getWorksheetIndex()
```
public int getWorksheetIndex()
```

**Returns:**
int
##### getWorksheetName()
```
public String getWorksheetName()
```

**Returns:**
java.lang.String

### com.groupdocs.annotation.options
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options.md

The namespace provides classes to specify additional options when loading, annotating and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Allows to specify additional options (such as password) when opening a document to annotate. |

#### Enumerations

| Enum | Description |
| --- | --- |
| FileType | Information about file, such as type, extension, etc. |

### FileType
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options/filetype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public enum FileType extends Enum<FileType> implements System.IEquatable<FileType>
```

Information about file, such as type, extension, etc.
#### Fields

| Field | Description |
| --- | --- |
| UNKNOWN | Unknown. |
| DOC | Microsoft Word format. |
| DOCX | Microsoft Word Open XML format. |
| DOCM | Microsoft Word 2007 Macro file. |
| DOT | Microsoft Word Document Template. |
| DOTX | Microsoft Word Template. |
| DOTM | Microsoft Word Macro-Enabled Document Template. |
| RTF | Rich Text Format File. |
| ODT | Open Document Text. |
| XLS | Microsoft Excel Spreadsheet format. |
| XLSX | Microsoft Excel Open XML Spreadsheet. |
| XLSM | Microsoft Excel Spreadsheet Macros format |
| XLSB | Excel Binary File Format |
| ODS | OpenDocument Spreadsheet Document format |
| PPT | Microsoft PowerPoint Presentation. |
| PPTX | Microsoft PowerPoint Open XML Presentation. |
| PPS | Microsoft PowerPoint Slide Show (Legacy). |
| PPSX | Microsoft PowerPoint Slide Show. |
| ODP | Open Document Presentation. |
| TIF | Tagged Image File. |
| TIFF | Tagged Image File Format |
| JPEG | Joint Photographic Experts Group. |
| JPG | Joint Photographic Experts Group. |
| PNG | Portable Network Graphic File. |
| BMP | Bitmap Image File. |
| DWG | AutoCAD Drawing Database File. |
| DXF | Drawing Exchange Format File. |
| PDF | Adobe Portable Document format. |
| HTM | Hypertext Markup Language File. |
| HTML | Hypertext Markup Language File. |
| EML | File in the MIME standard. |
| EMLX | Apple's Mail.app program file format. |
| VSD | Microsoft Visio VSD binary format. |
| VSDX | Microsoft Visio 2013 VSDX file format. |
| VSDM | Microsoft Visio Macro-Enabled Drawing. |
| VSS | Microsoft Visio Stencil File. |
| VSX | Microsoft Visio Stencil XML File. |
| VSSX | Microsoft Visio Stencil File. |
| VST | Microsoft Visio VST binary template format. |
| VSTM | Microsoft Visio Macro-Enabled Drawing Template. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromFileNameOrExtension(String fileNameOrExtension) | Return FileType based on file name or extension. |
| getSupportedFileTypes() | Get supported file types enumeration. |
| fromFoundationFileType(int foundationFileType) |  |
| getFileFormat() | File format |
| getExtension() | File extention |
| typeEquals(FileType other) | File type equivalence check. |
| opEquality(FileType left, FileType right) | Operator overload. |
| opInequality(FileType left, FileType right) | Operator overload. |
| toString() | Returns a string that represents the file type. |
##### UNKNOWN
```
public static final FileType UNKNOWN
```

Unknown.

##### DOC
```
public static final FileType DOC
```

Microsoft Word format.

##### DOCX
```
public static final FileType DOCX
```

Microsoft Word Open XML format.

##### DOCM
```
public static final FileType DOCM
```

Microsoft Word 2007 Macro file.

##### DOT
```
public static final FileType DOT
```

Microsoft Word Document Template.

##### DOTX
```
public static final FileType DOTX
```

Microsoft Word Template.

##### DOTM
```
public static final FileType DOTM
```

Microsoft Word Macro-Enabled Document Template.

##### RTF
```
public static final FileType RTF
```

Rich Text Format File.

##### ODT
```
public static final FileType ODT
```

Open Document Text.

##### XLS
```
public static final FileType XLS
```

Microsoft Excel Spreadsheet format.

##### XLSX
```
public static final FileType XLSX
```

Microsoft Excel Open XML Spreadsheet.

##### XLSM
```
public static final FileType XLSM
```

Microsoft Excel Spreadsheet Macros format

##### XLSB
```
public static final FileType XLSB
```

Excel Binary File Format

##### ODS
```
public static final FileType ODS
```

OpenDocument Spreadsheet Document format

##### PPT
```
public static final FileType PPT
```

Microsoft PowerPoint Presentation.

##### PPTX
```
public static final FileType PPTX
```

Microsoft PowerPoint Open XML Presentation.

##### PPS
```
public static final FileType PPS
```

Microsoft PowerPoint Slide Show (Legacy).

##### PPSX
```
public static final FileType PPSX
```

Microsoft PowerPoint Slide Show.

##### ODP
```
public static final FileType ODP
```

Open Document Presentation.

##### TIF
```
public static final FileType TIF
```

Tagged Image File.

##### TIFF
```
public static final FileType TIFF
```

Tagged Image File Format

##### JPEG
```
public static final FileType JPEG
```

Joint Photographic Experts Group.

##### JPG
```
public static final FileType JPG
```

Joint Photographic Experts Group.

##### PNG
```
public static final FileType PNG
```

Portable Network Graphic File.

##### BMP
```
public static final FileType BMP
```

Bitmap Image File.

##### DWG
```
public static final FileType DWG
```

AutoCAD Drawing Database File.

##### DXF
```
public static final FileType DXF
```

Drawing Exchange Format File.

##### PDF
```
public static final FileType PDF
```

Adobe Portable Document format.

##### HTM
```
public static final FileType HTM
```

Hypertext Markup Language File.

##### HTML
```
public static final FileType HTML
```

Hypertext Markup Language File.

##### EML
```
public static final FileType EML
```

File in the MIME standard.

##### EMLX
```
public static final FileType EMLX
```

Apple's Mail.app program file format.

##### VSD
```
public static final FileType VSD
```

Microsoft Visio VSD binary format.

##### VSDX
```
public static final FileType VSDX
```

Microsoft Visio 2013 VSDX file format.

##### VSDM
```
public static final FileType VSDM
```

Microsoft Visio Macro-Enabled Drawing.

##### VSS
```
public static final FileType VSS
```

Microsoft Visio Stencil File.

##### VSX
```
public static final FileType VSX
```

Microsoft Visio Stencil XML File.

##### VSSX
```
public static final FileType VSSX
```

Microsoft Visio Stencil File.

##### VST
```
public static final FileType VST
```

Microsoft Visio VST binary template format.

##### VSTM
```
public static final FileType VSTM
```

Microsoft Visio Macro-Enabled Drawing Template.

##### values()
```
public static FileType[] values()
```

**Returns:**
com.groupdocs.annotation.options.FileType[]
##### valueOf(String name)
```
public static FileType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileType
##### fromFileNameOrExtension(String fileNameOrExtension)
```
public static FileType fromFileNameOrExtension(String fileNameOrExtension)
```

Return FileType based on file name or extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileNameOrExtension | java.lang.String | The file name or file extension. |

**Returns:**
FileType - The file type.
##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Get supported file types enumeration.

**Returns:**
java.util.List<com.groupdocs.annotation.options.FileType> - Enumeration of FileType.
##### fromFoundationFileType(int foundationFileType)
```
public static FileType fromFoundationFileType(int foundationFileType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| foundationFileType | int |  |

**Returns:**
FileType
##### getFileFormat()
```
public final String getFileFormat()
```

File format

**Returns:**
java.lang.String -
##### getExtension()
```
public final String getExtension()
```

File extention

**Returns:**
java.lang.String -
##### typeEquals(FileType other)
```
public final boolean typeEquals(FileType other)
```

File type equivalence check.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | FileType object. |

**Returns:**
boolean - True if file types are equivalent, false if not.
##### opEquality(FileType left, FileType right)
```
public static boolean opEquality(FileType left, FileType right)
```

Operator overload.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | The left file type. |
| right | FileType | The right file type. |

**Returns:**
boolean - True if file types are equivalent, false if not.
##### opInequality(FileType left, FileType right)
```
public static boolean opInequality(FileType left, FileType right)
```

Operator overload.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | The left file type. |
| right | FileType | The right file type. |

**Returns:**
boolean - True if file types are different, false if not.
##### toString()
```
public String toString()
```

Returns a string that represents the file type.

**Returns:**
java.lang.String - A string that represents the file type.

### LoadOptions
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Allows to specify additional options (such as password) when opening a document to annotate.
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Document password |
| setPassword(String value) | Document password |
| getVersion() | Sets what version of document will be load. |
| setVersion(Object value) | Sets what version of document will be load. |
| getFontDirectories() | List of font directories to load custom fonts from |
| setFontDirectories(List<String> value) | List of font directories to load custom fonts from |
##### LoadOptions()
```
public LoadOptions()
```

##### getPassword()
```
public final String getPassword()
```

Document password

**Returns:**
java.lang.String -
##### setPassword(String value)
```
public final void setPassword(String value)
```

Document password

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVersion()
```
public final Object getVersion()
```

Sets what version of document will be load. Default State - last

**Returns:**
java.lang.Object -
##### setVersion(Object value)
```
public final void setVersion(Object value)
```

Sets what version of document will be load. Default State - last

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### getFontDirectories()
```
public final List<String> getFontDirectories()
```

List of font directories to load custom fonts from

**Returns:**
java.util.List<java.lang.String> -
##### setFontDirectories(List<String> value)
```
public final void setFontDirectories(List<String> value)
```

List of font directories to load custom fonts from

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

### com.groupdocs.annotation
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation.md

The namespace provides classes to annotate documents for all popular document formats.

The Main classes in this namespace are:

 *  Annotator is the entry point for annotating documents.
 *  AnnotatorSettings provides an easy way to customize caching, logging behaviour etc.
 *  Document provides details about a document.

The main class of this namespace is Annotator. This class provides methods for annotating document.

#### Classes

| Class | Description |
| --- | --- |
| Annotator | Represents main class that controls document annotating process. |
| AnnotatorSettings | Defines settings for customizing Annotator behavior. |
| Document | Represents document properties |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Information about document |

### Annotator
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation/annotator.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IDisposable, java.io.Closeable
```
public class Annotator implements System.IDisposable, Closeable
```

Represents main class that controls document annotating process.
#### Constructors

| Constructor | Description |
| --- | --- |
| Annotator(String filePath) | Initialise annotator class which accept document path |
| Annotator(String filePath, LoadOptions loadOptions) | Initialise annotator class which accept document path |
| Annotator(String filePath, AnnotatorSettings settings) | Initialise annotator class which accept document path |
| Annotator(String filePath, LoadOptions loadOptions, AnnotatorSettings settings) | Initialise annotator class which accept document path |
| Annotator(InputStream inputStream) | Initialise annotator class which accept document stream |
| Annotator(InputStream inputStream, LoadOptions loadOptions) | Initialise annotator class which accept document stream |
| Annotator(InputStream inputStream, AnnotatorSettings settings) | Initialise annotator class which accept document stream |
| Annotator(InputStream inputStream, LoadOptions loadOptions, AnnotatorSettings settings) | Initialise annotator class which accept inputStream stream |
#### Methods

| Method | Description |
| --- | --- |
| getDocument() | Document |
| getRotation() | Document Rotation |
| setRotation(Byte value) | Document Rotation |
| getProcessPages() | Document pages |
| setProcessPages(int value) | Document pages |
| save() | Saves document after adding, updating or removing annotations. |
| save(SaveOptions saveOptions) | Saves document after adding, updating or removing annotations. |
| save(OutputStream document) | Saves document after adding, updating or removing annotations. |
| save(String filePath) | Saves document after adding, updating or removing annotations. |
| save(OutputStream outputStream, SaveOptions saveOptions) | Saves outputStream after adding, updating or removing annotations. |
| save(String filePath, SaveOptions saveOptions) | Saves document after adding, updating or removing annotations. |
| dispose() | Dispose |
| add(AnnotationBase annotation) | Adds annotation to document |
| add(List<AnnotationBase> annotations) | Adds collection of annotations to a document. |
| update(AnnotationBase newAnnotation) | Updates document annotation. |
| update(List<AnnotationBase> annotations) | Updates collection of document annotations. |
| remove(int annotationId) | Removes annotation from document by Id. |
| remove(AnnotationBase annotation) | Removes annotation from document. |
| remove(AnnotationBase[] annotationsToDelete) | Removes collection of annotations from document by provided annotation ids. |
| remove(List<Integer> annotationsIdsToDelete) | Removes collection of annotations from document by provided annotation ids. |
| removeInternal(List<AnnotationBase> annotationsToDelete) | Removes collection of annotations from document. |
| get() | Gets collections of document annotations. |
| getVersionsList() | Get versions. |
| getVersion(Object version) | Get annotations from versions. |
| get(int type) | Gets collection of document annotations by annotation type. |
| importAnnotationsFromDocument(String outputPath) | Import annotations from document to XML file. |
| exportAnnotationsFromDocument(String filePath) | Export annotations from XML document. |
| close() |  |
##### Annotator(String filePath)
```
public Annotator(String filePath)
```

Initialise annotator class which accept document path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path

##### Annotator(String filePath, LoadOptions loadOptions)
```
public Annotator(String filePath, LoadOptions loadOptions)
```

Initialise annotator class which accept document path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path |
| loadOptions | LoadOptions | Load options

##### Annotator(String filePath, AnnotatorSettings settings)
```
public Annotator(String filePath, AnnotatorSettings settings)
```

Initialise annotator class which accept document path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path |
| settings | AnnotatorSettings | Annotator settings

##### Annotator(String filePath, LoadOptions loadOptions, AnnotatorSettings settings)
```
public Annotator(String filePath, LoadOptions loadOptions, AnnotatorSettings settings)
```

Initialise annotator class which accept document path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path |
| loadOptions | LoadOptions | Load options |
| settings | AnnotatorSettings | Annotator settings

##### Annotator(InputStream inputStream)
```
public Annotator(InputStream inputStream)
```

Initialise annotator class which accept document stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | Document stream

##### Annotator(InputStream inputStream, LoadOptions loadOptions)
```
public Annotator(InputStream inputStream, LoadOptions loadOptions)
```

Initialise annotator class which accept document stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | Document stream |
| loadOptions | LoadOptions | Load options

##### Annotator(InputStream inputStream, AnnotatorSettings settings)
```
public Annotator(InputStream inputStream, AnnotatorSettings settings)
```

Initialise annotator class which accept document stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | Document stream |
| settings | AnnotatorSettings | Annotator settings

##### Annotator(InputStream inputStream, LoadOptions loadOptions, AnnotatorSettings settings)
```
public Annotator(InputStream inputStream, LoadOptions loadOptions, AnnotatorSettings settings)
```

Initialise annotator class which accept inputStream stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | Document stream |
| loadOptions | LoadOptions | Load options |
| settings | AnnotatorSettings | Annotator settings

##### getDocument()
```
public final Document getDocument()
```

Document

**Returns:**
Document -
##### getRotation()
```
public final Byte getRotation()
```

Document Rotation

**Returns:**
java.lang.Byte -
##### setRotation(Byte value)
```
public final void setRotation(Byte value)
```

Document Rotation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### getProcessPages()
```
public final int getProcessPages()
```

Document pages

**Returns:**
int -
##### setProcessPages(int value)
```
public final void setProcessPages(int value)
```

Document pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### save()
```
public final void save()
```

Saves document after adding, updating or removing annotations.

 **Learn more about saving annotated documents**

 *
 *
 *

##### save(SaveOptions saveOptions)
```
public final void save(SaveOptions saveOptions)
```

Saves document after adding, updating or removing annotations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | SaveOptions | The save options.

 **Learn more about saving annotated documents**

 *
 *
 *   |

##### save(OutputStream document)
```
public final void save(OutputStream document)
```

Saves document after adding, updating or removing annotations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output stream.

 **Learn more about saving annotated documents**

 *
 *
 *   |

##### save(String filePath)
```
public final void save(String filePath)
```

Saves document after adding, updating or removing annotations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.

 **Learn more about saving annotated documents**

 *
 *
 *   |

##### save(OutputStream outputStream, SaveOptions saveOptions)
```
public final void save(OutputStream outputStream, SaveOptions saveOptions)
```

Saves outputStream after adding, updating or removing annotations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | java.io.OutputStream | The output stream. |
| saveOptions | SaveOptions | The save options.

 **Learn more about saving annotated documents**

 *
 *
 *   |

##### save(String filePath, SaveOptions saveOptions)
```
public final void save(String filePath, SaveOptions saveOptions)
```

Saves document after adding, updating or removing annotations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| saveOptions | SaveOptions | The save options.

 **Learn more about saving annotated documents**

 *
 *
 *   |

##### dispose()
```
public final void dispose()
```

Dispose

##### add(AnnotationBase annotation)
```
public final void add(AnnotationBase annotation)
```

Adds annotation to document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotation | AnnotationBase | The annotation to add.

##### add(List<AnnotationBase> annotations)
```
public final void add(List<AnnotationBase> annotations)
```

Adds collection of annotations to a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotations | java.util.List<com.groupdocs.annotation.models.annotationmodels.AnnotationBase> | The annotations list to add.

##### update(AnnotationBase newAnnotation)
```
public final void update(AnnotationBase newAnnotation)
```

Updates document annotation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newAnnotation | AnnotationBase | The annotation to update (Id should be provided).

##### update(List<AnnotationBase> annotations)
```
public final void update(List<AnnotationBase> annotations)
```

Updates collection of document annotations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotations | java.util.List<com.groupdocs.annotation.models.annotationmodels.AnnotationBase> | The annotations list that will be set.

##### remove(int annotationId)
```
public final void remove(int annotationId)
```

Removes annotation from document by Id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotationId | int | The annotation's id that must be removed.

##### remove(AnnotationBase annotation)
```
public final void remove(AnnotationBase annotation)
```

Removes annotation from document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotation | AnnotationBase | Annotation that must be removed.

##### remove(AnnotationBase[] annotationsToDelete)
```
public final void remove(AnnotationBase[] annotationsToDelete)
```

Removes collection of annotations from document by provided annotation ids.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotationsToDelete | AnnotationBase\[\] | The annotation's id that must be removed.

##### remove(List<Integer> annotationsIdsToDelete)
```
public final void remove(List<Integer> annotationsIdsToDelete)
```

Removes collection of annotations from document by provided annotation ids.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotationsIdsToDelete | java.util.List<java.lang.Integer> | The annotation's id that must be removed.

##### removeInternal(List<AnnotationBase> annotationsToDelete)
```
public final void removeInternal(List<AnnotationBase> annotationsToDelete)
```

Removes collection of annotations from document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotationsToDelete | java.util.List<com.groupdocs.annotation.models.annotationmodels.AnnotationBase> | The annotations that must be removed.

##### get()
```
public final List<AnnotationBase> get()
```

Gets collections of document annotations.

**Returns:**
java.util.List<com.groupdocs.annotation.models.annotationmodels.AnnotationBase> - The list of annotations.

##### getVersionsList()
```
public final List<Object> getVersionsList()
```

Get versions.

**Returns:**
java.util.List<java.lang.Object> - The list of versions.
##### getVersion(Object version)
```
public final List<AnnotationBase> getVersion(Object version)
```

Get annotations from versions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| version | java.lang.Object | The version's Key of versions which you want to return |

**Returns:**
java.util.List<com.groupdocs.annotation.models.annotationmodels.AnnotationBase> - The list of annotations from specific versions. If null will return last.
##### get(int type)
```
public final List<AnnotationBase> get(int type)
```

Gets collection of document annotations by annotation type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | int | The annotations type that must be returned.

**Returns:**
java.util.List<com.groupdocs.annotation.models.annotationmodels.AnnotationBase> - The list of annotations by type.
##### importAnnotationsFromDocument(String outputPath)
```
public final void importAnnotationsFromDocument(String outputPath)
```

Import annotations from document to XML file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputPath | java.lang.String | The output file path.

##### exportAnnotationsFromDocument(String filePath)
```
public final void exportAnnotationsFromDocument(String filePath)
```

Export annotations from XML document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The input file path.

##### close()
```
public void close()
```

### AnnotatorSettings
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation/annotatorsettings.md

**Inheritance:**
java.lang.Object
```
public class AnnotatorSettings
```

Defines settings for customizing Annotator behavior.
#### Constructors

| Constructor | Description |
| --- | --- |
| AnnotatorSettings() |  |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | Logger |
| setLogger(ILogger value) | Logger |
| getCache() | Cache |
| setCache(ICache value) | Cache |
##### AnnotatorSettings()
```
public AnnotatorSettings()
```

##### getLogger()
```
public final ILogger getLogger()
```

Logger

**Returns:**
com.groupdocs.foundation.logging.ILogger -
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

Logger

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.groupdocs.foundation.logging.ILogger |  |

##### getCache()
```
public final ICache getCache()
```

Cache

**Returns:**
ICache -
##### setCache(ICache value)
```
public final void setCache(ICache value)
```

Cache

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICache |  |

### Document
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation/document.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Document implements Closeable
```

Represents document properties
#### Constructors

| Constructor | Description |
| --- | --- |
| Document(InputStream stream) | Initializes new instance of Document class. |
| Document(InputStream stream, String password) | Initializes new instance of Document class. |
#### Methods

| Method | Description |
| --- | --- |
| setCache(ICache value) |  |
| getName() | Document name |
| setName(String value) | Document name |
| getStreamSize() | Document size |
| createStream() | Creates Document input stream |
| getPassword() | Document password |
| setPassword(String value) |  |
| getRotation() | Document Rotation |
| setRotation(Byte value) | Document Rotation |
| getProcessPages() | Document pages |
| setProcessPages(int value) | Document pages |
| generatePreview(PreviewOptions previewOptions) | Generates document pages preview. |
| getDocumentInfo() | Gets information about document - document type and size, pages count etc. |
| close() |  |
| addImageToDocument(String dataDir, String jpgFileName, int pageNumber, int imageQuality) | Change image quality and add image to document |
##### Document(InputStream stream)
```
public Document(InputStream stream)
```

Initializes new instance of Document class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The document stream. |

##### Document(InputStream stream, String password)
```
public Document(InputStream stream, String password)
```

Initializes new instance of Document class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The document stream. |
| password | java.lang.String | The document password. |

##### setCache(ICache value)
```
public final void setCache(ICache value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICache |  |

##### getName()
```
public final String getName()
```

Document name

**Returns:**
java.lang.String -
##### setName(String value)
```
public final void setName(String value)
```

Document name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStreamSize()
```
public final long getStreamSize()
```

Document size

**Returns:**
long -
##### createStream()
```
public final InputStream createStream()
```

Creates Document input stream

**Returns:**
java.io.InputStream
##### getPassword()
```
public final String getPassword()
```

Document password

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRotation()
```
public final Byte getRotation()
```

Document Rotation

**Returns:**
java.lang.Byte -
##### setRotation(Byte value)
```
public final void setRotation(Byte value)
```

Document Rotation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte |  |

##### getProcessPages()
```
public final int getProcessPages()
```

Document pages

**Returns:**
int -
##### setProcessPages(int value)
```
public final void setProcessPages(int value)
```

Document pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Generates document pages preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The document preview options |

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets information about document - document type and size, pages count etc.

**Returns:**
IDocumentInfo -
##### close()
```
public void close()
```

##### addImageToDocument(String dataDir, String jpgFileName, int pageNumber, int imageQuality)
```
public void addImageToDocument(String dataDir, String jpgFileName, int pageNumber, int imageQuality)
```

Change image quality and add image to document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataDir | java.lang.String | Specify the path to the input PDF file |
| jpgFileName | java.lang.String | The path to the JPG file |
| pageNumber | int | Page where the image will be inserted |
| imageQuality | int | Set image quality from 1 to 100, "1" - is the smallest resolution "100" - is the largest |

### IDocumentInfo
Path: https://reference.groupdocs.com/annotation/java/com.groupdocs.annotation/idocumentinfo.md

## .NET

### GroupDocs.Annotation for .NET
Path: https://reference.groupdocs.com/annotation/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Annotation | The namespace provides classes to annotate documents for all popular document formats. |
| GroupDocs.Annotation.Cache | The namespace provides classes for customizing caching behaviour. |
| GroupDocs.Annotation.Exceptions | The namespace contains all the exceptions used in GroupDocs.Annotation API. |
| GroupDocs.Annotation.Localization | The namespace provides classes checking supported locales. |
| GroupDocs.Annotation.Logging | The namespace provides classes for working with integrated or your own logger. |
| GroupDocs.Annotation.Models | The namespace contains various of annotation models |
| GroupDocs.Annotation.Models.AnnotationModels | The namespace provides annotation models data classes. |
| GroupDocs.Annotation.Models.AnnotationModels.Interfaces.Annotations | The namespace provides annotation models interfaces. |
| GroupDocs.Annotation.Models.AnnotationModels.Interfaces.Properties | The namespace provides annotation properties interfaces. |
| GroupDocs.Annotation.Models.FormatSpecificComponents.Pdf | The namespace provides format specific component models |
| GroupDocs.Annotation.Models.FormatSpecificComponents.Pdf.Interfaces | The namespace provides format specific component interfaces |
| GroupDocs.Annotation.Options | The namespace provides classes to specify additional options when loading, annotating and saving documents. |
| GroupDocs.Annotation.Projects.Cells.Models | The namespace provides classes to store information about the text |
| GroupDocs.Annotation.Projects.Diagram.Models | The namespace provides classes to store information about the text, annotated fragments, char state |
| GroupDocs.Annotation.Projects.Images.Models | The namespace provides classes of bytes with a specific offset in the byte array. |
| GroupDocs.Annotation.Projects.Pdf.Models | The namespace provides a class to represent the default state model for text in a PDF document |
| GroupDocs.Annotation.Projects.Slides.Models | The namespace provides classes to store information about the text |
| GroupDocs.Annotation.Utility |  |

### GroupDocs.Annotation.Cache
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache.md

The namespace provides classes for customizing caching behaviour.

#### Classes

| Class | Description |
| --- | --- |
| FileCache | Class that allows to work with the local on-disk cache. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICache | Defines methods required for storing rendered document and document resources cache. |

### Class FileCache
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/filecache.md

#### FileCache class

Class that allows to work with the local on-disk cache.

```csharp
public class FileCache : ICache
```

#### Constructors

| Name | Description |
| --- | --- |
| FileCache() | Initializes new instance of `FileCache` class. |
| FileCache(string) | Initializes new instance of `FileCache` class. |

#### Methods

| Name | Description |
| --- | --- |
| GetKeys(string) | Returns all file names that contains filter in filename. |
| Set(string, object) | Serializes data to the local disk. |
| TryGetValue(string, out object) | Deserializes data associated with this key if present. |

### FileCache.FileCache
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/filecache/filecache.md

#### FileCache()

Initializes new instance of `FileCache` class.

```csharp
public FileCache()
```

#### FileCache(string)

Initializes new instance of `FileCache` class.

```csharp
public FileCache(string path)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | Path where cache data will be saved |

### FileCache.GetKeys
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/filecache/getkeys.md

#### FileCache.GetKeys method

Returns all file names that contains filter in filename.

```csharp
public IEnumerable<string> GetKeys(string filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | String | The filter to use. |

##### Return Value

File names that contains filter in filename.

### FileCache.Set
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/filecache/set.md

#### FileCache.Set method

Serializes data to the local disk.

```csharp
public void Set(string key, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | An unique identifier for the cache entry. |
| value | Object | The object to serialize. |

### FileCache.TryGetValue
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/filecache/trygetvalue.md

#### FileCache.TryGetValue method

Deserializes data associated with this key if present.

```csharp
public bool TryGetValue(string key, out object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A key identifying the requested entry. |
| value | Object& | The located value or null. |

##### Return Value

True if the key was found.

### Interface ICache
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/icache.md

#### ICache interface

Defines methods required for storing rendered document and document resources cache.

```csharp
public interface ICache
```

#### Methods

| Name | Description |
| --- | --- |
| GetKeys(string) | Returns all keys matching filter. |
| Set(string, object) | Inserts a cache entry into the cache. |
| TryGetValue(string, out object) | Gets the entry associated with this key if present. |

### ICache.GetKeys
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/icache/getkeys.md

#### ICache.GetKeys method

Returns all keys matching filter.

```csharp
public IEnumerable<string> GetKeys(string filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | String | The filter to use. |

##### Return Value

Keys matching the filter.

### ICache.Set
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/icache/set.md

#### ICache.Set method

Inserts a cache entry into the cache.

```csharp
public void Set(string key, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A unique identifier for the cache entry. |
| value | Object | The object to insert. |

### ICache.TryGetValue
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.cache/icache/trygetvalue.md

#### ICache.TryGetValue method

Gets the entry associated with this key if present.

```csharp
public bool TryGetValue(string key, out object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A key identifying the requested entry. |
| value | Object& | The located value or null. |

##### Return Value

True if the key was found.

### GroupDocs.Annotation.Exceptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions.md

The namespace contains all the exceptions used in GroupDocs.Annotation API.

#### Classes

| Class | Description |
| --- | --- |
| AnnotatorException | An error that occur during the document annotation process. |
| ConvertFileException | The exception that is thrown if file conversion failed. |
| CorruptedOrDamagedFileException | The exception that is thrown when file is corrupted or damaged. |
| FileTypeNotSupportedException | The exception that is thrown when file type is not supported. |
| ImageNotLoadedException | The exception that is thrown when image cannot be loaded from remote or local path. Usually happens if the provided "path" is incorrect. |
| IOException | The exception that is thrown when trying to apply format-specific annotation to the wrong file type. |
| PasswordProtectedFileException | The exception that is thrown when provided password is incorrect. |

### Class AnnotatorException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/annotatorexception.md

#### AnnotatorException class

An error that occur during the document annotation process.

```csharp
public class AnnotatorException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| AnnotatorException(string) | Initializes a new instance of the `AnnotatorException` class. |
| AnnotatorException(string, Exception) | Initializes a new instance of the `AnnotatorException` class. |

### AnnotatorException.AnnotatorException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/annotatorexception/annotatorexception.md

#### AnnotatorException(string)

Initializes a new instance of the `AnnotatorException` class.

```csharp
public AnnotatorException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### AnnotatorException(string, Exception)

Initializes a new instance of the `AnnotatorException` class.

```csharp
public AnnotatorException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### Class ConvertFileException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/convertfileexception.md

#### ConvertFileException class

The exception that is thrown if file conversion failed.

```csharp
public class ConvertFileException : AnnotatorException
```

#### Constructors

| Name | Description |
| --- | --- |
| ConvertFileException(string) | Initializes a new instance of the `ConvertFileException` class. |
| ConvertFileException(string, Exception) | Initializes a new instance of the `ConvertFileException` class. |

### ConvertFileException.ConvertFileException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/convertfileexception/convertfileexception.md

#### ConvertFileException(string)

Initializes a new instance of the `ConvertFileException` class.

```csharp
public ConvertFileException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### ConvertFileException(string, Exception)

Initializes a new instance of the `ConvertFileException` class.

```csharp
public ConvertFileException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### Class CorruptedOrDamagedFileException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/corruptedordamagedfileexception.md

#### CorruptedOrDamagedFileException class

The exception that is thrown when file is corrupted or damaged.

```csharp
public class CorruptedOrDamagedFileException : AnnotatorException
```

#### Constructors

| Name | Description |
| --- | --- |
| CorruptedOrDamagedFileException(string) | Initializes a new instance of the `CorruptedOrDamagedFileException` class. |
| CorruptedOrDamagedFileException(string, Exception) | Initializes a new instance of the `CorruptedOrDamagedFileException` class. |

### CorruptedOrDamagedFileException.CorruptedOrDamagedFileException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/corruptedordamagedfileexception/corruptedordamagedfileexception.md

#### CorruptedOrDamagedFileException(string)

Initializes a new instance of the `CorruptedOrDamagedFileException` class.

```csharp
public CorruptedOrDamagedFileException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### CorruptedOrDamagedFileException(string, Exception)

Initializes a new instance of the `CorruptedOrDamagedFileException` class.

```csharp
public CorruptedOrDamagedFileException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### Class FileTypeNotSupportedException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

The exception that is thrown when file type is not supported.

```csharp
public class FileTypeNotSupportedException : AnnotatorException
```

#### Constructors

| Name | Description |
| --- | --- |
| FileTypeNotSupportedException(string) | Initializes a new instance of the `FileTypeNotSupportedException` class. |
| FileTypeNotSupportedException(string, Exception) | Initializes a new instance of the `FileTypeNotSupportedException` class. |

### FileTypeNotSupportedException.FileTypeNotSupportedException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/filetypenotsupportedexception/filetypenotsupportedexception.md

#### FileTypeNotSupportedException(string)

Initializes a new instance of the `FileTypeNotSupportedException` class.

```csharp
public FileTypeNotSupportedException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### FileTypeNotSupportedException(string, Exception)

Initializes a new instance of the `FileTypeNotSupportedException` class.

```csharp
public FileTypeNotSupportedException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### Class ImageNotLoadedException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/imagenotloadedexception.md

#### ImageNotLoadedException class

The exception that is thrown when image cannot be loaded from remote or local path. Usually happens if the provided "path" is incorrect.

```csharp
public class ImageNotLoadedException : AnnotatorException
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageNotLoadedException(string) | Initializes a new instance of the `ImageNotLoadedException` class. |
| ImageNotLoadedException(string, Exception) | Initializes a new instance of the `ImageNotLoadedException` class. |

### ImageNotLoadedException.ImageNotLoadedException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/imagenotloadedexception/imagenotloadedexception.md

#### ImageNotLoadedException(string)

Initializes a new instance of the `ImageNotLoadedException` class.

```csharp
public ImageNotLoadedException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### ImageNotLoadedException(string, Exception)

Initializes a new instance of the `ImageNotLoadedException` class.

```csharp
public ImageNotLoadedException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### Class IOException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/ioexception.md

#### IOException class

The exception that is thrown when trying to apply format-specific annotation to the wrong file type.

```csharp
public class IOException : AnnotatorException
```

#### Constructors

| Name | Description |
| --- | --- |
| IOException(string) | Initializes a new instance of the `IOException` class. |
| IOException(string, Exception) | Initializes a new instance of the `IOException` class. |

### IOException.IOException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/ioexception/ioexception.md

#### IOException(string)

Initializes a new instance of the `IOException` class.

```csharp
public IOException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### IOException(string, Exception)

Initializes a new instance of the `IOException` class.

```csharp
public IOException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### Class PasswordProtectedFileException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/passwordprotectedfileexception.md

#### PasswordProtectedFileException class

The exception that is thrown when provided password is incorrect.

```csharp
public class PasswordProtectedFileException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| PasswordProtectedFileException(string) | Initializes a new instance of the `AnnotatorException` class. |
| PasswordProtectedFileException(string, Exception) | Initializes a new instance of the `AnnotatorException` class. |

### PasswordProtectedFileException.PasswordProtectedFileException
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.exceptions/passwordprotectedfileexception/passwordprotectedfileexception.md

#### PasswordProtectedFileException(string)

Initializes a new instance of the `AnnotatorException` class.

```csharp
public PasswordProtectedFileException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### PasswordProtectedFileException(string, Exception)

Initializes a new instance of the `AnnotatorException` class.

```csharp
public PasswordProtectedFileException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message that explains the reason for the exception. |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. |

### GroupDocs.Annotation.Localization
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.localization.md

The namespace provides classes checking supported locales.

#### Classes

| Class | Description |
| --- | --- |
| SupportedLocales | Class that provides methods for checking GroupDocs.Annotation supported locales. |

### Class SupportedLocales
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.localization/supportedlocales.md

#### SupportedLocales class

Class that provides methods for checking GroupDocs.Annotation supported locales.

```csharp
public static class SupportedLocales
```

#### Methods

| Name | Description |
| --- | --- |
| static IsLocaleSupported(CultureInfo) | Determines whether specified culture is supported by GroupDocs.Annotation API. |
| static IsLocaleSupported(string) | Determines whether specified culture is supported by GroupDocs.Annotation API. |

### SupportedLocales.IsLocaleSupported
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.localization/supportedlocales/islocalesupported.md

#### IsLocaleSupported(string)

Determines whether specified culture is supported by GroupDocs.Annotation API.

```csharp
public static bool IsLocaleSupported(string culture)
```

| Parameter | Type | Description |
| --- | --- | --- |
| culture | String | The culture. |

##### Return Value

True if locale is supported, false otherwise

#### IsLocaleSupported(CultureInfo)

Determines whether specified culture is supported by GroupDocs.Annotation API.

```csharp
public static bool IsLocaleSupported(CultureInfo culture)
```

| Parameter | Type | Description |
| --- | --- | --- |
| culture | CultureInfo | The culture. |

### GroupDocs.Annotation.Logging
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging.md

The namespace provides classes for working with integrated or your own logger.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Logger implementation which logs all information to the console. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | ILogger interface that defines shared logger contract |

### Class ConsoleLogger
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/consolelogger.md

#### ConsoleLogger class

Logger implementation which logs all information to the console.

```csharp
public sealed class ConsoleLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| ConsoleLogger() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Logs error message. |
| Trace(string) | Logs the process of annotating. |
| Warning(string) | Logs warning message. |

### ConsoleLogger.ConsoleLogger
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

The default constructor.

```csharp
public ConsoleLogger()
```

### ConsoleLogger.Error
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/consolelogger/error.md

#### ConsoleLogger.Error method

Logs error message.

```csharp
public void Error(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message. |
| exception | Exception | The exception that was thrown. |

### ConsoleLogger.Trace
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/consolelogger/trace.md

#### ConsoleLogger.Trace method

Logs the process of annotating.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message. |

### ConsoleLogger.Warning
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/consolelogger/warning.md

#### ConsoleLogger.Warning method

Logs warning message.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message. |

### Interface ILogger
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/ilogger.md

#### ILogger interface

ILogger interface that defines shared logger contract

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Error message. |
| Trace(string) | Trace message. |
| Warning(string) | Warning message. |

### ILogger.Error
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/ilogger/error.md

#### ILogger.Error method

Error message.

```csharp
public void Error(string message, Exception ex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The string to log. |
| ex | Exception | The exception that was thrown. |

### ILogger.Trace
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/ilogger/trace.md

#### ILogger.Trace method

Trace message.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The string to log. |

### ILogger.Warning
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.logging/ilogger/warning.md

#### ILogger.Warning method

Warning message.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The string to log. |

### GroupDocs.Annotation.Models.AnnotationModels.Interfaces.Annotations
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations.md

The namespace provides annotation models interfaces.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAreaAnnotation | Defines the area annotation interface |
| IArrowAnnotation | Defines the arrow annotation interface |
| IDistanceAnnotation | Defines the distance annotation interface |
| IEllipseAnnotation | Defines the ellipse annotation interface |
| IHighlightAnnotation | Defines the highlight annotation interface |
| ILinkAnnotation | Defines the link annotation interface |
| IPointAnnotation | Defines the point annotation interface |
| IPolylineAnnotation | Defines the polyline annotation interface |
| IReplacementAnnotation | Defines the replacement annotation interface |
| IResourcesRedactionAnnotation | Defines the resource redaction annotation interface |
| ISerachTextFragment | Defines the search text fragment annotation interface |
| ISquigglyAnnotation | Defines the squiggly annotation interface |
| IStrikeoutAnnotation | Defines the strikeout annotation interface |
| ITextFieldAnnotation | Defines the text field annotation interface |
| ITextRedactionAnnotation | Defines the text redaction annotation interface |
| IUnderlineAnnotation | Defines the underline annotation interface |
| IWatermarkAnnotation | Defines the watermark annotation interface |

### Interface IAreaAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iareaannotation.md

#### IAreaAnnotation interface

Defines the area annotation interface

```csharp
public interface IAreaAnnotation : IBackgroundColor, IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

### Interface IArrowAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iarrowannotation.md

#### IArrowAnnotation interface

Defines the arrow annotation interface

```csharp
public interface IArrowAnnotation : IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

### Interface IDistanceAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/idistanceannotation.md

#### IDistanceAnnotation interface

Defines the distance annotation interface

```csharp
public interface IDistanceAnnotation : IBox, IOpacity, IPenColor, IPenStyle, IPenWidth
```

### Interface IEllipseAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iellipseannotation.md

#### IEllipseAnnotation interface

Defines the ellipse annotation interface

```csharp
public interface IEllipseAnnotation : IBackgroundColor, IBox, IOpacity, IPenColor, IPenStyle, 
    IPenWidth
```

### Interface IHighlightAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/ihighlightannotation.md

#### IHighlightAnnotation interface

Defines the highlight annotation interface

```csharp
public interface IHighlightAnnotation : IBackgroundColor, IFontColor, IOpacity, IPoints
```

### Interface ILinkAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/ilinkannotation.md

#### ILinkAnnotation interface

Defines the link annotation interface

```csharp
public interface ILinkAnnotation : IBackgroundColor, IFontColor, IOpacity, IPoints, IUrl
```

### Interface IPointAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/ipointannotation.md

#### IPointAnnotation interface

Defines the point annotation interface

```csharp
public interface IPointAnnotation : IBox
```

### Interface IPolylineAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/ipolylineannotation.md

#### IPolylineAnnotation interface

Defines the polyline annotation interface

```csharp
public interface IPolylineAnnotation : IBox, IOpacity, IPenColor, IPenStyle, IPenWidth, ISvgPath
```

### Interface IReplacementAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/ireplacementannotation.md

#### IReplacementAnnotation interface

Defines the replacement annotation interface

```csharp
public interface IReplacementAnnotation : IBackgroundColor, IFontColor, IFontSize, IOpacity, 
    IPoints, ITextToReplace
```

### Interface IResourcesRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iresourcesredactionannotation.md

#### IResourcesRedactionAnnotation interface

Defines the resource redaction annotation interface

```csharp
public interface IResourcesRedactionAnnotation : IBox
```

### Interface ISerachTextFragment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iserachtextfragment.md

#### ISerachTextFragment interface

Defines the search text fragment annotation interface

```csharp
public interface ISerachTextFragment : IBackgroundColor, IFontColor, IFontFamily, IFontSize, IText
```

### Interface ISquigglyAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/isquigglyannotation.md

#### ISquigglyAnnotation interface

Defines the squiggly annotation interface

```csharp
public interface ISquigglyAnnotation : IBackgroundColor, IFontColor, IOpacity, IPoints, 
    ISquigglyColor
```

### Interface IStrikeoutAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/istrikeoutannotation.md

#### IStrikeoutAnnotation interface

Defines the strikeout annotation interface

```csharp
public interface IStrikeoutAnnotation : IBackgroundColor, IFontColor, IOpacity, IPoints
```

### Interface ITextFieldAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/itextfieldannotation.md

#### ITextFieldAnnotation interface

Defines the text field annotation interface

```csharp
public interface ITextFieldAnnotation : IBackgroundColor, IBox, IFontColor, IFontFamily, IFontSize, 
    IOpacity, IPenColor, IPenStyle, IPenWidth, IText, ITextHorizontalAlignment
```

### Interface ITextRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/itextredactionannotation.md

#### ITextRedactionAnnotation interface

Defines the text redaction annotation interface

```csharp
public interface ITextRedactionAnnotation : IFontColor, IPoints
```

### Interface IUnderlineAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iunderlineannotation.md

#### IUnderlineAnnotation interface

Defines the underline annotation interface

```csharp
public interface IUnderlineAnnotation : IBackgroundColor, IFontColor, IOpacity, IPoints
```

### Interface IWatermarkAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.annotations/iwatermarkannotation.md

#### IWatermarkAnnotation interface

Defines the watermark annotation interface

```csharp
public interface IWatermarkAnnotation : IAngle, IBox, IFontColor, IFontFamily, IFontSize, 
    IHorizontalAlignment, IOpacity, IText, IVerticalAlignment
```

### GroupDocs.Annotation.Models.AnnotationModels.Interfaces.Properties
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties.md

The namespace provides annotation properties interfaces.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAngle | Interface that describes rotation angle |
| IBackgroundColor | Interface that describes background color |
| IBorderStyle | Interface that describes border style |
| IBox | Interface that describes box (coordinates) |
| IBoxStyle | Interface that describes box style |
| IFontColor | Interface that describes font color |
| IFontFamily | Interface that describes font family |
| IFontSize | Interface that describes font size |
| IHorizontalAlignment | Interface that describes horizontal alignment |
| IOpacity | Interface that describes opacity |
| IPenColor | Interface that describes pen color |
| IPenStyle | Interface that describes pen style |
| IPenWidth | Interface that describes pen width |
| IPoints | Interface that describes position (coordinates) |
| ISquigglyColor | Interface that describes squiggly line color |
| ISvgPath | Interface that describes svg path coordinates array |
| IText | Interface that describes text content |
| ITextHorizontalAlignment | Interface that describes text horizontal alignment |
| ITextToReplace | Interface that describes text for replace |
| IUrl | Interface that describes link url |
| IVerticalAlignment | Interface that describes vertical alignment |

### Interface IAngle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iangle.md

#### IAngle interface

Interface that describes rotation angle

```csharp
public interface IAngle
```

#### Properties

| Name | Description |
| --- | --- |
| Angle { get; set; } | Gets or sets annotation rotation angle |

### IAngle.Angle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iangle/angle.md

#### IAngle.Angle property

Gets or sets annotation rotation angle

```csharp
public double? Angle { get; set; }
```

### Interface IBackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ibackgroundcolor.md

#### IBackgroundColor interface

Interface that describes background color

```csharp
public interface IBackgroundColor
```

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets annotation background color |

### IBackgroundColor.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ibackgroundcolor/backgroundcolor.md

#### IBackgroundColor.BackgroundColor property

Gets or sets annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### Interface IBorderStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iborderstyle.md

#### IBorderStyle interface

Interface that describes border style

```csharp
public interface IBorderStyle
```

#### Properties

| Name | Description |
| --- | --- |
| Style { get; set; } | Gets or sets annotation border style |

### IBorderStyle.Style
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iborderstyle/style.md

#### IBorderStyle.Style property

Gets or sets annotation border style

```csharp
public BorderStyle? Style { get; set; }
```

### Interface IBox
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ibox.md

#### IBox interface

Interface that describes box (coordinates)

```csharp
public interface IBox
```

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets annotation position |

### IBox.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ibox/box.md

#### IBox.Box property

Gets or sets annotation position

```csharp
public Rectangle Box { get; set; }
```

### Interface IBoxStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iboxstyle.md

#### IBoxStyle interface

Interface that describes box style

```csharp
public interface IBoxStyle
```

#### Properties

| Name | Description |
| --- | --- |
| Style { get; set; } | Gets or sets annotation box style |

### IBoxStyle.Style
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iboxstyle/style.md

#### IBoxStyle.Style property

Gets or sets annotation box style

```csharp
public BoxStyle? Style { get; set; }
```

### Interface IFontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontcolor.md

#### IFontColor interface

Interface that describes font color

```csharp
public interface IFontColor
```

#### Properties

| Name | Description |
| --- | --- |
| FontColor { get; set; } | Gets or sets annotation text font color |

### IFontColor.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontcolor/fontcolor.md

#### IFontColor.FontColor property

Gets or sets annotation text font color

```csharp
public int? FontColor { get; set; }
```

### Interface IFontFamily
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontfamily.md

#### IFontFamily interface

Interface that describes font family

```csharp
public interface IFontFamily
```

#### Properties

| Name | Description |
| --- | --- |
| FontFamily { get; set; } | Gets or sets annotation text font family |

### IFontFamily.FontFamily
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontfamily/fontfamily.md

#### IFontFamily.FontFamily property

Gets or sets annotation text font family

```csharp
public string FontFamily { get; set; }
```

### Interface IFontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontsize.md

#### IFontSize interface

Interface that describes font size

```csharp
public interface IFontSize
```

#### Properties

| Name | Description |
| --- | --- |
| FontSize { get; set; } | Gets or sets annotation text font size |

### IFontSize.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ifontsize/fontsize.md

#### IFontSize.FontSize property

Gets or sets annotation text font size

```csharp
public double? FontSize { get; set; }
```

### Interface IHorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ihorizontalalignment.md

#### IHorizontalAlignment interface

Interface that describes horizontal alignment

```csharp
public interface IHorizontalAlignment
```

#### Properties

| Name | Description |
| --- | --- |
| HorizontalAlignment { get; set; } | Gets or sets annotation horizontal alignment |

### IHorizontalAlignment.HorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ihorizontalalignment/horizontalalignment.md

#### IHorizontalAlignment.HorizontalAlignment property

Gets or sets annotation horizontal alignment

```csharp
public HorizontalAlignment HorizontalAlignment { get; set; }
```

### Interface IOpacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iopacity.md

#### IOpacity interface

Interface that describes opacity

```csharp
public interface IOpacity
```

#### Properties

| Name | Description |
| --- | --- |
| Opacity { get; set; } | Gets or sets annotation opacity |

### IOpacity.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iopacity/opacity.md

#### IOpacity.Opacity property

Gets or sets annotation opacity

```csharp
public double? Opacity { get; set; }
```

### Interface IPenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipencolor.md

#### IPenColor interface

Interface that describes pen color

```csharp
public interface IPenColor
```

#### Properties

| Name | Description |
| --- | --- |
| PenColor { get; set; } | Gets or sets annotation pen color |

### IPenColor.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipencolor/pencolor.md

#### IPenColor.PenColor property

Gets or sets annotation pen color

```csharp
public int? PenColor { get; set; }
```

### Interface IPenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipenstyle.md

#### IPenStyle interface

Interface that describes pen style

```csharp
public interface IPenStyle
```

#### Properties

| Name | Description |
| --- | --- |
| PenStyle { get; set; } | Gets or sets annotation pen style |

### IPenStyle.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipenstyle/penstyle.md

#### IPenStyle.PenStyle property

Gets or sets annotation pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### Interface IPenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipenwidth.md

#### IPenWidth interface

Interface that describes pen width

```csharp
public interface IPenWidth
```

#### Properties

| Name | Description |
| --- | --- |
| PenWidth { get; set; } | Gets or sets annotation pen width |

### IPenWidth.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipenwidth/penwidth.md

#### IPenWidth.PenWidth property

Gets or sets annotation pen width

```csharp
public byte? PenWidth { get; set; }
```

### Interface IPoints
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipoints.md

#### IPoints interface

Interface that describes position (coordinates)

```csharp
public interface IPoints
```

#### Properties

| Name | Description |
| --- | --- |
| Points { get; set; } | Gets or sets annotation position |

### IPoints.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/ipoints/points.md

#### IPoints.Points property

Gets or sets annotation position

```csharp
public List<Point> Points { get; set; }
```

### Interface ISquigglyColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/isquigglycolor.md

#### ISquigglyColor interface

Interface that describes squiggly line color

```csharp
public interface ISquigglyColor
```

#### Properties

| Name | Description |
| --- | --- |
| SquigglyColor { get; set; } | Gets or sets squiggly line color |

### ISquigglyColor.SquigglyColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/isquigglycolor/squigglycolor.md

#### ISquigglyColor.SquigglyColor property

Gets or sets squiggly line color

```csharp
public int? SquigglyColor { get; set; }
```

### Interface ISvgPath
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/isvgpath.md

#### ISvgPath interface

Interface that describes svg path coordinates array

```csharp
public interface ISvgPath
```

#### Properties

| Name | Description |
| --- | --- |
| SvgPath { get; set; } | Gets or sets annotation svg path coordinates array |

### ISvgPath.SvgPath
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/isvgpath/svgpath.md

#### ISvgPath.SvgPath property

Gets or sets annotation svg path coordinates array

```csharp
public string SvgPath { get; set; }
```

### Interface IText
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/itext.md

#### IText interface

Interface that describes text content

```csharp
public interface IText
```

#### Properties

| Name | Description |
| --- | --- |
| Text { get; set; } | Gets or sets annotation text |

### IText.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/itext/text.md

#### IText.Text property

Gets or sets annotation text

```csharp
public string Text { get; set; }
```

### Interface ITextHorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/itexthorizontalalignment.md

#### ITextHorizontalAlignment interface

Interface that describes text horizontal alignment

```csharp
public interface ITextHorizontalAlignment
```

#### Properties

| Name | Description |
| --- | --- |
| TextHorizontalAlignment { get; set; } | Gets or sets annotation text horizontal alignment |

### ITextHorizontalAlignment.TextHorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/itexthorizontalalignment/texthorizontalalignment.md

#### ITextHorizontalAlignment.TextHorizontalAlignment property

Gets or sets annotation text horizontal alignment

```csharp
public HorizontalAlignment TextHorizontalAlignment { get; set; }
```

### Interface ITextToReplace
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/itexttoreplace.md

#### ITextToReplace interface

Interface that describes text for replace

```csharp
public interface ITextToReplace
```

#### Properties

| Name | Description |
| --- | --- |
| TextToReplace { get; set; } | Gets or sets annotation text for replace |

### ITextToReplace.TextToReplace
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/itexttoreplace/texttoreplace.md

#### ITextToReplace.TextToReplace property

Gets or sets annotation text for replace

```csharp
public string TextToReplace { get; set; }
```

### Interface IUrl
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iurl.md

#### IUrl interface

Interface that describes link url

```csharp
public interface IUrl
```

#### Properties

| Name | Description |
| --- | --- |
| Url { get; set; } | Gets or sets annotation link url |

### IUrl.Url
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iurl/url.md

#### IUrl.Url property

Gets or sets annotation link url

```csharp
public string Url { get; set; }
```

### Interface IVerticalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iverticalalignment.md

#### IVerticalAlignment interface

Interface that describes vertical alignment

```csharp
public interface IVerticalAlignment
```

#### Properties

| Name | Description |
| --- | --- |
| VerticalAlignment { get; set; } | Gets or sets annotation vertical alignment |

### IVerticalAlignment.VerticalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.interfaces.properties/iverticalalignment/verticalalignment.md

#### IVerticalAlignment.VerticalAlignment property

Gets or sets annotation vertical alignment

```csharp
public VerticalAlignment VerticalAlignment { get; set; }
```

### GroupDocs.Annotation.Models.AnnotationModels
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels.md

The namespace provides annotation models data classes.

#### Classes

| Class | Description |
| --- | --- |
| AnnotationBase | Base class for all annotation types. Contains basic annotation information |
| AreaAnnotation | Represents area annotation properties |
| ArrowAnnotation | Represents arrow annotation properties |
| DistanceAnnotation | Represents distance annotation properties |
| EllipseAnnotation | Represents ellipse annotation properties |
| HighlightAnnotation | Represents highlight annotation properties |
| ImageAnnotation | Represents image annotation properties |
| LinkAnnotation | Represents link annotation properties |
| PointAnnotation | Represents point annotation properties |
| PolylineAnnotation | Represents polyline annotation properties |
| ReplacementAnnotation | Represents replacement annotation properties |
| ResourcesRedactionAnnotation | Represents resources redaction annotation properties |
| SearchTextFragment | Represents searchText annotation properties |
| SquigglyAnnotation | Represents squiggly annotation properties |
| StrikeoutAnnotation | Represents strikeout annotation properties |
| TextFieldAnnotation | Represents text field annotation properties |
| TextRedactionAnnotation | Represents text redaction annotation properties |
| UnderlineAnnotation | Represents underline annotation properties |
| WatermarkAnnotation | Represents watermark annotation properties |

### Class AnnotationBase
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase.md

#### AnnotationBase class

Base class for all annotation types. Contains basic annotation information

```csharp
public abstract class AnnotationBase : ICloneable, IEquatable<AnnotationBase>
```

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares Base Annotations using standard object Equals method |
| override GetHashCode() | Returns HashCode of AnnotationBase Message, PageNumber and Type Properties |

### AnnotationBase.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/clone.md

#### AnnotationBase.Clone method

Returns new instance with the same values

```csharp
public virtual object Clone()
```

### AnnotationBase.CreatedOn
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/createdon.md

#### AnnotationBase.CreatedOn property

Gets or sets annotation creation date

```csharp
public DateTime CreatedOn { get; set; }
```

### AnnotationBase.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/equals.md

#### Equals(AnnotationBase)

Compares Base Annotations using IEquatable Equals method

```csharp
public bool Equals(AnnotationBase other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | AnnotationBase | The AnnotationBase object to compare with the current object |

#### Equals(object)

Compares Base Annotations using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### AnnotationBase.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/gethashcode.md

#### AnnotationBase.GetHashCode method

Returns HashCode of AnnotationBase Message, PageNumber and Type Properties

```csharp
public override int GetHashCode()
```

### AnnotationBase.Id
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/id.md

#### AnnotationBase.Id property

Gets or sets annotation unique identifier. This field is auto-incremented.

```csharp
public int Id { get; set; }
```

### AnnotationBase.Message
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/message.md

#### AnnotationBase.Message property

Gets or sets annotation message

```csharp
public string Message { get; set; }
```

### AnnotationBase.PageNumber
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/pagenumber.md

#### AnnotationBase.PageNumber property

Page number where the annotation should be located

```csharp
public int? PageNumber { get; set; }
```

### AnnotationBase.Replies
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/replies.md

#### AnnotationBase.Replies property

The list of replies (comments) attached to the annotation

```csharp
public List<Reply> Replies { get; set; }
```

### AnnotationBase.StateBeforeAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/statebeforeannotation.md

#### AnnotationBase.StateBeforeAnnotation property

Stores the previous state of the text. State that was before annotating

```csharp
public object StateBeforeAnnotation { get; set; }
```

### AnnotationBase.Type
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/type.md

#### AnnotationBase.Type property

Gets or sets annotation type

```csharp
public AnnotationType Type { get; set; }
```

### AnnotationBase.User
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/annotationbase/user.md

#### AnnotationBase.User property

Gets or sets annotation author

```csharp
public User User { get; set; }
```

### Class AreaAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation.md

#### AreaAnnotation class

Represents area annotation properties

```csharp
public class AreaAnnotation : AnnotationBase, IAreaAnnotation, IEquatable<AreaAnnotation>
```

#### Constructors

| Name | Description |
| --- | --- |
| AreaAnnotation() | Initializes new instance of `AreaAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets area annotation background color |
| Box { get; set; } | Gets or sets area annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets area annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets area annotation pen color |
| PenStyle { get; set; } | Gets or sets area annotation pen style |
| PenWidth { get; set; } | Gets or sets area annotation pen width |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance of the area annotation with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(AreaAnnotation) | Compares area annotation using IEquatable Equals method |
| override Equals(object) | Compares area annotation using standard object Equals method |
| override GetHashCode() | Returns HashCode of Area Annotation instance |

### AreaAnnotation.AreaAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/areaannotation.md

#### AreaAnnotation constructor

Initializes new instance of `AreaAnnotation` class.

```csharp
public AreaAnnotation()
```

### AreaAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/backgroundcolor.md

#### AreaAnnotation.BackgroundColor property

Gets or sets area annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### AreaAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/box.md

#### AreaAnnotation.Box property

Gets or sets area annotation position

```csharp
public Rectangle Box { get; set; }
```

### AreaAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/clone.md

#### AreaAnnotation.Clone method

Returns new instance of the area annotation with the same values

```csharp
public override object Clone()
```

### AreaAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/equals.md

#### Equals(AreaAnnotation)

Compares area annotation using IEquatable Equals method

```csharp
public bool Equals(AreaAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | AreaAnnotation | The AreaAnnotation object to compare with the current object |

#### Equals(object)

Compares area annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### AreaAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/gethashcode.md

#### AreaAnnotation.GetHashCode method

Returns HashCode of Area Annotation instance

```csharp
public override int GetHashCode()
```

### AreaAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/opacity.md

#### AreaAnnotation.Opacity property

Gets or sets area annotation opacity

```csharp
public double? Opacity { get; set; }
```

### AreaAnnotation.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/pencolor.md

#### AreaAnnotation.PenColor property

Gets or sets area annotation pen color

```csharp
public int? PenColor { get; set; }
```

### AreaAnnotation.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/penstyle.md

#### AreaAnnotation.PenStyle property

Gets or sets area annotation pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### AreaAnnotation.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/areaannotation/penwidth.md

#### AreaAnnotation.PenWidth property

Gets or sets area annotation pen width

```csharp
public byte? PenWidth { get; set; }
```

### Class ArrowAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation.md

#### ArrowAnnotation class

Represents arrow annotation properties

```csharp
public class ArrowAnnotation : AnnotationBase, IArrowAnnotation, IEquatable<ArrowAnnotation>
```

#### Constructors

| Name | Description |
| --- | --- |
| ArrowAnnotation() | Initializes new instance of `ArrowAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets arrow annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets arrow annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets arrow annotation pen color |
| PenStyle { get; set; } | Gets or sets arrow annotation pen style |
| PenWidth { get; set; } | Gets or sets arrow annotation pen width |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(ArrowAnnotation) | Compares area annotation using IEquatable Equals method |
| override Equals(object) | Compares arrow annotation using standard object Equals method |
| override GetHashCode() | Returns HashCode of the arrow annotation |

### ArrowAnnotation.ArrowAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/arrowannotation.md

#### ArrowAnnotation constructor

Initializes new instance of `ArrowAnnotation` class.

```csharp
public ArrowAnnotation()
```

### ArrowAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/box.md

#### ArrowAnnotation.Box property

Gets or sets arrow annotation position

```csharp
public Rectangle Box { get; set; }
```

### ArrowAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/clone.md

#### ArrowAnnotation.Clone method

Returns new instance with same values

```csharp
public override object Clone()
```

### ArrowAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/equals.md

#### Equals(ArrowAnnotation)

Compares area annotation using IEquatable Equals method

```csharp
public bool Equals(ArrowAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ArrowAnnotation | The ArrowAnnotation object to compare with the current object |

#### Equals(object)

Compares arrow annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### ArrowAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/gethashcode.md

#### ArrowAnnotation.GetHashCode method

Returns HashCode of the arrow annotation

```csharp
public override int GetHashCode()
```

### ArrowAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/opacity.md

#### ArrowAnnotation.Opacity property

Gets or sets arrow annotation opacity

```csharp
public double? Opacity { get; set; }
```

### ArrowAnnotation.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/pencolor.md

#### ArrowAnnotation.PenColor property

Gets or sets arrow annotation pen color

```csharp
public int? PenColor { get; set; }
```

### ArrowAnnotation.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/penstyle.md

#### ArrowAnnotation.PenStyle property

Gets or sets arrow annotation pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### ArrowAnnotation.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/arrowannotation/penwidth.md

#### ArrowAnnotation.PenWidth property

Gets or sets arrow annotation pen width

```csharp
public byte? PenWidth { get; set; }
```

### Class DistanceAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation.md

#### DistanceAnnotation class

Represents distance annotation properties

```csharp
public class DistanceAnnotation : AnnotationBase, IDistanceAnnotation, 
    IEquatable<DistanceAnnotation>
```

#### Constructors

| Name | Description |
| --- | --- |
| DistanceAnnotation() | Initializes new instance of `DistanceAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets distance annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets distance annotatio opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets distance annotatio pen color |
| PenStyle { get; set; } | Gets or sets distance annotatio pen style |
| PenWidth { get; set; } | Gets or sets distance annotatio pen width |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(DistanceAnnotation) | Compares distance annotation using IEquatable Equals method |
| override Equals(object) | Compares distance annotation using standard object Equals method |
| override GetHashCode() | Returns HashCode of the distance annotation |

### DistanceAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/box.md

#### DistanceAnnotation.Box property

Gets or sets distance annotation position

```csharp
public Rectangle Box { get; set; }
```

### DistanceAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/clone.md

#### DistanceAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### DistanceAnnotation.DistanceAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/distanceannotation.md

#### DistanceAnnotation constructor

Initializes new instance of `DistanceAnnotation` class.

```csharp
public DistanceAnnotation()
```

### DistanceAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/equals.md

#### Equals(DistanceAnnotation)

Compares distance annotation using IEquatable Equals method

```csharp
public bool Equals(DistanceAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | DistanceAnnotation | The DistanceAnnotation object to compare with the current object |

#### Equals(object)

Compares distance annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### DistanceAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/gethashcode.md

#### DistanceAnnotation.GetHashCode method

Returns HashCode of the distance annotation

```csharp
public override int GetHashCode()
```

### DistanceAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/opacity.md

#### DistanceAnnotation.Opacity property

Gets or sets distance annotatio opacity

```csharp
public double? Opacity { get; set; }
```

### DistanceAnnotation.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/pencolor.md

#### DistanceAnnotation.PenColor property

Gets or sets distance annotatio pen color

```csharp
public int? PenColor { get; set; }
```

### DistanceAnnotation.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/penstyle.md

#### DistanceAnnotation.PenStyle property

Gets or sets distance annotatio pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### DistanceAnnotation.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/distanceannotation/penwidth.md

#### DistanceAnnotation.PenWidth property

Gets or sets distance annotatio pen width

```csharp
public byte? PenWidth { get; set; }
```

### Class EllipseAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation.md

#### EllipseAnnotation class

Represents ellipse annotation properties

```csharp
public class EllipseAnnotation : AnnotationBase, IEllipseAnnotation, IEquatable<EllipseAnnotation>
```

#### Constructors

| Name | Description |
| --- | --- |
| EllipseAnnotation() | Initializes new instance of `EllipseAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets ellipse annotation background color |
| Box { get; set; } | Gets or sets ellipse annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets ellipse annotation pen color |
| PenStyle { get; set; } | Gets or sets ellipse annotation pen style |
| PenWidth { get; set; } | Gets or sets ellipse annotation pen width |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(EllipseAnnotation) | Compares ellipse annotation using IEquatable Equals method |
| override Equals(object) | Compares ellipse annotation using standard object Equals method |
| override GetHashCode() | Returns HashCode of the ellipse annotation |

### EllipseAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/backgroundcolor.md

#### EllipseAnnotation.BackgroundColor property

Gets or sets ellipse annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### EllipseAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/box.md

#### EllipseAnnotation.Box property

Gets or sets ellipse annotation position

```csharp
public Rectangle Box { get; set; }
```

### EllipseAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/clone.md

#### EllipseAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### EllipseAnnotation.EllipseAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/ellipseannotation.md

#### EllipseAnnotation constructor

Initializes new instance of `EllipseAnnotation` class.

```csharp
public EllipseAnnotation()
```

### EllipseAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/equals.md

#### Equals(EllipseAnnotation)

Compares ellipse annotation using IEquatable Equals method

```csharp
public bool Equals(EllipseAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | EllipseAnnotation | The EllipseAnnotation object to compare with the current object |

#### Equals(object)

Compares ellipse annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### EllipseAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/gethashcode.md

#### EllipseAnnotation.GetHashCode method

Returns HashCode of the ellipse annotation

```csharp
public override int GetHashCode()
```

### EllipseAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/opacity.md

#### EllipseAnnotation.Opacity property

Gets or sets annotation opacity

```csharp
public double? Opacity { get; set; }
```

### EllipseAnnotation.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/pencolor.md

#### EllipseAnnotation.PenColor property

Gets or sets ellipse annotation pen color

```csharp
public int? PenColor { get; set; }
```

### EllipseAnnotation.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/penstyle.md

#### EllipseAnnotation.PenStyle property

Gets or sets ellipse annotation pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### EllipseAnnotation.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/ellipseannotation/penwidth.md

#### EllipseAnnotation.PenWidth property

Gets or sets ellipse annotation pen width

```csharp
public byte? PenWidth { get; set; }
```

### Class HighlightAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation.md

#### HighlightAnnotation class

Represents highlight annotation properties

```csharp
public class HighlightAnnotation : AnnotationBase, IEquatable<HighlightAnnotation>, 
    IHighlightAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| HighlightAnnotation() | Initializes new instance of `HighlightAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets highlight annotation background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets highlight annotation text font color |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets highlight annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets collection of points that describe rectangles with text |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(HighlightAnnotation) | Compares highlight annotation using IEquatable Equals method |
| override Equals(object) | Compares highlight annotations using standard object Equals method |
| override GetHashCode() | Returns HashCode of the highlight annotation |

### HighlightAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/backgroundcolor.md

#### HighlightAnnotation.BackgroundColor property

Gets or sets highlight annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### HighlightAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/clone.md

#### HighlightAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### HighlightAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/equals.md

#### Equals(HighlightAnnotation)

Compares highlight annotation using IEquatable Equals method

```csharp
public bool Equals(HighlightAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | HighlightAnnotation | The HighlightAnnotation object to compare with the current object |

#### Equals(object)

Compares highlight annotations using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### HighlightAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/fontcolor.md

#### HighlightAnnotation.FontColor property

Gets or sets highlight annotation text font color

```csharp
public int? FontColor { get; set; }
```

### HighlightAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/gethashcode.md

#### HighlightAnnotation.GetHashCode method

Returns HashCode of the highlight annotation

```csharp
public override int GetHashCode()
```

### HighlightAnnotation.HighlightAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/highlightannotation.md

#### HighlightAnnotation constructor

Initializes new instance of `HighlightAnnotation` class.

```csharp
public HighlightAnnotation()
```

### HighlightAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/opacity.md

#### HighlightAnnotation.Opacity property

Gets or sets highlight annotation opacity

```csharp
public double? Opacity { get; set; }
```

### HighlightAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/highlightannotation/points.md

#### HighlightAnnotation.Points property

Gets or sets collection of points that describe rectangles with text

```csharp
public List<Point> Points { get; set; }
```

### Class ImageAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation.md

#### ImageAnnotation class

Represents image annotation properties

```csharp
public class ImageAnnotation : AnnotationBase, IAngle, IBox, IEquatable<ImageAnnotation>, IOpacity
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageAnnotation() | Initializes new instance of `ImageAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Angle { get; set; } | Gets or sets image annotation rotation angle |
| Box { get; set; } | Gets or sets image annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| ImageData { get; set; } | Gets or sets image annotation data |
| ImageExtension { get; } | Gets the image extensions (png, jpg, svg etc) |
| ImagePath { get; set; } | Gets or sets image annotation path |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets image annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |
| ZIndex { get; set; } | Gets or sets image annotation z-index. Default value is 0 |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(ImageAnnotation) | Compares image annotation using IEquatable Equals method |
| override Equals(object) | Compares image annotation using standard object Equals method |
| override GetHashCode() | Returns HashCode of Image Annotation |
| GetImage() | Gets image object |

### ImageAnnotation.Angle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/angle.md

#### ImageAnnotation.Angle property

Gets or sets image annotation rotation angle

```csharp
public double? Angle { get; set; }
```

### ImageAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/box.md

#### ImageAnnotation.Box property

Gets or sets image annotation position

```csharp
public Rectangle Box { get; set; }
```

### ImageAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/clone.md

#### ImageAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### ImageAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/equals.md

#### Equals(ImageAnnotation)

Compares image annotation using IEquatable Equals method

```csharp
public bool Equals(ImageAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ImageAnnotation | The ImageAnnotation object to compare with the current object |

#### Equals(object)

Compares image annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### ImageAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/gethashcode.md

#### ImageAnnotation.GetHashCode method

Returns HashCode of Image Annotation

```csharp
public override int GetHashCode()
```

### ImageAnnotation.GetImage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/getimage.md

#### ImageAnnotation.GetImage method

Gets image object

```csharp
public Image GetImage()
```

### ImageAnnotation.ImageAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/imageannotation.md

#### ImageAnnotation constructor

Initializes new instance of `ImageAnnotation` class.

```csharp
public ImageAnnotation()
```

### ImageAnnotation.ImageData
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/imagedata.md

#### ImageAnnotation.ImageData property

Gets or sets image annotation data

```csharp
public string ImageData { get; set; }
```

### ImageAnnotation.ImageExtension
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/imageextension.md

#### ImageAnnotation.ImageExtension property

Gets the image extensions (png, jpg, svg etc)

```csharp
public string ImageExtension { get; }
```

### ImageAnnotation.ImagePath
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/imagepath.md

#### ImageAnnotation.ImagePath property

Gets or sets image annotation path

```csharp
public string ImagePath { get; set; }
```

### ImageAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/opacity.md

#### ImageAnnotation.Opacity property

Gets or sets image annotation opacity

```csharp
public double? Opacity { get; set; }
```

### ImageAnnotation.ZIndex
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/imageannotation/zindex.md

#### ImageAnnotation.ZIndex property

Gets or sets image annotation z-index. Default value is 0

The **z-index** property specifies the stack order of an element.

```csharp
public int ZIndex { get; set; }
```

### Class LinkAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation.md

#### LinkAnnotation class

Represents link annotation properties

```csharp
public class LinkAnnotation : AnnotationBase, IEquatable<LinkAnnotation>, ILinkAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| LinkAnnotation() | Initializes new instance of `LinkAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets link annotation background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets link annotation text color |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets link annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets link annotation coordinates as an array of points |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| Url { get; set; } | Gets or sets annotation link url |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(LinkAnnotation) | Compares link annotation using IEquatable Equals method |
| override Equals(object) | Compares link annotation using standard object Equals method |
| override GetHashCode() | Returns HashCode of link annotation |

### LinkAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/backgroundcolor.md

#### LinkAnnotation.BackgroundColor property

Gets or sets link annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### LinkAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/clone.md

#### LinkAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### LinkAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/equals.md

#### Equals(LinkAnnotation)

Compares link annotation using IEquatable Equals method

```csharp
public bool Equals(LinkAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | LinkAnnotation | The LinkAnnotation object to compare with the current object |

#### Equals(object)

Compares link annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### LinkAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/fontcolor.md

#### LinkAnnotation.FontColor property

Gets or sets link annotation text color

```csharp
public int? FontColor { get; set; }
```

### LinkAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/gethashcode.md

#### LinkAnnotation.GetHashCode method

Returns HashCode of link annotation

```csharp
public override int GetHashCode()
```

### LinkAnnotation.LinkAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/linkannotation.md

#### LinkAnnotation constructor

Initializes new instance of `LinkAnnotation` class.

```csharp
public LinkAnnotation()
```

### LinkAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/opacity.md

#### LinkAnnotation.Opacity property

Gets or sets link annotation opacity

```csharp
public double? Opacity { get; set; }
```

### LinkAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/points.md

#### LinkAnnotation.Points property

Gets or sets link annotation coordinates as an array of points

```csharp
public List<Point> Points { get; set; }
```

### LinkAnnotation.Url
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/linkannotation/url.md

#### LinkAnnotation.Url property

Gets or sets annotation link url

```csharp
public string Url { get; set; }
```

### Class PointAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/pointannotation.md

#### PointAnnotation class

Represents point annotation properties

```csharp
public class PointAnnotation : AnnotationBase, IEquatable<PointAnnotation>, IPointAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| PointAnnotation() | Initializes new instance of `PointAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets point annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares point annotation using standard object Equals method |
| Equals(PointAnnotation) | Compares point annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the point annotation |

### PointAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/pointannotation/box.md

#### PointAnnotation.Box property

Gets or sets point annotation position

```csharp
public Rectangle Box { get; set; }
```

### PointAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/pointannotation/clone.md

#### PointAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### PointAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/pointannotation/equals.md

#### Equals(PointAnnotation)

Compares point annotation using IEquatable Equals method

```csharp
public bool Equals(PointAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | PointAnnotation | The PointAnnotation object to compare with the current object |

#### Equals(object)

Compares point annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### PointAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/pointannotation/gethashcode.md

#### PointAnnotation.GetHashCode method

Returns HashCode of the point annotation

```csharp
public override int GetHashCode()
```

### PointAnnotation.PointAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/pointannotation/pointannotation.md

#### PointAnnotation constructor

Initializes new instance of `PointAnnotation` class.

```csharp
public PointAnnotation()
```

### Class PolylineAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation.md

#### PolylineAnnotation class

Represents polyline annotation properties

```csharp
public class PolylineAnnotation : AnnotationBase, IEquatable<PolylineAnnotation>, 
    IPolylineAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| PolylineAnnotation() | Initializes new instance of `AreaAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets polyline annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets polyline annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets polyline annotation pen color |
| PenStyle { get; set; } | Gets or sets polyline annotation pen style |
| PenWidth { get; set; } | Gets or sets polyline annotation pen width |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| SvgPath { get; set; } | Gets or sets polyline annotation SVG path |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares polyline annotation using standard object Equals method |
| Equals(PolylineAnnotation) | Compares polyline annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the polyline annotation |

### PolylineAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/box.md

#### PolylineAnnotation.Box property

Gets or sets polyline annotation position

```csharp
public Rectangle Box { get; set; }
```

### PolylineAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/clone.md

#### PolylineAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### PolylineAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/equals.md

#### Equals(PolylineAnnotation)

Compares polyline annotation using IEquatable Equals method

```csharp
public bool Equals(PolylineAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | PolylineAnnotation | The PolylineAnnotation object to compare with the current object |

#### Equals(object)

Compares polyline annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### PolylineAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/gethashcode.md

#### PolylineAnnotation.GetHashCode method

Returns HashCode of the polyline annotation

```csharp
public override int GetHashCode()
```

### PolylineAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/opacity.md

#### PolylineAnnotation.Opacity property

Gets or sets polyline annotation opacity

```csharp
public double? Opacity { get; set; }
```

### PolylineAnnotation.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/pencolor.md

#### PolylineAnnotation.PenColor property

Gets or sets polyline annotation pen color

```csharp
public int? PenColor { get; set; }
```

### PolylineAnnotation.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/penstyle.md

#### PolylineAnnotation.PenStyle property

Gets or sets polyline annotation pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### PolylineAnnotation.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/penwidth.md

#### PolylineAnnotation.PenWidth property

Gets or sets polyline annotation pen width

```csharp
public byte? PenWidth { get; set; }
```

### PolylineAnnotation.PolylineAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/polylineannotation.md

#### PolylineAnnotation constructor

Initializes new instance of `AreaAnnotation` class.

```csharp
public PolylineAnnotation()
```

### PolylineAnnotation.SvgPath
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/polylineannotation/svgpath.md

#### PolylineAnnotation.SvgPath property

Gets or sets polyline annotation SVG path

```csharp
public string SvgPath { get; set; }
```

### Class ReplacementAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation.md

#### ReplacementAnnotation class

Represents replacement annotation properties

```csharp
public class ReplacementAnnotation : AnnotationBase, IEquatable<ReplacementAnnotation>, 
    IReplacementAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| ReplacementAnnotation() | Initializes new instance of `ReplacementAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets replacement annotation background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets replacement annotation text color |
| FontSize { get; set; } | Gets or sets replacement annotation text size |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets replacement annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets collection of points that describe rectangles with text |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| TextToReplace { get; set; } | Gets or sets text to be replaced with |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares replacement annotation using standard object Equals method |
| Equals(ReplacementAnnotation) | Compares replacement annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the replacement annotation |

### ReplacementAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/backgroundcolor.md

#### ReplacementAnnotation.BackgroundColor property

Gets or sets replacement annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### ReplacementAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/clone.md

#### ReplacementAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### ReplacementAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/equals.md

#### Equals(ReplacementAnnotation)

Compares replacement annotation using IEquatable Equals method

```csharp
public bool Equals(ReplacementAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ReplacementAnnotation | The ReplacementAnnotation object to compare with the current object |

#### Equals(object)

Compares replacement annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### ReplacementAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/fontcolor.md

#### ReplacementAnnotation.FontColor property

Gets or sets replacement annotation text color

```csharp
public int? FontColor { get; set; }
```

### ReplacementAnnotation.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/fontsize.md

#### ReplacementAnnotation.FontSize property

Gets or sets replacement annotation text size

```csharp
public double? FontSize { get; set; }
```

### ReplacementAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/gethashcode.md

#### ReplacementAnnotation.GetHashCode method

Returns HashCode of the replacement annotation

```csharp
public override int GetHashCode()
```

### ReplacementAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/opacity.md

#### ReplacementAnnotation.Opacity property

Gets or sets replacement annotation opacity

```csharp
public double? Opacity { get; set; }
```

### ReplacementAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/points.md

#### ReplacementAnnotation.Points property

Gets or sets collection of points that describe rectangles with text

```csharp
public List<Point> Points { get; set; }
```

### ReplacementAnnotation.ReplacementAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/replacementannotation.md

#### ReplacementAnnotation constructor

Initializes new instance of `ReplacementAnnotation` class.

```csharp
public ReplacementAnnotation()
```

### ReplacementAnnotation.TextToReplace
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/replacementannotation/texttoreplace.md

#### ReplacementAnnotation.TextToReplace property

Gets or sets text to be replaced with

```csharp
public string TextToReplace { get; set; }
```

### Class ResourcesRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/resourcesredactionannotation.md

#### ResourcesRedactionAnnotation class

Represents resources redaction annotation properties

```csharp
public class ResourcesRedactionAnnotation : AnnotationBase, 
    IEquatable<ResourcesRedactionAnnotation>, IResourcesRedactionAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| ResourcesRedactionAnnotation() | Initializes new instance of `ResourcesRedactionAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets resource redaction annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares resource redaction annotation using standard object Equals method |
| Equals(ResourcesRedactionAnnotation) | Compares resource redaction annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the resource redaction annotation |

### ResourcesRedactionAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/resourcesredactionannotation/box.md

#### ResourcesRedactionAnnotation.Box property

Gets or sets resource redaction annotation position

```csharp
public Rectangle Box { get; set; }
```

### ResourcesRedactionAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/resourcesredactionannotation/clone.md

#### ResourcesRedactionAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### ResourcesRedactionAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/resourcesredactionannotation/equals.md

#### Equals(ResourcesRedactionAnnotation)

Compares resource redaction annotation using IEquatable Equals method

```csharp
public bool Equals(ResourcesRedactionAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ResourcesRedactionAnnotation | The ResourcesRedactionAnnotation object to compare with the current object |

#### Equals(object)

Compares resource redaction annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### ResourcesRedactionAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/resourcesredactionannotation/gethashcode.md

#### ResourcesRedactionAnnotation.GetHashCode method

Returns HashCode of the resource redaction annotation

```csharp
public override int GetHashCode()
```

### ResourcesRedactionAnnotation.ResourcesRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/resourcesredactionannotation/resourcesredactionannotation.md

#### ResourcesRedactionAnnotation constructor

Initializes new instance of `ResourcesRedactionAnnotation` class.

```csharp
public ResourcesRedactionAnnotation()
```

### Class SearchTextFragment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment.md

#### SearchTextFragment class

Represents searchText annotation properties

```csharp
public class SearchTextFragment : AnnotationBase, IEquatable<SearchTextFragment>, 
    ISerachTextFragment
```

#### Constructors

| Name | Description |
| --- | --- |
| SearchTextFragment() | Initializes new instance of `SearchTextFragment` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets text background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets text color |
| FontFamily { get; set; } | Gets or sets text font family |
| FontSize { get; set; } | Gets or sets text size |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Text { get; set; } | Gets or sets that need to be found |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares search text annotation using standard object Equals method |
| Equals(SearchTextFragment) | Compares search text annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of SearchText Annotation |

### SearchTextFragment.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/backgroundcolor.md

#### SearchTextFragment.BackgroundColor property

Gets or sets text background color

```csharp
public int? BackgroundColor { get; set; }
```

### SearchTextFragment.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/clone.md

#### SearchTextFragment.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### SearchTextFragment.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/equals.md

#### Equals(SearchTextFragment)

Compares search text annotation using IEquatable Equals method

```csharp
public bool Equals(SearchTextFragment other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | SearchTextFragment | The SearchTextFragment object to compare with the current object |

#### Equals(object)

Compares search text annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### SearchTextFragment.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/fontcolor.md

#### SearchTextFragment.FontColor property

Gets or sets text color

```csharp
public int? FontColor { get; set; }
```

### SearchTextFragment.FontFamily
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/fontfamily.md

#### SearchTextFragment.FontFamily property

Gets or sets text font family

```csharp
public string FontFamily { get; set; }
```

### SearchTextFragment.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/fontsize.md

#### SearchTextFragment.FontSize property

Gets or sets text size

```csharp
public double? FontSize { get; set; }
```

### SearchTextFragment.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/gethashcode.md

#### SearchTextFragment.GetHashCode method

Returns HashCode of SearchText Annotation

```csharp
public override int GetHashCode()
```

### SearchTextFragment.SearchTextFragment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/searchtextfragment.md

#### SearchTextFragment constructor

Initializes new instance of `SearchTextFragment` class.

```csharp
public SearchTextFragment()
```

### SearchTextFragment.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/searchtextfragment/text.md

#### SearchTextFragment.Text property

Gets or sets that need to be found

```csharp
public string Text { get; set; }
```

### Class SquigglyAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation.md

#### SquigglyAnnotation class

Represents squiggly annotation properties

```csharp
public class SquigglyAnnotation : AnnotationBase, IEquatable<SquigglyAnnotation>, 
    ISquigglyAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| SquigglyAnnotation() | Initializes new instance of `SquigglyAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets squiggly annotation text background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets squiggly annotation text font color |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets squiggly annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets collection of points that describe rectangles with text |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| SquigglyColor { get; set; } | Gets or sets squiggly annotation color |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares squiggly annotation using standard object Equals method |
| Equals(SquigglyAnnotation) | Compares squiggly annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the squiggly annotation |

### SquigglyAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/backgroundcolor.md

#### SquigglyAnnotation.BackgroundColor property

Gets or sets squiggly annotation text background color

```csharp
public int? BackgroundColor { get; set; }
```

### SquigglyAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/clone.md

#### SquigglyAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### SquigglyAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/equals.md

#### Equals(SquigglyAnnotation)

Compares squiggly annotation using IEquatable Equals method

```csharp
public bool Equals(SquigglyAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | SquigglyAnnotation | The SquigglyAnnotation object to compare with the current object |

#### Equals(object)

Compares squiggly annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### SquigglyAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/fontcolor.md

#### SquigglyAnnotation.FontColor property

Gets or sets squiggly annotation text font color

```csharp
public int? FontColor { get; set; }
```

### SquigglyAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/gethashcode.md

#### SquigglyAnnotation.GetHashCode method

Returns HashCode of the squiggly annotation

```csharp
public override int GetHashCode()
```

### SquigglyAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/opacity.md

#### SquigglyAnnotation.Opacity property

Gets or sets squiggly annotation opacity

```csharp
public double? Opacity { get; set; }
```

### SquigglyAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/points.md

#### SquigglyAnnotation.Points property

Gets or sets collection of points that describe rectangles with text

```csharp
public List<Point> Points { get; set; }
```

### SquigglyAnnotation.SquigglyAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/squigglyannotation.md

#### SquigglyAnnotation constructor

Initializes new instance of `SquigglyAnnotation` class.

```csharp
public SquigglyAnnotation()
```

### SquigglyAnnotation.SquigglyColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/squigglyannotation/squigglycolor.md

#### SquigglyAnnotation.SquigglyColor property

Gets or sets squiggly annotation color

```csharp
public int? SquigglyColor { get; set; }
```

### Class StrikeoutAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation.md

#### StrikeoutAnnotation class

Represents strikeout annotation properties

```csharp
public class StrikeoutAnnotation : AnnotationBase, IEquatable<StrikeoutAnnotation>, 
    IStrikeoutAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| StrikeoutAnnotation() | Initializes new instance of `StrikeoutAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets strikeout annotation text background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets strikeout annotation text font color |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets strikeout annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets collection of points that describe rectangles with text |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares strikeout annotation using standard object Equals method |
| Equals(StrikeoutAnnotation) | Compares strikeout annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the strikeout annotation |

### StrikeoutAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/backgroundcolor.md

#### StrikeoutAnnotation.BackgroundColor property

Gets or sets strikeout annotation text background color

```csharp
public int? BackgroundColor { get; set; }
```

### StrikeoutAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/clone.md

#### StrikeoutAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### StrikeoutAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/equals.md

#### Equals(StrikeoutAnnotation)

Compares strikeout annotation using IEquatable Equals method

```csharp
public bool Equals(StrikeoutAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | StrikeoutAnnotation | The StrikeoutAnnotation object to compare with the current object |

#### Equals(object)

Compares strikeout annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### StrikeoutAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/fontcolor.md

#### StrikeoutAnnotation.FontColor property

Gets or sets strikeout annotation text font color

```csharp
public int? FontColor { get; set; }
```

### StrikeoutAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/gethashcode.md

#### StrikeoutAnnotation.GetHashCode method

Returns HashCode of the strikeout annotation

```csharp
public override int GetHashCode()
```

### StrikeoutAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/opacity.md

#### StrikeoutAnnotation.Opacity property

Gets or sets strikeout annotation opacity

```csharp
public double? Opacity { get; set; }
```

### StrikeoutAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/points.md

#### StrikeoutAnnotation.Points property

Gets or sets collection of points that describe rectangles with text

```csharp
public List<Point> Points { get; set; }
```

### StrikeoutAnnotation.StrikeoutAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/strikeoutannotation/strikeoutannotation.md

#### StrikeoutAnnotation constructor

Initializes new instance of `StrikeoutAnnotation` class.

```csharp
public StrikeoutAnnotation()
```

### Class TextFieldAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation.md

#### TextFieldAnnotation class

Represents text field annotation properties

```csharp
public class TextFieldAnnotation : AnnotationBase, IEquatable<TextFieldAnnotation>, 
    ITextFieldAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| TextFieldAnnotation() | Initializes new instance of `TextFieldAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets text field annotation background color |
| Box { get; set; } | Gets or sets text field annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets text field annotation text font color |
| FontFamily { get; set; } | Gets or sets text field annotation text font family |
| FontSize { get; set; } | Gets or sets text field annotation font size |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets text field annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets text field annotation pen color |
| PenStyle { get; set; } | Gets or sets text field annotation pen style |
| PenWidth { get; set; } | Gets or sets text field annotation pen width |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Text { get; set; } | Gets or sets text field annotation text |
| TextHorizontalAlignment { get; set; } | Gets or sets horizontal alignment of the text |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares text field annotation using standard object Equals method |
| Equals(TextFieldAnnotation) | Compares text field annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the text field annotation |

### TextFieldAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/backgroundcolor.md

#### TextFieldAnnotation.BackgroundColor property

Gets or sets text field annotation background color

```csharp
public int? BackgroundColor { get; set; }
```

### TextFieldAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/box.md

#### TextFieldAnnotation.Box property

Gets or sets text field annotation position

```csharp
public Rectangle Box { get; set; }
```

### TextFieldAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/clone.md

#### TextFieldAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### TextFieldAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/equals.md

#### Equals(TextFieldAnnotation)

Compares text field annotation using IEquatable Equals method

```csharp
public bool Equals(TextFieldAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | TextFieldAnnotation | The TextFieldAnnotation object to compare with the current object |

#### Equals(object)

Compares text field annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### TextFieldAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/fontcolor.md

#### TextFieldAnnotation.FontColor property

Gets or sets text field annotation text font color

```csharp
public int? FontColor { get; set; }
```

### TextFieldAnnotation.FontFamily
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/fontfamily.md

#### TextFieldAnnotation.FontFamily property

Gets or sets text field annotation text font family

```csharp
public string FontFamily { get; set; }
```

### TextFieldAnnotation.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/fontsize.md

#### TextFieldAnnotation.FontSize property

Gets or sets text field annotation font size

```csharp
public double? FontSize { get; set; }
```

### TextFieldAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/gethashcode.md

#### TextFieldAnnotation.GetHashCode method

Returns HashCode of the text field annotation

```csharp
public override int GetHashCode()
```

### TextFieldAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/opacity.md

#### TextFieldAnnotation.Opacity property

Gets or sets text field annotation opacity

```csharp
public double? Opacity { get; set; }
```

### TextFieldAnnotation.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/pencolor.md

#### TextFieldAnnotation.PenColor property

Gets or sets text field annotation pen color

```csharp
public int? PenColor { get; set; }
```

### TextFieldAnnotation.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/penstyle.md

#### TextFieldAnnotation.PenStyle property

Gets or sets text field annotation pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### TextFieldAnnotation.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/penwidth.md

#### TextFieldAnnotation.PenWidth property

Gets or sets text field annotation pen width

```csharp
public byte? PenWidth { get; set; }
```

### TextFieldAnnotation.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/text.md

#### TextFieldAnnotation.Text property

Gets or sets text field annotation text

```csharp
public string Text { get; set; }
```

### TextFieldAnnotation.TextFieldAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/textfieldannotation.md

#### TextFieldAnnotation constructor

Initializes new instance of `TextFieldAnnotation` class.

```csharp
public TextFieldAnnotation()
```

### TextFieldAnnotation.TextHorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textfieldannotation/texthorizontalalignment.md

#### TextFieldAnnotation.TextHorizontalAlignment property

Gets or sets horizontal alignment of the text

```csharp
public HorizontalAlignment TextHorizontalAlignment { get; set; }
```

### Class TextRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation.md

#### TextRedactionAnnotation class

Represents text redaction annotation properties

```csharp
public class TextRedactionAnnotation : AnnotationBase, IEquatable<TextRedactionAnnotation>, 
    ITextRedactionAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| TextRedactionAnnotation() | Initializes new instance of `TextRedactionAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets text redaction annotation text font color |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets collection of points that describe rectangles with text |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares text redaction annotation using standard object Equals method |
| Equals(TextRedactionAnnotation) | Compares text redaction annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the text redaction annotation |

### TextRedactionAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation/clone.md

#### TextRedactionAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### TextRedactionAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation/equals.md

#### Equals(TextRedactionAnnotation)

Compares text redaction annotation using IEquatable Equals method

```csharp
public bool Equals(TextRedactionAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | TextRedactionAnnotation | The TextRedactionAnnotation object to compare with the current object |

#### Equals(object)

Compares text redaction annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### TextRedactionAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation/fontcolor.md

#### TextRedactionAnnotation.FontColor property

Gets or sets text redaction annotation text font color

```csharp
public int? FontColor { get; set; }
```

### TextRedactionAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation/gethashcode.md

#### TextRedactionAnnotation.GetHashCode method

Returns HashCode of the text redaction annotation

```csharp
public override int GetHashCode()
```

### TextRedactionAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation/points.md

#### TextRedactionAnnotation.Points property

Gets or sets collection of points that describe rectangles with text

```csharp
public List<Point> Points { get; set; }
```

### TextRedactionAnnotation.TextRedactionAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/textredactionannotation/textredactionannotation.md

#### TextRedactionAnnotation constructor

Initializes new instance of `TextRedactionAnnotation` class.

```csharp
public TextRedactionAnnotation()
```

### Class UnderlineAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation.md

#### UnderlineAnnotation class

Represents underline annotation properties

```csharp
public class UnderlineAnnotation : AnnotationBase, IEquatable<UnderlineAnnotation>, 
    IUnderlineAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| UnderlineAnnotation() | Initializes new instance of `UnderlineAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets underline annotation text background color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets underline annotation text color |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets underline annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Points { get; set; } | Gets or sets collection of points that describe rectangles with text |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| UnderlineColor { get; set; } | Gets or sets underline annotation color |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares underline annotation using standard object Equals method |
| Equals(UnderlineAnnotation) | Compares underline annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the underline annotation |

### UnderlineAnnotation.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/backgroundcolor.md

#### UnderlineAnnotation.BackgroundColor property

Gets or sets underline annotation text background color

```csharp
public int? BackgroundColor { get; set; }
```

### UnderlineAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/clone.md

#### UnderlineAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### UnderlineAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/equals.md

#### Equals(UnderlineAnnotation)

Compares underline annotation using IEquatable Equals method

```csharp
public bool Equals(UnderlineAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | UnderlineAnnotation | The UnderlineAnnotation object to compare with the current object |

#### Equals(object)

Compares underline annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### UnderlineAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/fontcolor.md

#### UnderlineAnnotation.FontColor property

Gets or sets underline annotation text color

```csharp
public int? FontColor { get; set; }
```

### UnderlineAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/gethashcode.md

#### UnderlineAnnotation.GetHashCode method

Returns HashCode of the underline annotation

```csharp
public override int GetHashCode()
```

### UnderlineAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/opacity.md

#### UnderlineAnnotation.Opacity property

Gets or sets underline annotation opacity

```csharp
public double? Opacity { get; set; }
```

### UnderlineAnnotation.Points
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/points.md

#### UnderlineAnnotation.Points property

Gets or sets collection of points that describe rectangles with text

```csharp
public List<Point> Points { get; set; }
```

### UnderlineAnnotation.UnderlineAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/underlineannotation.md

#### UnderlineAnnotation constructor

Initializes new instance of `UnderlineAnnotation` class.

```csharp
public UnderlineAnnotation()
```

### UnderlineAnnotation.UnderlineColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/underlineannotation/underlinecolor.md

#### UnderlineAnnotation.UnderlineColor property

Gets or sets underline annotation color

```csharp
public int? UnderlineColor { get; set; }
```

### Class WatermarkAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation.md

#### WatermarkAnnotation class

Represents watermark annotation properties

```csharp
public class WatermarkAnnotation : AnnotationBase, IEquatable<WatermarkAnnotation>, 
    IWatermarkAnnotation
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkAnnotation() | Initializes new instance of `WatermarkAnnotation` class. |

#### Properties

| Name | Description |
| --- | --- |
| Angle { get; set; } | Gets or sets watermark annotation rotation angle |
| AutoScale { get; set; } | Gets or sets auto scale for watermark annotation |
| Box { get; set; } | Gets or sets watermark annotation position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| FontColor { get; set; } | Gets or sets watermark annotation text color |
| FontFamily { get; set; } | Gets or sets watermark annotation text font family |
| FontSize { get; set; } | Gets or sets watermark annotation text size |
| HorizontalAlignment { get; set; } | Gets or sets watermark horizontal alignment on document |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Opacity { get; set; } | Gets or sets watermark annotation opacity |
| PageNumber { get; set; } | Page number where the annotation should be located |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Text { get; set; } | Gets or sets watermark text |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |
| VerticalAlignment { get; set; } | Gets or sets watermark vertical alignment on document |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new instance with the same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| override Equals(object) | Compares watermark annotation using standard object Equals method |
| Equals(WatermarkAnnotation) | Compares watermark annotation using IEquatable Equals method |
| override GetHashCode() | Returns HashCode of the watermark annotation |

### WatermarkAnnotation.Angle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/angle.md

#### WatermarkAnnotation.Angle property

Gets or sets watermark annotation rotation angle

```csharp
public double? Angle { get; set; }
```

### WatermarkAnnotation.AutoScale
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/autoscale.md

#### WatermarkAnnotation.AutoScale property

Gets or sets auto scale for watermark annotation

```csharp
public bool AutoScale { get; set; }
```

### WatermarkAnnotation.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/box.md

#### WatermarkAnnotation.Box property

Gets or sets watermark annotation position

```csharp
public Rectangle Box { get; set; }
```

### WatermarkAnnotation.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/clone.md

#### WatermarkAnnotation.Clone method

Returns new instance with the same values

```csharp
public override object Clone()
```

### WatermarkAnnotation.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/equals.md

#### Equals(WatermarkAnnotation)

Compares watermark annotation using IEquatable Equals method

```csharp
public bool Equals(WatermarkAnnotation other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | WatermarkAnnotation | The WatermarkAnnotation object to compare with the current object |

#### Equals(object)

Compares watermark annotation using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### WatermarkAnnotation.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/fontcolor.md

#### WatermarkAnnotation.FontColor property

Gets or sets watermark annotation text color

```csharp
public int? FontColor { get; set; }
```

### WatermarkAnnotation.FontFamily
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/fontfamily.md

#### WatermarkAnnotation.FontFamily property

Gets or sets watermark annotation text font family

```csharp
public string FontFamily { get; set; }
```

### WatermarkAnnotation.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/fontsize.md

#### WatermarkAnnotation.FontSize property

Gets or sets watermark annotation text size

```csharp
public double? FontSize { get; set; }
```

### WatermarkAnnotation.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/gethashcode.md

#### WatermarkAnnotation.GetHashCode method

Returns HashCode of the watermark annotation

```csharp
public override int GetHashCode()
```

### WatermarkAnnotation.HorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/horizontalalignment.md

#### WatermarkAnnotation.HorizontalAlignment property

Gets or sets watermark horizontal alignment on document

```csharp
public HorizontalAlignment HorizontalAlignment { get; set; }
```

### WatermarkAnnotation.Opacity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/opacity.md

#### WatermarkAnnotation.Opacity property

Gets or sets watermark annotation opacity

```csharp
public double? Opacity { get; set; }
```

### WatermarkAnnotation.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/text.md

#### WatermarkAnnotation.Text property

Gets or sets watermark text

```csharp
public string Text { get; set; }
```

### WatermarkAnnotation.VerticalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/verticalalignment.md

#### WatermarkAnnotation.VerticalAlignment property

Gets or sets watermark vertical alignment on document

```csharp
public VerticalAlignment VerticalAlignment { get; set; }
```

### WatermarkAnnotation.WatermarkAnnotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.annotationmodels/watermarkannotation/watermarkannotation.md

#### WatermarkAnnotation constructor

Initializes new instance of `WatermarkAnnotation` class.

```csharp
public WatermarkAnnotation()
```

### GroupDocs.Annotation.Models.FormatSpecificComponents.Pdf.Interfaces
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces.md

The namespace provides format specific component interfaces

#### Interfaces

| Interface | Description |
| --- | --- |
| IButtonComponent | Defines Button component properties |
| ICheckBoxComponent | Defines CheckBox component properties |
| IDropdownComponent | Defines Dropdown component properties |

### Interface IButtonComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces/ibuttoncomponent.md

#### IButtonComponent interface

Defines Button component properties

```csharp
public interface IButtonComponent : IBorderStyle, IBox
```

### Interface ICheckBoxComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces/icheckboxcomponent.md

#### ICheckBoxComponent interface

Defines CheckBox component properties

```csharp
public interface ICheckBoxComponent : IBox, IBoxStyle
```

### Interface IDropdownComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces/idropdowncomponent.md

#### IDropdownComponent interface

Defines Dropdown component properties

```csharp
public interface IDropdownComponent : IBox, IPenColor, IPenStyle, IPenWidth
```

#### Properties

| Name | Description |
| --- | --- |
| Options { get; set; } | List of options (drop down items) to be shown when component is clicked |
| Placeholder { get; set; } | Text to shown when no options has been selected yet |
| SelectedOption { get; set; } | Number of option to be selected by default |

### IDropdownComponent.Options
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces/idropdowncomponent/options.md

#### IDropdownComponent.Options property

List of options (drop down items) to be shown when component is clicked

```csharp
public List<string> Options { get; set; }
```

### IDropdownComponent.Placeholder
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces/idropdowncomponent/placeholder.md

#### IDropdownComponent.Placeholder property

Text to shown when no options has been selected yet

```csharp
public string Placeholder { get; set; }
```

### IDropdownComponent.SelectedOption
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces/idropdowncomponent/selectedoption.md

#### IDropdownComponent.SelectedOption property

Number of option to be selected by default

```csharp
public int? SelectedOption { get; set; }
```

### GroupDocs.Annotation.Models.FormatSpecificComponents.Pdf
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf.md

The namespace provides format specific component models

#### Classes

| Class | Description |
| --- | --- |
| ButtonComponent | Represents Button properties |
| CheckBoxComponent | Represents CheckBox properties |
| DropdownComponent | Represents dropdown component properties |

### Class ButtonComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent.md

#### ButtonComponent class

Represents Button properties

```csharp
public class ButtonComponent : AnnotationBase, IButtonComponent, IEquatable<ButtonComponent>
```

#### Constructors

| Name | Description |
| --- | --- |
| ButtonComponent() | Initializes new instance of `ButtonComponent` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternateName { get; set; } | Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat. |
| BorderColor { get; set; } | Gets or sets annotation border color |
| BorderWidth { get; set; } | Gets or sets annotation border width |
| Box { get; set; } | Gets or sets component position |
| ButtonColor { get; set; } | Gets or sets component color |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| NormalCaption { get; set; } | Gets or sets component normal caption |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PartialName { get; set; } | Gets or sets component partial name |
| PenColor { get; set; } | Gets or sets component pen color |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| RolloverCaption { get; set; } | Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Style { get; set; } | Gets or sets annotation border |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new Instance with same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(ButtonComponent) | Compares Button Components using IEquatable Equals method |
| override Equals(object) | Compares Button Components using standard object Equals method |
| override GetHashCode() | Returns HashCode of Button Component |

### ButtonComponent.AlternateName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/alternatename.md

#### ButtonComponent.AlternateName property

Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat.

```csharp
public string AlternateName { get; set; }
```

### ButtonComponent.BorderColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/bordercolor.md

#### ButtonComponent.BorderColor property

Gets or sets annotation border color

```csharp
public int? BorderColor { get; set; }
```

### ButtonComponent.BorderWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/borderwidth.md

#### ButtonComponent.BorderWidth property

Gets or sets annotation border width

```csharp
public int? BorderWidth { get; set; }
```

### ButtonComponent.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/box.md

#### ButtonComponent.Box property

Gets or sets component position

```csharp
public Rectangle Box { get; set; }
```

### ButtonComponent.ButtonColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/buttoncolor.md

#### ButtonComponent.ButtonColor property

Gets or sets component color

```csharp
public int? ButtonColor { get; set; }
```

### ButtonComponent.ButtonComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/buttoncomponent.md

#### ButtonComponent constructor

Initializes new instance of `ButtonComponent` class.

```csharp
public ButtonComponent()
```

### ButtonComponent.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/clone.md

#### ButtonComponent.Clone method

Returns new Instance with same values

```csharp
public override object Clone()
```

### ButtonComponent.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/equals.md

#### Equals(ButtonComponent)

Compares Button Components using IEquatable Equals method

```csharp
public bool Equals(ButtonComponent other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ButtonComponent | The ButtonComponent object to compare with the current object |

#### Equals(object)

Compares Button Components using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### ButtonComponent.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/gethashcode.md

#### ButtonComponent.GetHashCode method

Returns HashCode of Button Component

```csharp
public override int GetHashCode()
```

### ButtonComponent.NormalCaption
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/normalcaption.md

#### ButtonComponent.NormalCaption property

Gets or sets component normal caption

```csharp
public string NormalCaption { get; set; }
```

### ButtonComponent.PartialName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/partialname.md

#### ButtonComponent.PartialName property

Gets or sets component partial name

```csharp
public string PartialName { get; set; }
```

### ButtonComponent.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/pencolor.md

#### ButtonComponent.PenColor property

Gets or sets component pen color

```csharp
public int? PenColor { get; set; }
```

### ButtonComponent.RolloverCaption
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/rollovercaption.md

#### ButtonComponent.RolloverCaption property

Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.

```csharp
public string RolloverCaption { get; set; }
```

### ButtonComponent.Style
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/buttoncomponent/style.md

#### ButtonComponent.Style property

Gets or sets annotation border

```csharp
public BorderStyle? Style { get; set; }
```

### Class CheckBoxComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent.md

#### CheckBoxComponent class

Represents CheckBox properties

```csharp
public class CheckBoxComponent : AnnotationBase, ICheckBoxComponent, IEquatable<CheckBoxComponent>
```

#### Constructors

| Name | Description |
| --- | --- |
| CheckBoxComponent() | Initializes new instance of `CheckBoxComponent` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets component position |
| Checked { get; set; } | Gets or sets component checked |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets component color |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Style { get; set; } | Gets or sets style box |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new Instance with same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(CheckBoxComponent) | Compares CheckBox Components using IEquatable Equals method |
| override Equals(object) | Compares CheckBox Components using standard object Equals method |
| override GetHashCode() | Returns HashCode of CheckBox Component |

### CheckBoxComponent.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/box.md

#### CheckBoxComponent.Box property

Gets or sets component position

```csharp
public Rectangle Box { get; set; }
```

### CheckBoxComponent.CheckBoxComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/checkboxcomponent.md

#### CheckBoxComponent constructor

Initializes new instance of `CheckBoxComponent` class.

```csharp
public CheckBoxComponent()
```

### CheckBoxComponent.Checked
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/checked.md

#### CheckBoxComponent.Checked property

Gets or sets component checked

```csharp
public bool Checked { get; set; }
```

### CheckBoxComponent.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/clone.md

#### CheckBoxComponent.Clone method

Returns new Instance with same values

```csharp
public override object Clone()
```

### CheckBoxComponent.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/equals.md

#### Equals(CheckBoxComponent)

Compares CheckBox Components using IEquatable Equals method

```csharp
public bool Equals(CheckBoxComponent other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | CheckBoxComponent | The CheckBoxComponent object to compare with the current object |

#### Equals(object)

Compares CheckBox Components using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### CheckBoxComponent.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/gethashcode.md

#### CheckBoxComponent.GetHashCode method

Returns HashCode of CheckBox Component

```csharp
public override int GetHashCode()
```

### CheckBoxComponent.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/pencolor.md

#### CheckBoxComponent.PenColor property

Gets or sets component color

```csharp
public int? PenColor { get; set; }
```

### CheckBoxComponent.Style
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/checkboxcomponent/style.md

#### CheckBoxComponent.Style property

Gets or sets style box

```csharp
public BoxStyle? Style { get; set; }
```

### Class DropdownComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent.md

#### DropdownComponent class

Represents dropdown component properties

```csharp
public class DropdownComponent : AnnotationBase, IDropdownComponent
```

#### Constructors

| Name | Description |
| --- | --- |
| DropdownComponent() | Initializes new instance of `DropdownComponent` class. |

#### Properties

| Name | Description |
| --- | --- |
| Box { get; set; } | Gets or sets component position |
| CreatedOn { get; set; } | Gets or sets annotation creation date |
| Id { get; set; } | Gets or sets annotation unique identifier. This field is auto-incremented. |
| Message { get; set; } | Gets or sets annotation message |
| Options { get; set; } | List of options (drop down items) to be shown when component is clicked |
| PageNumber { get; set; } | Page number where the annotation should be located |
| PenColor { get; set; } | Gets or sets component pen color |
| PenStyle { get; set; } | Gets or sets component pen style |
| PenWidth { get; set; } | Gets or sets component pen width |
| Placeholder { get; set; } | Text to shown when no options has been selected yet |
| Replies { get; set; } | The list of replies (comments) attached to the annotation |
| SelectedOption { get; set; } | Number of option to be selected by default |
| StateBeforeAnnotation { get; set; } | Stores the previous state of the text. State that was before annotating |
| Type { get; set; } | Gets or sets annotation type |
| User { get; set; } | Gets or sets annotation author |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Returns new Instance with same values |
| Equals(AnnotationBase) | Compares Base Annotations using IEquatable Equals method |
| Equals(DropdownComponent) | Compares Dropdown component using IEquatable Equals method |
| override Equals(object) | Compares Dropdown Components using standard object Equals method |
| override GetHashCode() | Returns HashCode of Dropdown Component |

### DropdownComponent.Box
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/box.md

#### DropdownComponent.Box property

Gets or sets component position

```csharp
public Rectangle Box { get; set; }
```

### DropdownComponent.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/clone.md

#### DropdownComponent.Clone method

Returns new Instance with same values

```csharp
public override object Clone()
```

### DropdownComponent.DropdownComponent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/dropdowncomponent.md

#### DropdownComponent constructor

Initializes new instance of `DropdownComponent` class.

```csharp
public DropdownComponent()
```

### DropdownComponent.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/equals.md

#### Equals(DropdownComponent)

Compares Dropdown component using IEquatable Equals method

```csharp
public bool Equals(DropdownComponent other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | DropdownComponent | The DropdownComponent object to compare with the current object |

#### Equals(object)

Compares Dropdown Components using standard object Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object |

### DropdownComponent.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/gethashcode.md

#### DropdownComponent.GetHashCode method

Returns HashCode of Dropdown Component

```csharp
public override int GetHashCode()
```

### DropdownComponent.Options
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/options.md

#### DropdownComponent.Options property

List of options (drop down items) to be shown when component is clicked

```csharp
public List<string> Options { get; set; }
```

### DropdownComponent.PenColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/pencolor.md

#### DropdownComponent.PenColor property

Gets or sets component pen color

```csharp
public int? PenColor { get; set; }
```

### DropdownComponent.PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/penstyle.md

#### DropdownComponent.PenStyle property

Gets or sets component pen style

```csharp
public PenStyle? PenStyle { get; set; }
```

### DropdownComponent.PenWidth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/penwidth.md

#### DropdownComponent.PenWidth property

Gets or sets component pen width

```csharp
public byte? PenWidth { get; set; }
```

### DropdownComponent.Placeholder
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/placeholder.md

#### DropdownComponent.Placeholder property

Text to shown when no options has been selected yet

```csharp
public string Placeholder { get; set; }
```

### DropdownComponent.SelectedOption
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.formatspecificcomponents.pdf/dropdowncomponent/selectedoption.md

#### DropdownComponent.SelectedOption property

Number of option to be selected by default

```csharp
public int? SelectedOption { get; set; }
```

### GroupDocs.Annotation.Models
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models.md

The namespace contains various of annotation models

#### Classes

| Class | Description |
| --- | --- |
| Reply | Represents annotation comment. |
| User | Class that represents User |
| VersionsList | Class that defines serializable list of the document version information. |
#### Structures

| Structure | Description |
| --- | --- |
| PageInfo | Class that defines Document Page Information. |
| Point | Point structure |
| Rectangle | Rectangle structure |
| TextLineInfo | Class that defines text line information |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| BorderStyle | Describes all possible border styles. |
| BoxStyle | Describes all possible checkbox styles. |
| DocumentType | Describes all supported document types. |
| HorizontalAlignment | Represents annotations horizontal alignment enum |
| PenStyle | Describes all supported pen styles. |
| ResolutionQuality | Describes all supported resolutions. They are used for generating document previews |
| Role | Describes all possible user roles |
| RotationDocument | Describes all possible document rotation angles |
| VerticalAlignment | Represents annotations vertical alignment enum |

### Enum BorderStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/borderstyle.md

#### BorderStyle enumeration

Describes all possible border styles.

```csharp
public enum BorderStyle : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Solid | `0` | Solid border |
| Dashed | `1` | Dashed border |
| Beveled | `2` | Beveled border |
| Inset | `3` | Inset border |
| Underline | `4` | Underline border |

### Enum BoxStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/boxstyle.md

#### BoxStyle enumeration

Describes all possible checkbox styles.

```csharp
public enum BoxStyle : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Circle | `0` | Circle style |
| Check | `1` | Check style |
| Cross | `2` | Cross style |
| Diamond | `3` | Diamond style |
| Square | `4` | Square style |
| Star | `5` | Star style |

### Enum DocumentType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/documenttype.md

#### DocumentType enumeration

Describes all supported document types.

```csharp
public enum DocumentType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `-1` | The undefined |
| Pdf | `0` | Pdf documen type |
| Cells | `1` | Excel document type |
| Slides | `2` | PowerPoint document type |
| Words | `3` | Word document type |
| Images | `4` | Image document type |
| Email | `5` | Email document type |
| Html | `6` | HTML document type |
| Diagram | `7` | Visio document type |

### Enum HorizontalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/horizontalalignment.md

#### HorizontalAlignment enumeration

Represents annotations horizontal alignment enum

```csharp
public enum HorizontalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default value, aligned wont be used |
| Left | `1` | Target will be aligned to left side |
| Center | `2` | Target will be aligned to center |
| Right | `3` | Target will be aligned to right side |

### Struct PageInfo
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/pageinfo.md

#### PageInfo structure

Class that defines Document Page Information.

```csharp
public struct PageInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| PageInfo(int, int) | Initializes new instance of `PageInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Page height |
| PageNumber { get; set; } | Page number |
| TextLines { get; set; } | Collection of text lines information |
| Width { get; set; } | Page width |

### PageInfo.Height
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/pageinfo/height.md

#### PageInfo.Height property

Page height

```csharp
public int Height { get; set; }
```

### PageInfo.PageInfo
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/pageinfo/pageinfo.md

#### PageInfo constructor

Initializes new instance of `PageInfo` class.

```csharp
public PageInfo(int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | Int32 | Page Width. |
| height | Int32 | Page Height. |

### PageInfo.PageNumber
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Page number

```csharp
public int PageNumber { get; set; }
```

### PageInfo.TextLines
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/pageinfo/textlines.md

#### PageInfo.TextLines property

Collection of text lines information

```csharp
public List<TextLineInfo> TextLines { get; set; }
```

### PageInfo.Width
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/pageinfo/width.md

#### PageInfo.Width property

Page width

```csharp
public int Width { get; set; }
```

### Enum PenStyle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/penstyle.md

#### PenStyle enumeration

Describes all supported pen styles.

```csharp
public enum PenStyle : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Solid | `0` | Specifies a solid line |
| Dash | `1` | Specifies a dashed line |
| DashDot | `2` | Specifies a line consisting of dashes and dots |
| Dot | `3` | Specifies a dotted line |
| LongDash | `4` | Specifies a line consisting of long dashes |
| DashDotDot | `5` | Specifies a line consisting of dashes and two dots |

### Struct Point
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point.md

#### Point structure

Point structure

```csharp
public struct Point
```

#### Constructors

| Name | Description |
| --- | --- |
| Point(float, float) | Initializes a new instance of the `Point` struct. |

#### Properties

| Name | Description |
| --- | --- |
| X { get; set; } | Gets or sets the X coordinate value. |
| Y { get; set; } | Gets or sets the Y coordinate value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether the specified point is equal to the current point. |
| override GetHashCode() | Serves as the default hash function. |
| operator == | Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are equal. |
| operator != | Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are not equal. |

### Point.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/equals.md

#### Point.Equals method

Determines whether the specified point is equal to the current point.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The point to compare with the current point. |

##### Return Value

`true` if the specified point is equal to the current point; otherwise, `false`.

### Point.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/gethashcode.md

#### Point.GetHashCode method

Serves as the default hash function.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current point.

### Point.op_Equality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/op_equality.md

#### Point Equality operator

Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are equal.

```csharp
public static bool operator ==(Point left, Point right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Point | A Point to compare. |
| right | Point | A Point to compare. |

##### Return Value

true if the Point.X and Point.Y values of left and right are equal; otherwise, false.

### Point.op_Inequality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/op_inequality.md

#### Point Inequality operator

Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are not equal.

```csharp
public static bool operator !=(Point left, Point right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Point | A Point to compare. |
| right | Point | A Point to compare. |

##### Return Value

true if the Point.X and Point.Y values of left and right are not equal; otherwise, false.

### Point.Point
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/point.md

#### Point constructor

Initializes a new instance of the `Point` struct.

```csharp
public Point(float x, float y)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | Single | The x coordinate |
| y | Single | The y coordinate |

### Point.X
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/x.md

#### Point.X property

Gets or sets the X coordinate value.

```csharp
public float X { get; set; }
```

### Point.Y
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/point/y.md

#### Point.Y property

Gets or sets the Y coordinate value.

```csharp
public float Y { get; set; }
```

### Struct Rectangle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle.md

#### Rectangle structure

Rectangle structure

```csharp
public struct Rectangle
```

#### Constructors

| Name | Description |
| --- | --- |
| Rectangle(float, float, float, float) | Initializes a new instance of the `Rectangle` struct. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Gets or sets the height of the rectangle |
| Width { get; set; } | Gets or sets the width of the rectangle |
| X { get; set; } | Gets or sets the X coordinate |
| Y { get; set; } | Gets or sets the Y coordinate |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether the specified rectangle is equal to the current rectangle. |
| override GetHashCode() | Serves as the default hash function. |
| operator == | Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are equal. |
| operator != | Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are not equal. |

### Rectangle.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/equals.md

#### Rectangle.Equals method

Determines whether the specified rectangle is equal to the current rectangle.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The rectangle to compare with the current rectangle. |

##### Return Value

`true` if the specified rectangle is equal to the current rectangle; otherwise, `false`.

### Rectangle.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/gethashcode.md

#### Rectangle.GetHashCode method

Serves as the default hash function.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current rectangle.

### Rectangle.Height
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/height.md

#### Rectangle.Height property

Gets or sets the height of the rectangle

```csharp
public float Height { get; set; }
```

### Rectangle.op_Equality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/op_equality.md

#### Rectangle Equality operator

Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are equal.

```csharp
public static bool operator ==(Rectangle left, Rectangle right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Rectangle | A Rectangle to compare. |
| right | Rectangle | A Rectangle to compare. |

##### Return Value

true if the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values of left and right are equal; otherwise, false.

### Rectangle.op_Inequality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/op_inequality.md

#### Rectangle Inequality operator

Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are not equal.

```csharp
public static bool operator !=(Rectangle left, Rectangle right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Rectangle | A Rectangle to compare. |
| right | Rectangle | A Rectangle to compare. |

##### Return Value

true if the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values of left and right are not equal; otherwise, false.

### Rectangle.Rectangle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/rectangle.md

#### Rectangle constructor

Initializes a new instance of the `Rectangle` struct.

```csharp
public Rectangle(float x, float y, float width, float height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | Single | The x coordinate (top left corner of the rectangle) |
| y | Single | The y coordinate (top left corner of the rectangle) |
| width | Single | The width of the rectangle |
| height | Single | The height of the rectangle |

### Rectangle.Width
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/width.md

#### Rectangle.Width property

Gets or sets the width of the rectangle

```csharp
public float Width { get; set; }
```

### Rectangle.X
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/x.md

#### Rectangle.X property

Gets or sets the X coordinate

```csharp
public float X { get; set; }
```

### Rectangle.Y
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rectangle/y.md

#### Rectangle.Y property

Gets or sets the Y coordinate

```csharp
public float Y { get; set; }
```

### Class Reply
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply.md

#### Reply class

Represents annotation comment.

```csharp
public class Reply : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| Reply() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Comment { get; set; } | Comment text content |
| Id { get; set; } | Comment identificator |
| ParentReply { get; set; } | Parent сomment (in case current one is a reply to the original one) |
| RepliedOn { get; set; } | Comment creation date and time |
| User { get; set; } | Comment author |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Returns new Instance with same values |

### Reply.Clone
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/clone.md

#### Reply.Clone method

Returns new Instance with same values

```csharp
public object Clone()
```

### Reply.Comment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/comment.md

#### Reply.Comment property

Comment text content

```csharp
public string Comment { get; set; }
```

### Reply.Id
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/id.md

#### Reply.Id property

Comment identificator

```csharp
public int Id { get; set; }
```

### Reply.ParentReply
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/parentreply.md

#### Reply.ParentReply property

Parent сomment (in case current one is a reply to the original one)

```csharp
public Reply ParentReply { get; set; }
```

### Reply.RepliedOn
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/repliedon.md

#### Reply.RepliedOn property

Comment creation date and time

```csharp
public DateTime RepliedOn { get; set; }
```

### Reply.Reply
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/reply.md

#### Reply constructor

The default constructor.

```csharp
public Reply()
```

### Reply.User
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/reply/user.md

#### Reply.User property

Comment author

```csharp
public User User { get; set; }
```

### Enum ResolutionQuality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/resolutionquality.md

#### ResolutionQuality enumeration

Describes all supported resolutions. They are used for generating document previews

```csharp
public enum ResolutionQuality : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default quality |
| Low | `1` | Allows to create documents of small size with a low image quality |
| Medium | `2` | Allows to create documents of medium size with a good image quality |
| High | `3` | Allows to create documents of big size with a high image quality |

### Enum Role
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/role.md

#### Role enumeration

Describes all possible user roles

```csharp
public enum Role
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Viewer | `0` | Viewer can only view comments |
| Editor | `1` | Editor can view and edit comments |

### Enum RotationDocument
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/rotationdocument.md

#### RotationDocument enumeration

Describes all possible document rotation angles

```csharp
public enum RotationDocument : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default one. Document is not rotated. |
| on90 | `1` | Rotate the document 90 degrees |
| on180 | `2` | Rotate the document 180 degrees |
| on270 | `3` | Rotate the document 270 degrees |

### Struct TextLineInfo
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/textlineinfo.md

#### TextLineInfo structure

Class that defines text line information

```csharp
public struct TextLineInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Line height |
| LeftIndent { get; set; } | Indent from left |
| Text { get; set; } | Line text content |
| TopIndent { get; set; } | Indent from top |
| Width { get; set; } | Line width |

### TextLineInfo.Height
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/textlineinfo/height.md

#### TextLineInfo.Height property

Line height

```csharp
public double Height { get; set; }
```

### TextLineInfo.LeftIndent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/textlineinfo/leftindent.md

#### TextLineInfo.LeftIndent property

Indent from left

```csharp
public double LeftIndent { get; set; }
```

### TextLineInfo.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/textlineinfo/text.md

#### TextLineInfo.Text property

Line text content

```csharp
public string Text { get; set; }
```

### TextLineInfo.TopIndent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/textlineinfo/topindent.md

#### TextLineInfo.TopIndent property

Indent from top

```csharp
public double TopIndent { get; set; }
```

### TextLineInfo.Width
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/textlineinfo/width.md

#### TextLineInfo.Width property

Line width

```csharp
public double Width { get; set; }
```

### Class User
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/user.md

#### User class

Class that represents User

```csharp
public class User
```

#### Constructors

| Name | Description |
| --- | --- |
| User() | Initializes new instance of `User` class. |
| User(int, string, Role) | Initializes new instance of `User` class. |

#### Properties

| Name | Description |
| --- | --- |
| Email { get; set; } | User email address |
| Id { get; set; } | User udentificator |
| Name { get; set; } | User name |
| Role { get; set; } | User role |

### User.Email
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/user/email.md

#### User.Email property

User email address

```csharp
public string Email { get; set; }
```

### User.Id
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/user/id.md

#### User.Id property

User udentificator

```csharp
public int Id { get; set; }
```

### User.Name
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/user/name.md

#### User.Name property

User name

```csharp
public string Name { get; set; }
```

### User.Role
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/user/role.md

#### User.Role property

User role

```csharp
public Role Role { get; set; }
```

### User.User
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/user/user.md

#### User()

Initializes new instance of `User` class.

```csharp
public User()
```

#### User(int, string, Role)

Initializes new instance of `User` class.

```csharp
public User(int id, string name, Role role)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | Int32 | The user id. |
| name | String | The user name. |
| role | Role | The user role. |

### Class VersionsList
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist.md

#### VersionsList class

Class that defines serializable list of the document version information.

```csharp
public class VersionsList
```

#### Constructors

| Name | Description |
| --- | --- |
| VersionsList() | Default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Version { get; set; } | Current version |
| VersionsDictionary { get; set; } |  |

#### Methods

| Name | Description |
| --- | --- |
| AddVersion(List&lt;AnnotationBase&gt;) | Add list of the annotations. |
| AddVersion(object, List&lt;AnnotationBase&gt;) | Add list of annotations per version ley |
| GetLastVersionKey() |  |
| GetPenultimateVersionKey() |  |
| GetVersion() |  |
| GetVersion(object) |  |
| GetVersionKeyByValue(List&lt;AnnotationBase&gt;) |  |
| ReplaceLastVersion(List&lt;AnnotationBase&gt;) |  |

### VersionsList.AddVersion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/addversion.md

#### AddVersion(List&lt;AnnotationBase&gt;)

Add list of the annotations.

```csharp
public void AddVersion(List<AnnotationBase> annotations)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotations | List`1 | List of the annocations to add. `AnnotationBase` |

#### AddVersion(object, List&lt;AnnotationBase&gt;)

Add list of annotations per version ley

```csharp
public void AddVersion(object newVersionKey, List<AnnotationBase> annotations)
```

| Parameter | Type | Description |
| --- | --- | --- |
| newVersionKey | Object | Key of the version |
| annotations | List`1 | List of the annotations |

##### Exceptions

| exception | condition |
| --- | --- |
| Exception | Throws an exception if version key already exists |

### VersionsList.GetLastVersionKey
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/getlastversionkey.md

#### VersionsList.GetLastVersionKey method

```csharp
public object GetLastVersionKey()
```

### VersionsList.GetPenultimateVersionKey
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/getpenultimateversionkey.md

#### VersionsList.GetPenultimateVersionKey method

```csharp
public object GetPenultimateVersionKey()
```

### VersionsList.GetVersion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/getversion.md

#### GetVersion(object)

```csharp
public List<AnnotationBase> GetVersion(object versionKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| versionKey | Object |  |

#### GetVersion()

```csharp
public List<AnnotationBase> GetVersion()
```

### VersionsList.GetVersionKeyByValue
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/getversionkeybyvalue.md

#### VersionsList.GetVersionKeyByValue method

```csharp
public object GetVersionKeyByValue(List<AnnotationBase> annotations)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotations | List`1 |  |

### VersionsList.ReplaceLastVersion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/replacelastversion.md

#### VersionsList.ReplaceLastVersion method

```csharp
public void ReplaceLastVersion(List<AnnotationBase> annotations)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotations | List`1 |  |

### VersionsList.Version
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/version.md

#### VersionsList.Version property

Current version

```csharp
public object Version { get; set; }
```

### VersionsList.VersionsDictionary
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/versionsdictionary.md

#### VersionsList.VersionsDictionary property

```csharp
public SerializableDictionary<object, List<AnnotationBase>> VersionsDictionary { get; set; }
```

### VersionsList.VersionsList
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/versionslist/versionslist.md

#### VersionsList constructor

Default constructor.

```csharp
public VersionsList()
```

### Enum VerticalAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.models/verticalalignment.md

#### VerticalAlignment enumeration

Represents annotations vertical alignment enum

```csharp
public enum VerticalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default value, aligned wont be used |
| Top | `1` | Target will be aligned to top side |
| Center | `2` | Target will be aligned to center |
| Bottom | `3` | Target will be aligned to bottom side |

### GroupDocs.Annotation.Options
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options.md

The namespace provides classes to specify additional options when loading, annotating and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Delegate that defines method to create output page preview stream. |
| LoadOptions | Allows to specify additional options (such as password) when opening a document to annotate. |
| PreviewOptions | Represents document preview options. |
| ReleasePageStream | Delegate that defines method to release output page preview stream. |
| SaveOptions | Allows to specify additional options (such as password) when saving annotated document. |
| WorksheetColumnsRange | Represents a range of columns for a specified worksheet |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| AnnotationType | Enumeration that decribes annotation types supported by GroupDocs.Annotation for .NET |
| PreviewFormats | Document preview supported formats. |

### Enum AnnotationType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/annotationtype.md

#### AnnotationType enumeration

Enumeration that decribes annotation types supported by GroupDocs.Annotation for .NET

```csharp
[Flags]
public enum AnnotationType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default value |
| Area | `2` | The area annotation type that highlights rectangular area within the document page |
| Arrow | `4` | The annotation type that draws an arrow on the document page |
| Distance | `8` | The annotation type that measures distance between elements of a document page |
| Ellipse | `10` | The annotation of elliptic form that marks parts of document content |
| Link | `20` | The annotation type that represents a hyperlink to a remote resource |
| Point | `40` | The point annotation type that sticks a comment to an any place within document page |
| Polyline | `80` | The polyline annotation type that allows add drawing shapes and freehand lines to a document page |
| ResourcesRedaction | `100` | The annotation type that hides textual content behind black rectangle |
| TextField | `200` | The text field annotation type represents textual comment inside colored frame |
| TextHighlight | `400` | The annotation type that highlights and comments selected text |
| TextRedaction | `800` | The annotation type that fills part of selected text with black rectangle. |
| TextReplacement | `1000` | The annotation type that replaces original text with other provided text fragment |
| TextStrikeout | `2000` | The annotation type that marks text fragment with a strikethrough styling |
| TextUnderline | `4000` | The annotation type that marks text with a underline styling |
| Watermark | `8000` | The annotation type that adds textual watermark over document page |
| Image | `10000` | The annotation type that adds image overlay over document page content |
| Dropdown | `20000` | The component type that adds dropdown component for pdf document **only** |
| Checkbox | `21000` | The annotation type that adds checkbox for pdf document |
| Button | `22000` | The annotation type that adds button for pdf document |
| TextSquiggly | `2500` | The annotation type that squiggly and comments selected text |
| SearchText | `2700` | The annotation type that search fragment text in document |
| All | `7FFFFFFF` | All |

### Delegate CreatePageStream
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/createpagestream.md

#### CreatePageStream delegate

Delegate that defines method to create output page preview stream.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number. |

### Class LoadOptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/loadoptions.md

#### LoadOptions class

Allows to specify additional options (such as password) when opening a document to annotate.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| FontDirectories { get; set; } | List of font directories to load custom fonts from |
| Password { get; set; } | Document password |
| Version { get; set; } | Sets what version of document will be load. Default State - last |

### LoadOptions.FontDirectories
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/loadoptions/fontdirectories.md

#### LoadOptions.FontDirectories property

List of font directories to load custom fonts from

```csharp
public List<string> FontDirectories { get; set; }
```

### LoadOptions.LoadOptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/loadoptions/loadoptions.md

#### LoadOptions constructor

The default constructor.

```csharp
public LoadOptions()
```

### LoadOptions.Password
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/loadoptions/password.md

#### LoadOptions.Password property

Document password

```csharp
public string Password { get; set; }
```

### LoadOptions.Version
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/loadoptions/version.md

#### LoadOptions.Version property

Sets what version of document will be load. Default State - last

```csharp
public object Version { get; set; }
```

### Enum PreviewFormats
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewformats.md

#### PreviewFormats enumeration

Document preview supported formats.

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | Png (by default), can be take a lot of disc space / traffic if page contains a lot of color graphics |
| JPEG | `1` | Jpeg - faster processing, small disc space using / traffic, but can be worst quality |
| BMP | `2` | BMP - slow processing, high disc space usage / traffic, but best quality |

### Class PreviewOptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions.md

#### PreviewOptions class

Represents document preview options.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream) | Initializes a new instance of `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PreviewOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Delegate which defines method to create output page preview stream. |
| Height { get; set; } | Page preview height. |
| PageNumbers { get; set; } | Page numbers that will be previewed. |
| PreviewFormat { get; set; } | Preview image format. |
| ReleasePageStream { get; set; } | Delegate which defines method to remove output page preview stream |
| RenderAnnotations { get; set; } | The property that controls whether annotations will be generated on the preview. Default State - true. |
| RenderComments { get; set; } | The property that controls whether comments will be generated on the preview. Default State - true. Now Supported only in MS Word document |
| Resolution { get; set; } | Gets or sets the resolution for generated images, in dots per inch. |
| Width { get; set; } | Page preview width. |
| WorksheetColumns { get; set; } | Worksheet columns to generate. Generation proceeds in the specified order. |

### PreviewOptions.CreatePageStream
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/createpagestream.md

#### PreviewOptions.CreatePageStream property

Delegate which defines method to create output page preview stream.

```csharp
public CreatePageStream CreatePageStream { get; set; }
```

### PreviewOptions.Height
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/height.md

#### PreviewOptions.Height property

Page preview height.

```csharp
public int Height { get; set; }
```

### PreviewOptions.PageNumbers
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Page numbers that will be previewed.

```csharp
public int[] PageNumbers { get; set; }
```

### PreviewOptions.PreviewFormat
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Preview image format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewOptions.PreviewOptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream)

Initializes a new instance of `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |

#### PreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |
| releasePageStream | ReleasePageStream | Delegate which defines method to release output page preview stream. |

### PreviewOptions.ReleasePageStream
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/releasepagestream.md

#### PreviewOptions.ReleasePageStream property

Delegate which defines method to remove output page preview stream

```csharp
public ReleasePageStream ReleasePageStream { get; set; }
```

### PreviewOptions.RenderAnnotations
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/renderannotations.md

#### PreviewOptions.RenderAnnotations property

The property that controls whether annotations will be generated on the preview. Default State - true.

```csharp
public bool RenderAnnotations { get; set; }
```

### PreviewOptions.RenderComments
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/rendercomments.md

#### PreviewOptions.RenderComments property

The property that controls whether comments will be generated on the preview. Default State - true. Now Supported only in MS Word document

```csharp
public bool RenderComments { get; set; }
```

### PreviewOptions.Resolution
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/resolution.md

#### PreviewOptions.Resolution property

Gets or sets the resolution for generated images, in dots per inch.

```csharp
public int Resolution { get; set; }
```

#### Remarks

The default value is 96.

### PreviewOptions.Width
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/width.md

#### PreviewOptions.Width property

Page preview width.

```csharp
public int Width { get; set; }
```

### PreviewOptions.WorksheetColumns
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/previewoptions/worksheetcolumns.md

#### PreviewOptions.WorksheetColumns property

Worksheet columns to generate. Generation proceeds in the specified order.

```csharp
public List<WorksheetColumnsRange> WorksheetColumns { get; set; }
```

### Delegate ReleasePageStream
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/releasepagestream.md

#### ReleasePageStream delegate

Delegate that defines method to release output page preview stream.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number. |
| pageStream | Stream | The page stream. |

### Class SaveOptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions.md

#### SaveOptions class

Allows to specify additional options (such as password) when saving annotated document.

```csharp
public class SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AnnotationTypes { get; set; } | Defines what annotations will be in resultant document. |
| FirstPage { get; set; } | First page number when saving page range. |
| LastPage { get; set; } | Last page number when saving page range. |
| OnlyAnnotatedPages { get; set; } | Indicates whether to save only annotated pages or not;. |
| Version { get; set; } | Version Key that will be used to access current version |

### SaveOptions.AnnotationTypes
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions/annotationtypes.md

#### SaveOptions.AnnotationTypes property

Defines what annotations will be in resultant document.

```csharp
public AnnotationType AnnotationTypes { get; set; }
```

### SaveOptions.FirstPage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions/firstpage.md

#### SaveOptions.FirstPage property

First page number when saving page range.

```csharp
public int FirstPage { get; set; }
```

### SaveOptions.LastPage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions/lastpage.md

#### SaveOptions.LastPage property

Last page number when saving page range.

```csharp
public int LastPage { get; set; }
```

### SaveOptions.OnlyAnnotatedPages
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions/onlyannotatedpages.md

#### SaveOptions.OnlyAnnotatedPages property

Indicates whether to save only annotated pages or not;.

```csharp
public bool OnlyAnnotatedPages { get; set; }
```

### SaveOptions.SaveOptions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions/saveoptions.md

#### SaveOptions constructor

The default constructor.

```csharp
public SaveOptions()
```

### SaveOptions.Version
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/saveoptions/version.md

#### SaveOptions.Version property

Version Key that will be used to access current version

```csharp
public object Version { get; set; }
```

### Class WorksheetColumnsRange
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/worksheetcolumnsrange.md

#### WorksheetColumnsRange class

Represents a range of columns for a specified worksheet

```csharp
public class WorksheetColumnsRange
```

#### Constructors

| Name | Description |
| --- | --- |
| WorksheetColumnsRange(int, int, int) | Initializes a new instance of `WorksheetColumnsRange` class. |
| WorksheetColumnsRange(string, int, int) | Initializes a new instance of `WorksheetColumnsRange` class. |

### WorksheetColumnsRange.WorksheetColumnsRange
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.options/worksheetcolumnsrange/worksheetcolumnsrange.md

#### WorksheetColumnsRange(int, int, int)

Initializes a new instance of `WorksheetColumnsRange` class.

```csharp
public WorksheetColumnsRange(int worksheetIndex, int firstColumn, int lastColumn)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | Worksheet index |
| firstColumn | Int32 | First column |
| lastColumn | Int32 | Last column |

#### WorksheetColumnsRange(string, int, int)

Initializes a new instance of `WorksheetColumnsRange` class.

```csharp
public WorksheetColumnsRange(string worksheetName, int firstColumn, int lastColumn)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetName | String | Worksheet name |
| firstColumn | Int32 | First column |
| lastColumn | Int32 | Last column |

### GroupDocs.Annotation.Projects.Cells.Models
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models.md

The namespace provides classes to store information about the text

#### Classes

| Class | Description |
| --- | --- |
| CellDefaultState | The class stores information about the state of the text before annotation |
| CharDefaultState | class that stores information about the text |

### Class CellDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate.md

#### CellDefaultState class

The class stores information about the state of the text before annotation

```csharp
public class CellDefaultState
```

#### Constructors

| Name | Description |
| --- | --- |
| CellDefaultState() | Initialize instance of the CellDefaultState with default values. |

#### Fields

| Name | Description |
| --- | --- |
| FontColor | Font Color of text |
| ForegroundArgbColor | Foreground Argb Color of text |
| Pattern | Pattern pf text |
| Strikeout | Strikeout of text |
| Underline | Underline of text |
| Value | Value |
| X | X-axis location |
| Y | Y-axis location |

### CellDefaultState.CellDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/celldefaultstate.md

#### CellDefaultState constructor

Initialize instance of the CellDefaultState with default values.

```csharp
public CellDefaultState()
```

### CellDefaultState.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/fontcolor.md

#### CellDefaultState.FontColor field

Font Color of text

```csharp
public int FontColor;
```

### CellDefaultState.ForegroundArgbColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/foregroundargbcolor.md

#### CellDefaultState.ForegroundArgbColor field

Foreground Argb Color of text

```csharp
public int ForegroundArgbColor;
```

### CellDefaultState.Pattern
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/pattern.md

#### CellDefaultState.Pattern field

Pattern pf text

```csharp
public int Pattern;
```

### CellDefaultState.Strikeout
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/strikeout.md

#### CellDefaultState.Strikeout field

Strikeout of text

```csharp
public bool Strikeout;
```

### CellDefaultState.Underline
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/underline.md

#### CellDefaultState.Underline field

Underline of text

```csharp
public int Underline;
```

### CellDefaultState.Value
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/value.md

#### CellDefaultState.Value field

Value

```csharp
public object Value;
```

### CellDefaultState.X
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/x.md

#### CellDefaultState.X field

X-axis location

```csharp
public int X;
```

### CellDefaultState.Y
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/celldefaultstate/y.md

#### CellDefaultState.Y field

Y-axis location

```csharp
public int Y;
```

### Class CharDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate.md

#### CharDefaultState class

class that stores information about the text

```csharp
public class CharDefaultState
```

#### Constructors

| Name | Description |
| --- | --- |
| CharDefaultState() | The default constructor. |

#### Fields

| Name | Description |
| --- | --- |
| ArgbColor | Argb Color of text |
| FontName | Font family |
| FontSize | Font size of text |
| IsBold | Text Boldness |
| IsItalic | IsItalic |
| IsStrikeout | IsStrikeout |
| Length | Length of text |
| Start | Start of text |
| Underline | Underline |

### CharDefaultState.ArgbColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/argbcolor.md

#### CharDefaultState.ArgbColor field

Argb Color of text

```csharp
public int ArgbColor;
```

### CharDefaultState.CharDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/chardefaultstate.md

#### CharDefaultState constructor

The default constructor.

```csharp
public CharDefaultState()
```

### CharDefaultState.FontName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/fontname.md

#### CharDefaultState.FontName field

Font family

```csharp
public string FontName;
```

### CharDefaultState.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/fontsize.md

#### CharDefaultState.FontSize field

Font size of text

```csharp
public int FontSize;
```

### CharDefaultState.IsBold
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/isbold.md

#### CharDefaultState.IsBold field

Text Boldness

```csharp
public bool IsBold;
```

### CharDefaultState.IsItalic
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/isitalic.md

#### CharDefaultState.IsItalic field

IsItalic

```csharp
public bool IsItalic;
```

### CharDefaultState.IsStrikeout
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/isstrikeout.md

#### CharDefaultState.IsStrikeout field

IsStrikeout

```csharp
public bool IsStrikeout;
```

### CharDefaultState.Length
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/length.md

#### CharDefaultState.Length field

Length of text

```csharp
public int Length;
```

### CharDefaultState.Start
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/start.md

#### CharDefaultState.Start field

Start of text

```csharp
public int Start;
```

### CharDefaultState.Underline
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.cells.models/chardefaultstate/underline.md

#### CharDefaultState.Underline field

Underline

```csharp
public int Underline;
```

### GroupDocs.Annotation.Projects.Diagram.Models
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models.md

The namespace provides classes to store information about the text, annotated fragments, char state

#### Classes

| Class | Description |
| --- | --- |
| AnnotatedFragment | annotated text fragment |
| AnnotationExtended | Annotation Extended |
| AnnotationPosition | Annotation position |
| CharState | Stores information about the state before the annotation |
| FormatTxtState | Format text state |
| ParagraphState | Stores information about the status of the paragraph |
| Portion | Class of portion |
| SaveLoadFormat | Save load format |
| ShapeDefaultState | Chronologizes information about the text before applying a text annotation to it |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| AnnotationElement | Annotation Element |

### Class AnnotatedFragment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotatedfragment.md

#### AnnotatedFragment class

annotated text fragment

```csharp
public class AnnotatedFragment
```

#### Constructors

| Name | Description |
| --- | --- |
| AnnotatedFragment(string, Rectangle) |  |

#### Properties

| Name | Description |
| --- | --- |
| Rectangle { get; set; } | Rectangle area |
| Text { get; set; } | Text |

### AnnotatedFragment.AnnotatedFragment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotatedfragment/annotatedfragment.md

#### AnnotatedFragment constructor

```csharp
public AnnotatedFragment(string text, Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The text of fragment |
| rectangle | Rectangle | The rectangle area |

### AnnotatedFragment.Rectangle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotatedfragment/rectangle.md

#### AnnotatedFragment.Rectangle property

Rectangle area

```csharp
public Rectangle Rectangle { get; set; }
```

### AnnotatedFragment.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotatedfragment/text.md

#### AnnotatedFragment.Text property

Text

```csharp
public string Text { get; set; }
```

### Enum AnnotationElement
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationelement.md

#### AnnotationElement enumeration

Annotation Element

```csharp
public enum AnnotationElement
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PenColor | `0` | Specifies pen color property |
| BackgroundColor | `1` | Specifies background color property |

### Class AnnotationExtended
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended.md

#### AnnotationExtended class

Annotation Extended

```csharp
public class AnnotationExtended
```

#### Constructors

| Name | Description |
| --- | --- |
| AnnotationExtended(AnnotationBase) | Creates instance with predefined annotation `AnnotationBase` |

#### Properties

| Name | Description |
| --- | --- |
| AfterLastPortion { get; set; } | After Last Portion |
| Annotation { get; } | Annotation |
| Begin { get; set; } | beginning of annotated text |
| End { get; set; } | end of the annotated text |
| FirstPortion { get; set; } | First Portion |
| Fragments { get; set; } | list of text fragments |
| WordRectangles { get; } | Word Rectangles |

### AnnotationExtended.AfterLastPortion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/afterlastportion.md

#### AnnotationExtended.AfterLastPortion property

After Last Portion

```csharp
public Portion AfterLastPortion { get; set; }
```

### AnnotationExtended.Annotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/annotation.md

#### AnnotationExtended.Annotation property

Annotation

```csharp
public AnnotationBase Annotation { get; }
```

### AnnotationExtended.AnnotationExtended
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/annotationextended.md

#### AnnotationExtended constructor

Creates instance with predefined annotation `AnnotationBase`

```csharp
public AnnotationExtended(AnnotationBase annotation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotation | AnnotationBase |  |

### AnnotationExtended.Begin
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/begin.md

#### AnnotationExtended.Begin property

beginning of annotated text

```csharp
public int? Begin { get; set; }
```

### AnnotationExtended.End
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/end.md

#### AnnotationExtended.End property

end of the annotated text

```csharp
public int? End { get; set; }
```

### AnnotationExtended.FirstPortion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/firstportion.md

#### AnnotationExtended.FirstPortion property

First Portion

```csharp
public Portion FirstPortion { get; set; }
```

### AnnotationExtended.Fragments
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/fragments.md

#### AnnotationExtended.Fragments property

list of text fragments

```csharp
public List<AnnotatedFragment> Fragments { get; set; }
```

### AnnotationExtended.WordRectangles
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationextended/wordrectangles.md

#### AnnotationExtended.WordRectangles property

Word Rectangles

```csharp
public List<Rectangle> WordRectangles { get; }
```

### Class AnnotationPosition
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationposition.md

#### AnnotationPosition class

Annotation position

```csharp
public class AnnotationPosition
```

#### Constructors

| Name | Description |
| --- | --- |
| AnnotationPosition() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Begin { get; set; } | start of annotation |
| End { get; set; } | End of annotation |
| Position { get; set; } | annotation position |

### AnnotationPosition.AnnotationPosition
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationposition/annotationposition.md

#### AnnotationPosition constructor

The default constructor.

```csharp
public AnnotationPosition()
```

### AnnotationPosition.Begin
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationposition/begin.md

#### AnnotationPosition.Begin property

start of annotation

```csharp
public int? Begin { get; set; }
```

### AnnotationPosition.End
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationposition/end.md

#### AnnotationPosition.End property

End of annotation

```csharp
public int End { get; set; }
```

### AnnotationPosition.Position
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/annotationposition/position.md

#### AnnotationPosition.Position property

annotation position

```csharp
public int Position { get; set; }
```

### Class CharState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate.md

#### CharState class

Stores information about the state before the annotation

```csharp
public class CharState
```

#### Constructors

| Name | Description |
| --- | --- |
| CharState() | Initialize default instance of the CharState |

#### Fields

| Name | Description |
| --- | --- |
| AsianFont | Asian Font |
| AsianFontName | Asian Font Name |
| Case | Case of char |
| Color | color of char |
| ColorTrans | Color trans |
| ComplexScriptFont | Complex Script Font |
| ComplexScriptFontName | Complex Script Font Name |
| ComplexScriptSize | Complex Script Size |
| DblUnderline | Double underline |
| Del | Del |
| DoubleStrikethrough | Double strikethrough |
| Font | Font of char |
| FontName | Font name |
| FontScale | font scale |
| Highlight | highlight |
| IX | IX |
| LangID | Lang id |
| Letterspace | Letterspace of char |
| Locale | Locale |
| LocalizeFont | LocalizeFont |
| Overline | Overline |
| Perpendicular | Perpendicular |
| Pos | Pos |
| RTLText | RTLText |
| Size | Size of char |
| Strikethru | Strikethru |
| Style | Style of char |
| UseVertical | Use Vertical |

### CharState.AsianFont
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/asianfont.md

#### CharState.AsianFont field

Asian Font

```csharp
public int AsianFont;
```

### CharState.AsianFontName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/asianfontname.md

#### CharState.AsianFontName field

Asian Font Name

```csharp
public string AsianFontName;
```

### CharState.Case
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/case.md

#### CharState.Case field

Case of char

```csharp
public int Case;
```

### CharState.CharState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/charstate.md

#### CharState constructor

Initialize default instance of the CharState

```csharp
public CharState()
```

### CharState.Color
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/color.md

#### CharState.Color field

color of char

```csharp
public string Color;
```

### CharState.ColorTrans
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/colortrans.md

#### CharState.ColorTrans field

Color trans

```csharp
public double ColorTrans;
```

### CharState.ComplexScriptFont
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/complexscriptfont.md

#### CharState.ComplexScriptFont field

Complex Script Font

```csharp
public int ComplexScriptFont;
```

### CharState.ComplexScriptFontName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/complexscriptfontname.md

#### CharState.ComplexScriptFontName field

Complex Script Font Name

```csharp
public string ComplexScriptFontName;
```

### CharState.ComplexScriptSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/complexscriptsize.md

#### CharState.ComplexScriptSize field

Complex Script Size

```csharp
public double ComplexScriptSize;
```

### CharState.DblUnderline
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/dblunderline.md

#### CharState.DblUnderline field

Double underline

```csharp
public int DblUnderline;
```

### CharState.Del
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/del.md

#### CharState.Del field

Del

```csharp
public int Del;
```

### CharState.DoubleStrikethrough
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/doublestrikethrough.md

#### CharState.DoubleStrikethrough field

Double strikethrough

```csharp
public int DoubleStrikethrough;
```

### CharState.Font
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/font.md

#### CharState.Font field

Font of char

```csharp
public int Font;
```

### CharState.FontName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/fontname.md

#### CharState.FontName field

Font name

```csharp
public string FontName;
```

### CharState.FontScale
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/fontscale.md

#### CharState.FontScale field

font scale

```csharp
public double FontScale;
```

### CharState.Highlight
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/highlight.md

#### CharState.Highlight field

highlight

```csharp
public int Highlight;
```

### CharState.IX
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/ix.md

#### CharState.IX field

IX

```csharp
public int IX;
```

### CharState.LangID
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/langid.md

#### CharState.LangID field

Lang id

```csharp
public int LangID;
```

### CharState.Letterspace
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/letterspace.md

#### CharState.Letterspace field

Letterspace of char

```csharp
public double Letterspace;
```

### CharState.Locale
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/locale.md

#### CharState.Locale field

Locale

```csharp
public string Locale;
```

### CharState.LocalizeFont
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/localizefont.md

#### CharState.LocalizeFont field

LocalizeFont

```csharp
public int LocalizeFont;
```

### CharState.Overline
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/overline.md

#### CharState.Overline field

Overline

```csharp
public int Overline;
```

### CharState.Perpendicular
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/perpendicular.md

#### CharState.Perpendicular field

Perpendicular

```csharp
public string Perpendicular;
```

### CharState.Pos
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/pos.md

#### CharState.Pos field

Pos

```csharp
public int Pos;
```

### CharState.RTLText
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/rtltext.md

#### CharState.RTLText field

RTLText

```csharp
public int RTLText;
```

### CharState.Size
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/size.md

#### CharState.Size field

Size of char

```csharp
public double Size;
```

### CharState.Strikethru
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/strikethru.md

#### CharState.Strikethru field

Strikethru

```csharp
public int Strikethru;
```

### CharState.Style
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/style.md

#### CharState.Style field

Style of char

```csharp
public int Style;
```

### CharState.UseVertical
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/charstate/usevertical.md

#### CharState.UseVertical field

Use Vertical

```csharp
public int UseVertical;
```

### Class FormatTxtState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/formattxtstate.md

#### FormatTxtState class

Format text state

```csharp
public class FormatTxtState
```

#### Constructors

| Name | Description |
| --- | --- |
| FormatTxtState() | Default constructor |
| FormatTxtState(FormatTxt, Shape) | Creates an instance of the FormatTxtState with predefined values |

#### Fields

| Name | Description |
| --- | --- |
| FormatTxtType | Format text type |
| Txt | Text |

### FormatTxtState.FormatTxtState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/formattxtstate/formattxtstate.md

#### FormatTxtState()

Default constructor

```csharp
public FormatTxtState()
```

#### FormatTxtState(FormatTxt, Shape)

Creates an instance of the FormatTxtState with predefined values

```csharp
public FormatTxtState(FormatTxt formatTxt, Shape shape)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatTxt | FormatTxt |  |
| shape | Shape |  |

### FormatTxtState.FormatTxtType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/formattxtstate/formattxttype.md

#### FormatTxtState.FormatTxtType field

Format text type

```csharp
public int FormatTxtType;
```

### FormatTxtState.Txt
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/formattxtstate/txt.md

#### FormatTxtState.Txt field

Text

```csharp
public string Txt;
```

### Class ParagraphState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate.md

#### ParagraphState class

Stores information about the status of the paragraph

```csharp
public class ParagraphState
```

#### Constructors

| Name | Description |
| --- | --- |
| ParagraphState() | The default constructor. |
| ParagraphState(Para) |  |

#### Methods

| Name | Description |
| --- | --- |
| GetPara() |  |

#### Fields

| Name | Description |
| --- | --- |
| Bullet | Bullet |
| BulletFont | Bullet Font |
| BulletFontSize | Bullet Font Size |
| BulletStr | BulletStr |
| Del | Del |
| Flags | Flags |
| HorzAlign | HorzAlign |
| IndFirst | IndFirst |
| IndLeft | IndLeft |
| IndRight | IndRight |
| Ix | Ix |
| LocalizeBulletFont | Localize Bullet Font |
| SpAfter | SpAfter |
| SpBefore | SpBefore |
| SpLine | SpLine |
| TextPosAfterBullet | TextPosAfterBullet |

### ParagraphState.Bullet
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/bullet.md

#### ParagraphState.Bullet field

Bullet

```csharp
public int Bullet;
```

### ParagraphState.BulletFont
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/bulletfont.md

#### ParagraphState.BulletFont field

Bullet Font

```csharp
public int BulletFont;
```

### ParagraphState.BulletFontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/bulletfontsize.md

#### ParagraphState.BulletFontSize field

Bullet Font Size

```csharp
public double BulletFontSize;
```

### ParagraphState.BulletStr
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/bulletstr.md

#### ParagraphState.BulletStr field

BulletStr

```csharp
public string BulletStr;
```

### ParagraphState.Del
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/del.md

#### ParagraphState.Del field

Del

```csharp
public int Del;
```

### ParagraphState.Flags
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/flags.md

#### ParagraphState.Flags field

Flags

```csharp
public int Flags;
```

### ParagraphState.GetPara
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/getpara.md

#### ParagraphState.GetPara method

```csharp
public Para GetPara()
```

### ParagraphState.HorzAlign
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/horzalign.md

#### ParagraphState.HorzAlign field

HorzAlign

```csharp
public int HorzAlign;
```

### ParagraphState.IndFirst
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/indfirst.md

#### ParagraphState.IndFirst field

IndFirst

```csharp
public double IndFirst;
```

### ParagraphState.IndLeft
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/indleft.md

#### ParagraphState.IndLeft field

IndLeft

```csharp
public double IndLeft;
```

### ParagraphState.IndRight
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/indright.md

#### ParagraphState.IndRight field

IndRight

```csharp
public double IndRight;
```

### ParagraphState.Ix
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/ix.md

#### ParagraphState.Ix field

Ix

```csharp
public int Ix;
```

### ParagraphState.LocalizeBulletFont
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/localizebulletfont.md

#### ParagraphState.LocalizeBulletFont field

Localize Bullet Font

```csharp
public int LocalizeBulletFont;
```

### ParagraphState.ParagraphState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/paragraphstate.md

#### ParagraphState()

The default constructor.

```csharp
public ParagraphState()
```

#### ParagraphState(Para)

```csharp
public ParagraphState(Para paragraph)
```

### ParagraphState.SpAfter
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/spafter.md

#### ParagraphState.SpAfter field

SpAfter

```csharp
public double SpAfter;
```

### ParagraphState.SpBefore
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/spbefore.md

#### ParagraphState.SpBefore field

SpBefore

```csharp
public double SpBefore;
```

### ParagraphState.SpLine
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/spline.md

#### ParagraphState.SpLine field

SpLine

```csharp
public double SpLine;
```

### ParagraphState.TextPosAfterBullet
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/paragraphstate/textposafterbullet.md

#### ParagraphState.TextPosAfterBullet field

TextPosAfterBullet

```csharp
public double TextPosAfterBullet;
```

### Class Portion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/portion.md

#### Portion class

Class of portion

```csharp
public class Portion
```

#### Constructors

| Name | Description |
| --- | --- |
| Portion(int, Char, List&lt;FormatTxt&gt;, string) |  |

#### Properties

| Name | Description |
| --- | --- |
| Cp { get; } | Cp |
| Ix { get; set; } | Ix |
| Markers { get; set; } | Markers |
| Text { get; set; } | Text |

### Portion.Cp
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/portion/cp.md

#### Portion.Cp property

Cp

```csharp
public Char Cp { get; }
```

### Portion.Ix
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/portion/ix.md

#### Portion.Ix property

Ix

```csharp
public int Ix { get; set; }
```

### Portion.Markers
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/portion/markers.md

#### Portion.Markers property

Markers

```csharp
public List<FormatTxt> Markers { get; set; }
```

### Portion.Portion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/portion/portion.md

#### Portion constructor

```csharp
public Portion(int ix, Char cp, List<FormatTxt> markers, string text)
```

### Portion.Text
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/portion/text.md

#### Portion.Text property

Text

```csharp
public string Text { get; set; }
```

### Class SaveLoadFormat
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/saveloadformat.md

#### SaveLoadFormat class

Save load format

```csharp
public class SaveLoadFormat
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveLoadFormat() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| LoadFormat { get; set; } | Load format |
| SaveFormat { get; set; } | Save format |

### SaveLoadFormat.LoadFormat
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/saveloadformat/loadformat.md

#### SaveLoadFormat.LoadFormat property

Load format

```csharp
public LoadFileFormat LoadFormat { get; set; }
```

### SaveLoadFormat.SaveFormat
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/saveloadformat/saveformat.md

#### SaveLoadFormat.SaveFormat property

Save format

```csharp
public SaveFileFormat SaveFormat { get; set; }
```

### SaveLoadFormat.SaveLoadFormat
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/saveloadformat/saveloadformat.md

#### SaveLoadFormat constructor

The default constructor.

```csharp
public SaveLoadFormat()
```

### Class ShapeDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate.md

#### ShapeDefaultState class

Chronologizes information about the text before applying a text annotation to it

```csharp
public class ShapeDefaultState
```

#### Constructors

| Name | Description |
| --- | --- |
| ShapeDefaultState() | Initialize instance of the ShapeDefaultState with default values. |

#### Fields

| Name | Description |
| --- | --- |
| CharStateCollection | Array of char state |
| FormatTxtStateCollection | Array of format text state |
| PageId | Page id |
| ParagraphStateCollection | Array of paragraph state |
| ShapeDefaultName | Shape default name |
| ShapeName | Shape name |

### ShapeDefaultState.CharStateCollection
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/charstatecollection.md

#### ShapeDefaultState.CharStateCollection field

Array of char state

```csharp
public CharState[] CharStateCollection;
```

### ShapeDefaultState.FormatTxtStateCollection
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/formattxtstatecollection.md

#### ShapeDefaultState.FormatTxtStateCollection field

Array of format text state

```csharp
public FormatTxtState[] FormatTxtStateCollection;
```

### ShapeDefaultState.PageId
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/pageid.md

#### ShapeDefaultState.PageId field

Page id

```csharp
public int PageId;
```

### ShapeDefaultState.ParagraphStateCollection
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/paragraphstatecollection.md

#### ShapeDefaultState.ParagraphStateCollection field

Array of paragraph state

```csharp
public ParagraphState[] ParagraphStateCollection;
```

### ShapeDefaultState.ShapeDefaultName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/shapedefaultname.md

#### ShapeDefaultState.ShapeDefaultName field

Shape default name

```csharp
public string ShapeDefaultName;
```

### ShapeDefaultState.ShapeDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/shapedefaultstate.md

#### ShapeDefaultState constructor

Initialize instance of the ShapeDefaultState with default values.

```csharp
public ShapeDefaultState()
```

### ShapeDefaultState.ShapeName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.diagram.models/shapedefaultstate/shapename.md

#### ShapeDefaultState.ShapeName field

Shape name

```csharp
public string ShapeName;
```

### GroupDocs.Annotation.Projects.Images.Models
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models.md

The namespace provides classes of bytes with a specific offset in the byte array.

#### Classes

| Class | Description |
| --- | --- |
| BlockProperties | The representation of the properties of a data block. |
| BlockWithOffset | This class is a block of bytes with a specific offset in the byte array. |
| FramePage | TIFF frame model |
| RepeatingBlockWithOffset | the representation of a repeating block of data with a certain offset in the byte array. |

### Class BlockProperties
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockproperties.md

#### BlockProperties class

The representation of the properties of a data block.

```csharp
public class BlockProperties
```

#### Constructors

| Name | Description |
| --- | --- |
| BlockProperties() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Offset { get; set; } | Data offset |
| RepeatBegin { get; set; } | Start of a repeating data block |

### BlockProperties.BlockProperties
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockproperties/blockproperties.md

#### BlockProperties constructor

The default constructor.

```csharp
public BlockProperties()
```

### BlockProperties.Offset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockproperties/offset.md

#### BlockProperties.Offset property

Data offset

```csharp
public int? Offset { get; set; }
```

### BlockProperties.RepeatBegin
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockproperties/repeatbegin.md

#### BlockProperties.RepeatBegin property

Start of a repeating data block

```csharp
public int? RepeatBegin { get; set; }
```

### Class BlockWithOffset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockwithoffset.md

#### BlockWithOffset class

This class is a block of bytes with a specific offset in the byte array.

```csharp
public class BlockWithOffset
```

#### Constructors

| Name | Description |
| --- | --- |
| BlockWithOffset() | Create default instance of the BlockWithOffset |
| BlockWithOffset(byte[], int, int) | Create instance of the BlockWithOffset with predefined values |

#### Methods

| Name | Description |
| --- | --- |
| virtual GetLength() | Returns size of block |
| virtual RestoreBytes(byte[]) | Copies block bytes to given array. |

#### Fields

| Name | Description |
| --- | --- |
| Block | Byte block |
| Offset | Byte block reduction information |

### BlockWithOffset.Block
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockwithoffset/block.md

#### BlockWithOffset.Block field

Byte block

```csharp
public byte[] Block;
```

### BlockWithOffset.BlockWithOffset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockwithoffset/blockwithoffset.md

#### BlockWithOffset()

Create default instance of the BlockWithOffset

```csharp
public BlockWithOffset()
```

#### BlockWithOffset(byte[], int, int)

Create instance of the BlockWithOffset with predefined values

```csharp
public BlockWithOffset(byte[] defaultBytes, int offset, int count)
```

| Parameter | Type | Description |
| --- | --- | --- |
| defaultBytes | Byte[] |  |
| offset | Int32 |  |
| count | Int32 |  |

### BlockWithOffset.GetLength
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockwithoffset/getlength.md

#### BlockWithOffset.GetLength method

Returns size of block

```csharp
public virtual int GetLength()
```

##### Return Value

Size in bytes of the block

### BlockWithOffset.Offset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockwithoffset/offset.md

#### BlockWithOffset.Offset field

Byte block reduction information

```csharp
public int Offset;
```

### BlockWithOffset.RestoreBytes
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/blockwithoffset/restorebytes.md

#### BlockWithOffset.RestoreBytes method

Copies block bytes to given array.

```csharp
public virtual void RestoreBytes(byte[] destination)
```

| Parameter | Type | Description |
| --- | --- | --- |
| destination | Byte[] | Destination array |

### Class FramePage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage.md

#### FramePage class

TIFF frame model

```csharp
public class FramePage : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| FramePage(int, TiffFrame) | Initializes new instance of `FramePage` class. |

#### Properties

| Name | Description |
| --- | --- |
| FrameImage { get; set; } | Frame image |
| FrameNumber { get; } | Frame number |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() |  |
| GetStream() | Get image stream |
| StreamToImage(Stream) | Convert |

### FramePage.Dispose
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage/dispose.md

#### FramePage.Dispose method

```csharp
public void Dispose()
```

### FramePage.FrameImage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage/frameimage.md

#### FramePage.FrameImage property

Frame image

```csharp
public TiffImage FrameImage { get; set; }
```

### FramePage.FrameNumber
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage/framenumber.md

#### FramePage.FrameNumber property

Frame number

```csharp
public int FrameNumber { get; }
```

### FramePage.FramePage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage/framepage.md

#### FramePage constructor

Initializes new instance of `FramePage` class.

```csharp
public FramePage(int frameNumber, TiffFrame frame)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameNumber | Int32 | Index of TIFF frame |
| frame | TiffFrame | TIFF frame |

### FramePage.GetStream
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage/getstream.md

#### FramePage.GetStream method

Get image stream

```csharp
public Stream GetStream()
```

### FramePage.StreamToImage
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/framepage/streamtoimage.md

#### FramePage.StreamToImage method

Convert

```csharp
public void StreamToImage(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream |  |

### Class RepeatingBlockWithOffset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/repeatingblockwithoffset.md

#### RepeatingBlockWithOffset class

the representation of a repeating block of data with a certain offset in the byte array.

```csharp
public class RepeatingBlockWithOffset : BlockWithOffset
```

#### Constructors

| Name | Description |
| --- | --- |
| RepeatingBlockWithOffset() | Creates default instance of the RepeatingBlockWithOffset |
| RepeatingBlockWithOffset(byte[], int, int, int) | Creates instance of the RepeatingBlockWithOffset with predefined values |

#### Methods

| Name | Description |
| --- | --- |
| override GetLength() | Returns size of block |
| override RestoreBytes(byte[]) | Copies block bytes to given array. |

#### Fields

| Name | Description |
| --- | --- |
| Block | Byte block |
| Offset | Byte block reduction information |
| _repeatingCount | Number of repetitions of the data block |

### RepeatingBlockWithOffset._repeatingCount
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/repeatingblockwithoffset/_repeatingcount.md

#### RepeatingBlockWithOffset._repeatingCount field

Number of repetitions of the data block

```csharp
public int _repeatingCount;
```

### RepeatingBlockWithOffset.GetLength
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/repeatingblockwithoffset/getlength.md

#### RepeatingBlockWithOffset.GetLength method

Returns size of block

```csharp
public override int GetLength()
```

##### Return Value

Size in bytes of the block

### RepeatingBlockWithOffset.RepeatingBlockWithOffset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/repeatingblockwithoffset/repeatingblockwithoffset.md

#### RepeatingBlockWithOffset()

Creates default instance of the RepeatingBlockWithOffset

```csharp
public RepeatingBlockWithOffset()
```

#### RepeatingBlockWithOffset(byte[], int, int, int)

Creates instance of the RepeatingBlockWithOffset with predefined values

```csharp
public RepeatingBlockWithOffset(byte[] defaultBytes, int offset, int count, int repeatingCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| defaultBytes | Byte[] |  |
| offset | Int32 |  |
| count | Int32 |  |
| repeatingCount | Int32 |  |

### RepeatingBlockWithOffset.RestoreBytes
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.images.models/repeatingblockwithoffset/restorebytes.md

#### RepeatingBlockWithOffset.RestoreBytes method

Copies block bytes to given array.

```csharp
public override void RestoreBytes(byte[] destination)
```

| Parameter | Type | Description |
| --- | --- | --- |
| destination | Byte[] | Destination array |

### GroupDocs.Annotation.Projects.Pdf.Models
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models.md

The namespace provides a class to represent the default state model for text in a PDF document

#### Classes

| Class | Description |
| --- | --- |
| PdfTextDefaultState | Represents the default state model for the text in the PDF document |

### Class PdfTextDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate.md

#### PdfTextDefaultState class

Represents the default state model for the text in the PDF document

```csharp
public class PdfTextDefaultState
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfTextDefaultState() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Background color of text |
| FontColor { get; set; } | Font color of text |
| FontName { get; set; } | Font name of text |
| FontSize { get; set; } | Font size of text |
| IsBold { get; set; } | The text is bold |
| IsItalic { get; set; } | The text is italic |
| IsSquiggly { get; set; } | The text is squiggly |
| IsStrikeout { get; set; } | The text is Strikeout |
| IsSubscript { get; set; } | The text is Subscript |
| IsSuperscript { get; set; } | The text is superscript |
| IsUnderline { get; set; } | The text is underline |

### PdfTextDefaultState.BackgroundColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/backgroundcolor.md

#### PdfTextDefaultState.BackgroundColor property

Background color of text

```csharp
public int? BackgroundColor { get; set; }
```

### PdfTextDefaultState.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/fontcolor.md

#### PdfTextDefaultState.FontColor property

Font color of text

```csharp
public int? FontColor { get; set; }
```

### PdfTextDefaultState.FontName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/fontname.md

#### PdfTextDefaultState.FontName property

Font name of text

```csharp
public string FontName { get; set; }
```

### PdfTextDefaultState.FontSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/fontsize.md

#### PdfTextDefaultState.FontSize property

Font size of text

```csharp
public int FontSize { get; set; }
```

### PdfTextDefaultState.IsBold
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/isbold.md

#### PdfTextDefaultState.IsBold property

The text is bold

```csharp
public bool IsBold { get; set; }
```

### PdfTextDefaultState.IsItalic
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/isitalic.md

#### PdfTextDefaultState.IsItalic property

The text is italic

```csharp
public bool IsItalic { get; set; }
```

### PdfTextDefaultState.IsSquiggly
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/issquiggly.md

#### PdfTextDefaultState.IsSquiggly property

The text is squiggly

```csharp
public bool IsSquiggly { get; set; }
```

### PdfTextDefaultState.IsStrikeout
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/isstrikeout.md

#### PdfTextDefaultState.IsStrikeout property

The text is Strikeout

```csharp
public bool IsStrikeout { get; set; }
```

### PdfTextDefaultState.IsSubscript
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/issubscript.md

#### PdfTextDefaultState.IsSubscript property

The text is Subscript

```csharp
public bool IsSubscript { get; set; }
```

### PdfTextDefaultState.IsSuperscript
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/issuperscript.md

#### PdfTextDefaultState.IsSuperscript property

The text is superscript

```csharp
public bool IsSuperscript { get; set; }
```

### PdfTextDefaultState.IsUnderline
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/isunderline.md

#### PdfTextDefaultState.IsUnderline property

The text is underline

```csharp
public bool IsUnderline { get; set; }
```

### PdfTextDefaultState.PdfTextDefaultState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.pdf.models/pdftextdefaultstate/pdftextdefaultstate.md

#### PdfTextDefaultState constructor

The default constructor.

```csharp
public PdfTextDefaultState()
```

### GroupDocs.Annotation.Projects.Slides.Models
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models.md

The namespace provides classes to store information about the text

#### Classes

| Class | Description |
| --- | --- |
| DefaultParagraphState | The default state representation for the paragraph in the presentation |
| DefaultPortionState | The default state representation for a single text fragment (portion) in the presentation slides |
| DefaultShapeState | Default state views for the form on the presentation slides |
| ExtendedParagraph | It contains information about the paragraph, its coordinates and rectangles of text portions within the paragraph. |
| ExtendedPortion | Serves as a data structure to facilitate the manipulation and visualization of individual text fragments on PowerPoint slides |
| LineOfExtendedPortions | Serves as a container for a collection of extended fragments and provides line height as a property. |

### Class DefaultParagraphState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate.md

#### DefaultParagraphState class

The default state representation for the paragraph in the presentation

```csharp
public class DefaultParagraphState
```

#### Constructors

| Name | Description |
| --- | --- |
| DefaultParagraphState() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AfterReplaceText { get; set; } | Text after replacement |
| Depth { get; set; } | Depth of the paragraph |
| EastAsianLineBreak { get; set; } | East Asian line break option |
| FontAlignment { get; set; } | Font alignment |
| HangingPunctuation { get; set; } | Hanging punctuation option |
| Indent { get; set; } | Indentation value |
| LatinLineBreak { get; set; } | Latin line break option |
| MarginLeft { get; set; } | Left margin value |
| MarginRight { get; set; } | Right margin value |
| ParagraphText { get; set; } | Paragraph text |
| PortionState { get; set; } | Default state for text portions |
| RightToLeft { get; set; } | Right-to-left option |
| SpaceAfter { get; set; } | Space after the paragraph |
| SpaceBefore { get; set; } | Space before the paragraph |
| SpaceWithin { get; set; } | Space within the paragraph |
| TabSize { get; set; } | Tab size |
| TextAligment { get; set; } | Text alignment |

### DefaultParagraphState.AfterReplaceText
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/afterreplacetext.md

#### DefaultParagraphState.AfterReplaceText property

Text after replacement

```csharp
public string AfterReplaceText { get; set; }
```

### DefaultParagraphState.DefaultParagraphState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/defaultparagraphstate.md

#### DefaultParagraphState constructor

The default constructor.

```csharp
public DefaultParagraphState()
```

### DefaultParagraphState.Depth
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/depth.md

#### DefaultParagraphState.Depth property

Depth of the paragraph

```csharp
public short? Depth { get; set; }
```

### DefaultParagraphState.EastAsianLineBreak
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/eastasianlinebreak.md

#### DefaultParagraphState.EastAsianLineBreak property

East Asian line break option

```csharp
public bool EastAsianLineBreak { get; set; }
```

### DefaultParagraphState.FontAlignment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/fontalignment.md

#### DefaultParagraphState.FontAlignment property

Font alignment

```csharp
public int? FontAlignment { get; set; }
```

### DefaultParagraphState.HangingPunctuation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/hangingpunctuation.md

#### DefaultParagraphState.HangingPunctuation property

Hanging punctuation option

```csharp
public bool HangingPunctuation { get; set; }
```

### DefaultParagraphState.Indent
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/indent.md

#### DefaultParagraphState.Indent property

Indentation value

```csharp
public float? Indent { get; set; }
```

### DefaultParagraphState.LatinLineBreak
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/latinlinebreak.md

#### DefaultParagraphState.LatinLineBreak property

Latin line break option

```csharp
public bool LatinLineBreak { get; set; }
```

### DefaultParagraphState.MarginLeft
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/marginleft.md

#### DefaultParagraphState.MarginLeft property

Left margin value

```csharp
public float? MarginLeft { get; set; }
```

### DefaultParagraphState.MarginRight
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/marginright.md

#### DefaultParagraphState.MarginRight property

Right margin value

```csharp
public float? MarginRight { get; set; }
```

### DefaultParagraphState.ParagraphText
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/paragraphtext.md

#### DefaultParagraphState.ParagraphText property

Paragraph text

```csharp
public string ParagraphText { get; set; }
```

### DefaultParagraphState.PortionState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/portionstate.md

#### DefaultParagraphState.PortionState property

Default state for text portions

```csharp
public DefaultPortionState[] PortionState { get; set; }
```

### DefaultParagraphState.RightToLeft
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/righttoleft.md

#### DefaultParagraphState.RightToLeft property

Right-to-left option

```csharp
public bool RightToLeft { get; set; }
```

### DefaultParagraphState.SpaceAfter
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/spaceafter.md

#### DefaultParagraphState.SpaceAfter property

Space after the paragraph

```csharp
public float? SpaceAfter { get; set; }
```

### DefaultParagraphState.SpaceBefore
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/spacebefore.md

#### DefaultParagraphState.SpaceBefore property

Space before the paragraph

```csharp
public float? SpaceBefore { get; set; }
```

### DefaultParagraphState.SpaceWithin
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/spacewithin.md

#### DefaultParagraphState.SpaceWithin property

Space within the paragraph

```csharp
public float? SpaceWithin { get; set; }
```

### DefaultParagraphState.TabSize
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/tabsize.md

#### DefaultParagraphState.TabSize property

Tab size

```csharp
public float? TabSize { get; set; }
```

### DefaultParagraphState.TextAligment
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultparagraphstate/textaligment.md

#### DefaultParagraphState.TextAligment property

Text alignment

```csharp
public int? TextAligment { get; set; }
```

### Class DefaultPortionState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate.md

#### DefaultPortionState class

The default state representation for a single text fragment (portion) in the presentation slides

```csharp
public class DefaultPortionState
```

#### Constructors

| Name | Description |
| --- | --- |
| DefaultPortionState() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| FillType { get; set; } | The fill type |
| FontBold { get; set; } | Indicates if the font is bold |
| FontColor { get; set; } | The font color |
| FontFamily { get; set; } | The font family |
| FontHeight { get; set; } | The font height |
| FontItalic { get; set; } | Indicates if the font is italic |
| HighlightColor { get; set; } | The highlight color |
| PortionText { get; set; } | The text of the portion |
| Spacing { get; set; } | The spacing |
| StrikeoutType { get; set; } | The strikeout type |
| UnderlineType { get; set; } | The underline type |
| Url { get; set; } | The URL associated with the portion |

### DefaultPortionState.DefaultPortionState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/defaultportionstate.md

#### DefaultPortionState constructor

The default constructor.

```csharp
public DefaultPortionState()
```

### DefaultPortionState.FillType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/filltype.md

#### DefaultPortionState.FillType property

The fill type

```csharp
public int? FillType { get; set; }
```

### DefaultPortionState.FontBold
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/fontbold.md

#### DefaultPortionState.FontBold property

Indicates if the font is bold

```csharp
public bool FontBold { get; set; }
```

### DefaultPortionState.FontColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/fontcolor.md

#### DefaultPortionState.FontColor property

The font color

```csharp
public int? FontColor { get; set; }
```

### DefaultPortionState.FontFamily
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/fontfamily.md

#### DefaultPortionState.FontFamily property

The font family

```csharp
public string FontFamily { get; set; }
```

### DefaultPortionState.FontHeight
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/fontheight.md

#### DefaultPortionState.FontHeight property

The font height

```csharp
public float? FontHeight { get; set; }
```

### DefaultPortionState.FontItalic
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/fontitalic.md

#### DefaultPortionState.FontItalic property

Indicates if the font is italic

```csharp
public bool FontItalic { get; set; }
```

### DefaultPortionState.HighlightColor
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/highlightcolor.md

#### DefaultPortionState.HighlightColor property

The highlight color

```csharp
public int? HighlightColor { get; set; }
```

### DefaultPortionState.PortionText
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/portiontext.md

#### DefaultPortionState.PortionText property

The text of the portion

```csharp
public string PortionText { get; set; }
```

### DefaultPortionState.Spacing
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/spacing.md

#### DefaultPortionState.Spacing property

The spacing

```csharp
public float? Spacing { get; set; }
```

### DefaultPortionState.StrikeoutType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/strikeouttype.md

#### DefaultPortionState.StrikeoutType property

The strikeout type

```csharp
public int? StrikeoutType { get; set; }
```

### DefaultPortionState.UnderlineType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/underlinetype.md

#### DefaultPortionState.UnderlineType property

The underline type

```csharp
public int? UnderlineType { get; set; }
```

### DefaultPortionState.Url
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultportionstate/url.md

#### DefaultPortionState.Url property

The URL associated with the portion

```csharp
public string Url { get; set; }
```

### Class DefaultShapeState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultshapestate.md

#### DefaultShapeState class

Default state views for the form on the presentation slides

```csharp
public class DefaultShapeState
```

#### Constructors

| Name | Description |
| --- | --- |
| DefaultShapeState() | Initializes a new instance of the `DefaultShapeState` class. |

#### Properties

| Name | Description |
| --- | --- |
| GeneratedName { get; set; } | The generated name of the shape |
| ParagraphStates { get; set; } | The array of default paragraph states for the shape |
| ShapeOldName { get; set; } | The old name of the shape |

### DefaultShapeState.DefaultShapeState
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultshapestate/defaultshapestate.md

#### DefaultShapeState constructor

Initializes a new instance of the `DefaultShapeState` class.

```csharp
public DefaultShapeState()
```

### DefaultShapeState.GeneratedName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultshapestate/generatedname.md

#### DefaultShapeState.GeneratedName property

The generated name of the shape

```csharp
public string GeneratedName { get; set; }
```

### DefaultShapeState.ParagraphStates
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultshapestate/paragraphstates.md

#### DefaultShapeState.ParagraphStates property

The array of default paragraph states for the shape

```csharp
public DefaultParagraphState[] ParagraphStates { get; set; }
```

### DefaultShapeState.ShapeOldName
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/defaultshapestate/shapeoldname.md

#### DefaultShapeState.ShapeOldName property

The old name of the shape

```csharp
public string ShapeOldName { get; set; }
```

### Class ExtendedParagraph
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedparagraph.md

#### ExtendedParagraph class

It contains information about the paragraph, its coordinates and rectangles of text portions within the paragraph.

```csharp
public class ExtendedParagraph
```

#### Properties

| Name | Description |
| --- | --- |
| Lines { get; } | List of lines with extended portions. |
| Paragraph { get; } | The original paragraph. |
| PortionToExtended { get; } | Dictionary mapping portions to extended portions. |
| Shape { get; } | The shape containing the paragraph. |
| ShapeOffset { get; } | The offset of the shape. |

### ExtendedParagraph.Lines
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedparagraph/lines.md

#### ExtendedParagraph.Lines property

List of lines with extended portions.

```csharp
public List<LineOfExtendedPortions> Lines { get; }
```

### ExtendedParagraph.Paragraph
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedparagraph/paragraph.md

#### ExtendedParagraph.Paragraph property

The original paragraph.

```csharp
public IParagraph Paragraph { get; }
```

### ExtendedParagraph.PortionToExtended
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedparagraph/portiontoextended.md

#### ExtendedParagraph.PortionToExtended property

Dictionary mapping portions to extended portions.

```csharp
public SerializableDictionary<IPortion, ExtendedPortion> PortionToExtended { get; }
```

### ExtendedParagraph.Shape
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedparagraph/shape.md

#### ExtendedParagraph.Shape property

The shape containing the paragraph.

```csharp
public IShape Shape { get; }
```

### ExtendedParagraph.ShapeOffset
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedparagraph/shapeoffset.md

#### ExtendedParagraph.ShapeOffset property

The offset of the shape.

```csharp
public PointF ShapeOffset { get; }
```

### Class ExtendedPortion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedportion.md

#### ExtendedPortion class

Serves as a data structure to facilitate the manipulation and visualization of individual text fragments on PowerPoint slides

```csharp
public class ExtendedPortion
```

#### Properties

| Name | Description |
| --- | --- |
| ExtendedParagraph { get; set; } |  |
| Original { get; } |  |
| Rectangle { get; set; } |  |

### ExtendedPortion.ExtendedParagraph
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedportion/extendedparagraph.md

#### ExtendedPortion.ExtendedParagraph property

```csharp
public ExtendedParagraph ExtendedParagraph { get; set; }
```

### ExtendedPortion.Original
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedportion/original.md

#### ExtendedPortion.Original property

```csharp
public IPortion Original { get; }
```

### ExtendedPortion.Rectangle
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/extendedportion/rectangle.md

#### ExtendedPortion.Rectangle property

```csharp
public RectangleF Rectangle { get; set; }
```

### Class LineOfExtendedPortions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/lineofextendedportions.md

#### LineOfExtendedPortions class

Serves as a container for a collection of extended fragments and provides line height as a property.

```csharp
public class LineOfExtendedPortions
```

#### Constructors

| Name | Description |
| --- | --- |
| LineOfExtendedPortions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| EPortions { get; set; } | Gets or sets the list of extended portions in the line. |
| Height { get; set; } | Gets or sets the height of the line. |

### LineOfExtendedPortions.EPortions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/lineofextendedportions/eportions.md

#### LineOfExtendedPortions.EPortions property

Gets or sets the list of extended portions in the line.

```csharp
public List<ExtendedPortion> EPortions { get; set; }
```

### LineOfExtendedPortions.Height
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/lineofextendedportions/height.md

#### LineOfExtendedPortions.Height property

Gets or sets the height of the line.

```csharp
public float Height { get; set; }
```

### LineOfExtendedPortions.LineOfExtendedPortions
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.projects.slides.models/lineofextendedportions/lineofextendedportions.md

#### LineOfExtendedPortions constructor

The default constructor.

```csharp
public LineOfExtendedPortions()
```

### GroupDocs.Annotation.Utility
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility.md

#### Classes

| Class | Description |
| --- | --- |
| SerializableDictionary&lt;TKey,TValue&gt; | Represents a serializable custom dictionary collection of keys and values. |

### Class SerializableDictionaryTKeyTValue
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility/serializabledictionary-2.md

#### SerializableDictionary&lt;TKey,TValue&gt; class

Represents a serializable custom dictionary collection of keys and values.

```csharp
public class SerializableDictionary<TKey, TValue> : Dictionary<TKey, TValue>, IXmlSerializable
```

| Parameter | Description |
| --- | --- |
| TKey | The type of the keys in the dictionary. |
| TValue | The type of the values in the dictionary. |

#### Constructors

| Name | Description |
| --- | --- |
| SerializableDictionary() | Initializes a new instance of the SerializableDictionary class that is empty, has the default initial capacity, and uses the default equality comparer for the key type. |

#### Methods

| Name | Description |
| --- | --- |
| GetObjectData(SerializationInfo, StreamingContext) | Serialize dictionary as a list of key-value pairs |
| GetSchema() | Returns XML Scema of the collection |
| ReadXml(XmlReader) | Reads collection data from the given reader XmlReader |
| WriteXml(XmlWriter) | Writes collection data to given writer XmlWriter |

### SerializableDictionary2.GetObjectData
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility/serializabledictionary-2/getobjectdata.md

#### SerializableDictionary&lt;TKey,TValue&gt;.GetObjectData method

Serialize dictionary as a list of key-value pairs

```csharp
public void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | Serialization information SerializationInfo |
| context | StreamingContext | Streaming context |

### SerializableDictionary2.GetSchema
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility/serializabledictionary-2/getschema.md

#### SerializableDictionary&lt;TKey,TValue&gt;.GetSchema method

Returns XML Scema of the collection

```csharp
public XmlSchema GetSchema()
```

### SerializableDictionary2.ReadXml
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility/serializabledictionary-2/readxml.md

#### SerializableDictionary&lt;TKey,TValue&gt;.ReadXml method

Reads collection data from the given reader XmlReader

```csharp
public void ReadXml(XmlReader reader)
```

| Parameter | Type | Description |
| --- | --- | --- |
| reader | XmlReader | The instance of the System.Xml.XmlReader to read the collection from. |

### SerializableDictionary2.SerializableDictionary
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility/serializabledictionary-2/serializabledictionary.md

#### SerializableDictionary&lt;TKey,TValue&gt; constructor

Initializes a new instance of the SerializableDictionary class that is empty, has the default initial capacity, and uses the default equality comparer for the key type.

```csharp
public SerializableDictionary()
```

### SerializableDictionary2.WriteXml
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.utility/serializabledictionary-2/writexml.md

#### SerializableDictionary&lt;TKey,TValue&gt;.WriteXml method

Writes collection data to given writer XmlWriter

```csharp
public void WriteXml(XmlWriter writer)
```

| Parameter | Type | Description |
| --- | --- | --- |
| writer | XmlWriter | The instance of the System.Xml.XmlWriter to save the collection to. |

### GroupDocs.Annotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation.md

The namespace provides classes to annotate documents for all popular document formats.

#### Classes

| Class | Description |
| --- | --- |
| Annotator | The 'Annotator' class is the central component of the GroupDocs.Annotation API, designed to manage and facilitate the document annotation process across various formats. It offers a streamlined interface for applying diverse annotation types, making it the primary tool for integrating annotation functionality. |
| AnnotatorSettings | Defines settings for customizing `Annotator` behavior. |
| Document | Represents various document properties |
| FileType | Information about file, such as type, extension, etc. |
| License | Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing). |
| Metered | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Interface that defines list of available document information |

### Class Annotator
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator.md

#### Annotator class

The 'Annotator' class is the central component of the GroupDocs.Annotation API, designed to manage and facilitate the document annotation process across various formats. It offers a streamlined interface for applying diverse annotation types, making it the primary tool for integrating annotation functionality.

```csharp
public class Annotator : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Annotator(Stream) | Initialise annotator class which accept document stream |
| Annotator(string) | Initialise annotator class which accept document path |
| Annotator(Stream, AnnotatorSettings) | Initialise annotator class which accept document stream and settings |
| Annotator(Stream, LoadOptions) | Initialise annotator class which accept document stream and options |
| Annotator(string, AnnotatorSettings) | Initialise annotator class which accept document path and settings |
| Annotator(string, LoadOptions) | Initialise annotator class which accept document path and options |
| Annotator(Stream, LoadOptions, AnnotatorSettings) | Initialise annotator class which accept document stream, options and settings |
| Annotator(string, LoadOptions, AnnotatorSettings) | Initialise annotator class which accept document path, options and settings |

#### Properties

| Name | Description |
| --- | --- |
| Document { get; } | Contains various information about the uploaded document |
| ProcessPages { get; set; } | Count of processed pages |
| Rotation { get; set; } | Specifies document rotation angle |

#### Methods

| Name | Description |
| --- | --- |
| Add(AnnotationBase) | Adds annotation to document |
| Add(List&lt;AnnotationBase&gt;) | Adds collection of annotations to a document. |
| Dispose() | Dispose |
| ExportAnnotationsFromXMLFile(string) | Export annotations from XML file. |
| Get() | Gets collections of document annotations. |
| Get(AnnotationType) | Gets collection of document annotations by annotation type. |
| GetVersion(object) | Get annotations from versions. |
| GetVersionsList() | Get versions. |
| ImportAnnotationsFromDocument(string) | Import annotations from document to XML file. |
| Remove(AnnotationBase) | Removes annotation from the document. |
| Remove(int) | Removes annotation from annotations list by Id. |
| Remove(List&lt;AnnotationBase&gt;) | Removes collection of annotations from document. |
| Remove(List&lt;int&gt;) | Removes collection of annotations from document by provided annotation ids. |
| Save() | Saves document after adding, updating or removing annotations. |
| Save(SaveOptions) | Saves document after adding, updating or removing annotations. |
| Save(Stream) | Saves document after adding, updating or removing annotations. |
| Save(string) | Saves document after adding, updating or removing annotations. |
| Save(Stream, SaveOptions) | Saves document after adding, updating or removing annotations. |
| Save(string, SaveOptions) | Saves document after adding, updating or removing annotations. |
| Update(AnnotationBase) | Updates document annotation by id. |
| Update(List&lt;AnnotationBase&gt;) | Updates collection of document annotations by overriding the previous list with a new one |

### Annotator.Add
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/add.md

#### Add(AnnotationBase)

Adds annotation to document

```csharp
public void Add(AnnotationBase annotation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotation | AnnotationBase | The annotation to add. |

#### Add(List&lt;AnnotationBase&gt;)

Adds collection of annotations to a document.

```csharp
public void Add(List<AnnotationBase> annotations)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotations | List`1 | The annotations list to add. |

### Annotator.Annotator
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/annotator.md

#### Annotator(string)

Initialise annotator class which accept document path

```csharp
public Annotator(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |

#### Annotator(string, LoadOptions)

Initialise annotator class which accept document path and options

```csharp
public Annotator(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |
| loadOptions | LoadOptions | Load options |

#### Annotator(string, AnnotatorSettings)

Initialise annotator class which accept document path and settings

```csharp
public Annotator(string filePath, AnnotatorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |
| settings | AnnotatorSettings | Annotator settings |

#### Annotator(string, LoadOptions, AnnotatorSettings)

Initialise annotator class which accept document path, options and settings

```csharp
public Annotator(string filePath, LoadOptions loadOptions, AnnotatorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |
| loadOptions | LoadOptions | Load options |
| settings | AnnotatorSettings | Annotator settings |

#### Annotator(Stream)

Initialise annotator class which accept document stream

```csharp
public Annotator(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Document stream |

#### Annotator(Stream, LoadOptions)

Initialise annotator class which accept document stream and options

```csharp
public Annotator(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Document stream |
| loadOptions | LoadOptions | Load options |

#### Annotator(Stream, AnnotatorSettings)

Initialise annotator class which accept document stream and settings

```csharp
public Annotator(Stream document, AnnotatorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Document stream |
| settings | AnnotatorSettings | Annotator settings |

#### Annotator(Stream, LoadOptions, AnnotatorSettings)

Initialise annotator class which accept document stream, options and settings

```csharp
public Annotator(Stream document, LoadOptions loadOptions, AnnotatorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Document stream |
| loadOptions | LoadOptions | Load options |
| settings | AnnotatorSettings | Annotator settings |

### Annotator.Dispose
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/dispose.md

#### Annotator.Dispose method

Dispose

```csharp
public void Dispose()
```

### Annotator.Document
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/document.md

#### Annotator.Document property

Contains various information about the uploaded document

```csharp
public Document Document { get; }
```

### Annotator.ExportAnnotationsFromXMLFile
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/exportannotationsfromxmlfile.md

#### Annotator.ExportAnnotationsFromXMLFile method

Export annotations from XML file.

```csharp
public void ExportAnnotationsFromXMLFile(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to XML file. |

### Annotator.Get
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/get.md

#### Get()

Gets collections of document annotations.

```csharp
public List<AnnotationBase> Get()
```

##### Return Value

The list of annotations.

#### Get(AnnotationType)

Gets collection of document annotations by annotation type.

```csharp
public List<AnnotationBase> Get(AnnotationType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| type | AnnotationType | The annotations type that must be returned. |

##### Return Value

The list of annotations by type.

### Annotator.GetVersion
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/getversion.md

#### Annotator.GetVersion method

Get annotations from versions.

```csharp
public List<AnnotationBase> GetVersion(object version)
```

| Parameter | Type | Description |
| --- | --- | --- |
| version | Object | The version's Key of versions which you want to return |

##### Return Value

The list of annotations from specific versions. If null will return last.

### Annotator.GetVersionsList
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/getversionslist.md

#### Annotator.GetVersionsList method

Get versions.

```csharp
public List<object> GetVersionsList()
```

##### Return Value

The list of versions.

### Annotator.ImportAnnotationsFromDocument
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/importannotationsfromdocument.md

#### Annotator.ImportAnnotationsFromDocument method

Import annotations from document to XML file.

```csharp
public void ImportAnnotationsFromDocument(string outputPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputPath | String | The output file path (must be in .xml format). |

### Annotator.ProcessPages
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/processpages.md

#### Annotator.ProcessPages property

Count of processed pages

```csharp
public int ProcessPages { get; set; }
```

### Annotator.Remove
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/remove.md

#### Remove(int)

Removes annotation from annotations list by Id.

```csharp
public void Remove(int annotationId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotationId | Int32 | The annotation's id that must be removed. |

#### Remove(AnnotationBase)

Removes annotation from the document.

```csharp
public void Remove(AnnotationBase annotation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotation | AnnotationBase | Annotation that must be removed. |

#### Remove(List&lt;int&gt;)

Removes collection of annotations from document by provided annotation ids.

```csharp
public void Remove(List<int> annotationIds)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotationIds | List`1 | The annotation's id that must be removed. |

#### Remove(List&lt;AnnotationBase&gt;)

Removes collection of annotations from document.

```csharp
public void Remove(List<AnnotationBase> annotationsToDelete)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotationsToDelete | List`1 | The annotations that must be removed. |

### Annotator.Rotation
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/rotation.md

#### Annotator.Rotation property

Specifies document rotation angle

```csharp
public RotationDocument? Rotation { get; set; }
```

### Annotator.Save
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/save.md

#### Save()

Saves document after adding, updating or removing annotations.

```csharp
public void Save()
```

#### Remarks

**Learn more about saving annotated documents**

* More about how to save only annotated document pages: [Save only annotated pages](https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
* More about how to save document with specific annotation types only: [Filtering annotation types on save](https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
* More about how to save specific pages from the whole document: [Save specific page range](https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

#### Save(SaveOptions)

Saves document after adding, updating or removing annotations.

```csharp
public void Save(SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | SaveOptions | The save options. |

#### Remarks

**Learn more about saving annotated documents**

* More about how to save only annotated document pages: [Save only annotated pages](https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
* More about how to save document with specific annotation types only: [Filtering annotation types on save](https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
* More about how to save specific pages from the whole document: [Save specific page range](https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

#### Save(Stream)

Saves document after adding, updating or removing annotations.

```csharp
public void Save(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The output stream. |

#### Remarks

**Learn more about saving annotated documents**

* More about how to save only annotated document pages: [Save only annotated pages](https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
* More about how to save document with specific annotation types only: [Filtering annotation types on save](https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
* More about how to save specific pages from the whole document: [Save specific page range](https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

#### Save(string)

Saves document after adding, updating or removing annotations.

```csharp
public void Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The output file path. |

#### Remarks

**Learn more about saving annotated documents**

* More about how to save only annotated document pages: [Save only annotated pages](https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
* More about how to save document with specific annotation types only: [Filtering annotation types on save](https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
* More about how to save specific pages from the whole document: [Save specific page range](https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

#### Save(Stream, SaveOptions)

Saves document after adding, updating or removing annotations.

```csharp
public void Save(Stream document, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The output stream. |
| saveOptions | SaveOptions | The save options. |

#### Remarks

**Learn more about saving annotated documents**

* More about how to save only annotated document pages: [Save only annotated pages](https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
* More about how to save document with specific annotation types only: [Filtering annotation types on save](https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
* More about how to save specific pages from the whole document: [Save specific page range](https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

#### Save(string, SaveOptions)

Saves document after adding, updating or removing annotations.

```csharp
public void Save(string filePath, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The output file path. |
| saveOptions | SaveOptions | The save options. |

#### Remarks

**Learn more about saving annotated documents**

* More about how to save only annotated document pages: [Save only annotated pages](https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
* More about how to save document with specific annotation types only: [Filtering annotation types on save](https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
* More about how to save specific pages from the whole document: [Save specific page range](https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

### Annotator.Update
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotator/update.md

#### Update(AnnotationBase)

Updates document annotation by id.

```csharp
public void Update(AnnotationBase newAnnotation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| newAnnotation | AnnotationBase | The annotation to update (Id should be provided). |

#### Update(List&lt;AnnotationBase&gt;)

Updates collection of document annotations by overriding the previous list with a new one

```csharp
public void Update(List<AnnotationBase> annotations)
```

| Parameter | Type | Description |
| --- | --- | --- |
| annotations | List`1 | The annotations list that will be set. |

### Class AnnotatorSettings
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotatorsettings.md

#### AnnotatorSettings class

Defines settings for customizing `Annotator` behavior.

```csharp
public class AnnotatorSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| AnnotatorSettings() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Cache { get; set; } | Cache |
| Logger { get; set; } | Logger |

### AnnotatorSettings.AnnotatorSettings
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotatorsettings/annotatorsettings.md

#### AnnotatorSettings constructor

The default constructor.

```csharp
public AnnotatorSettings()
```

### AnnotatorSettings.Cache
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotatorsettings/cache.md

#### AnnotatorSettings.Cache property

Cache

```csharp
public ICache Cache { get; set; }
```

### AnnotatorSettings.Logger
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/annotatorsettings/logger.md

#### AnnotatorSettings.Logger property

Logger

```csharp
public ILogger Logger { get; set; }
```

### Class Document
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document.md

#### Document class

Represents various document properties

```csharp
public class Document
```

#### Constructors

| Name | Description |
| --- | --- |
| Document(Stream) | Initializes new instance of `Document` class. |
| Document(Stream, string) | Initializes new instance of `Document` class. |

#### Properties

| Name | Description |
| --- | --- |
| Name { get; set; } | Document name |
| Password { get; } | Document password |
| Stream { get; } | Document stream |

#### Methods

| Name | Description |
| --- | --- |
| AddImageToDocument(string, string, int, int) | Change image quality and add image to document |
| GeneratePreview(PreviewOptions) | Generates document pages preview (screenshots of every page). |
| GetDocumentInfo() | Gets information about document - document type and size, pages count and detailed information about every page. |

### Document.AddImageToDocument
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/addimagetodocument.md

#### Document.AddImageToDocument method

Change image quality and add image to document

```csharp
public void AddImageToDocument(string dataDir, string jpgFileName, int pageNumber, int imageQuality)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataDir | String | Specify the path to the input PDF file |
| jpgFileName | String | The path to the JPG file |
| pageNumber | Int32 | Page where the image will be inserted |
| imageQuality | Int32 | Set image quality from 1 to 100, "1" - is the smallest resolution "100" - is the largest |

### Document.Document
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/document.md

#### Document(Stream)

Initializes new instance of `Document` class.

```csharp
public Document(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The document stream. |

#### Document(Stream, string)

Initializes new instance of `Document` class.

```csharp
public Document(Stream stream, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The document stream. |
| password | String | The document password. |

### Document.GeneratePreview
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/generatepreview.md

#### Document.GeneratePreview method

Generates document pages preview (screenshots of every page).

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The document preview options |

### Document.GetDocumentInfo
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/getdocumentinfo.md

#### Document.GetDocumentInfo method

Gets information about document - document type and size, pages count and detailed information about every page.

```csharp
public IDocumentInfo GetDocumentInfo()
```

### Document.Name
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/name.md

#### Document.Name property

Document name

```csharp
public string Name { get; set; }
```

### Document.Password
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/password.md

#### Document.Password property

Document password

```csharp
public string Password { get; }
```

### Document.Stream
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/document/stream.md

#### Document.Stream property

Document stream

```csharp
public Stream Stream { get; }
```

### Class FileType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype.md

#### FileType class

Information about file, such as type, extension, etc.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| static Bmp { get; } | Bitmap Image File. |
| static Doc { get; } | Microsoft Word format. |
| static Docm { get; } | Microsoft Word 2007 Macro file. |
| static Docx { get; } | Microsoft Word Open XML format. |
| static Dot { get; } | Microsoft Word Document Template. |
| static Dotm { get; } | Microsoft Word Macro-Enabled Document Template. |
| static Dotx { get; } | Microsoft Word Template. |
| static Dwg { get; } | AutoCAD Drawing Database File. |
| static Dxf { get; } | Drawing Exchange Format File. |
| static Eml { get; } | File in the MIME standard. |
| static Emlx { get; } | Apple's Mail.app program file format. |
| static Htm { get; } | Hypertext Markup Language File. |
| static Html { get; } | Hypertext Markup Language File. |
| static Jpeg { get; } | Joint Photographic Experts Group. |
| static Jpg { get; } | Joint Photographic Experts Group. |
| static Odp { get; } | Open Document Presentation. |
| static Ods { get; } | OpenDocument Spreadsheet Document format |
| static Odt { get; } | Open Document Text. |
| static Pdf { get; } | Adobe Portable Document format. |
| static Png { get; } | Portable Network Graphic File. |
| static Pps { get; } | Microsoft PowerPoint Slide Show (Legacy). |
| static Ppsx { get; } | Microsoft PowerPoint Slide Show. |
| static Ppt { get; } | Microsoft PowerPoint Presentation. |
| static Pptx { get; } | Microsoft PowerPoint Open XML Presentation. |
| static Rtf { get; } | Rich Text Format File. |
| static Tif { get; } | Tagged Image File. |
| static Tiff { get; } | Tagged Image File Format |
| static Unknown { get; } | Unknown. |
| static Vsd { get; } | Microsoft Visio VSD binary format. |
| static Vsdm { get; } | Microsoft Visio Macro-Enabled Drawing. |
| static Vsdx { get; } | Microsoft Visio 2013 VSDX file format. |
| static Vss { get; } | Microsoft Visio Stencil File. |
| static Vssx { get; } | Microsoft Visio Stencil File. |
| static Vst { get; } | Microsoft Visio VST binary template format. |
| static Vstm { get; } | Microsoft Visio Macro-Enabled Drawing Template. |
| static Vsx { get; } | Microsoft Visio Stencil XML File. |
| static Xls { get; } | Microsoft Excel Spreadsheet format. |
| static Xlsb { get; } | Excel Binary File Format |
| static Xlsm { get; } | Microsoft Excel Spreadsheet Macros format |
| static Xlsx { get; } | Microsoft Excel Open XML Spreadsheet. |
| Extension { get; } | File extention |
| FileFormat { get; } | File format |

#### Methods

| Name | Description |
| --- | --- |
| static FromFileNameOrExtension(string) | Return FileType based on file name or extension. |
| Equals(FileType) | File type equivalence check. |
| override Equals(object) | Equivalence check with object. |
| override GetHashCode() | Get hash code. |
| override ToString() | Returns a string that represents the file type. |
| static GetSupportedFileTypes() | Get supported file types enumeration. |
| operator == | Operator overload. |
| operator != | Operator overload. |

### FileType.Bmp
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/bmp.md

#### FileType.Bmp property

Bitmap Image File.

```csharp
public static FileType Bmp { get; }
```

### FileType.Doc
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/doc.md

#### FileType.Doc property

Microsoft Word format.

```csharp
public static FileType Doc { get; }
```

### FileType.Docm
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/docm.md

#### FileType.Docm property

Microsoft Word 2007 Macro file.

```csharp
public static FileType Docm { get; }
```

### FileType.Docx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/docx.md

#### FileType.Docx property

Microsoft Word Open XML format.

```csharp
public static FileType Docx { get; }
```

### FileType.Dot
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/dot.md

#### FileType.Dot property

Microsoft Word Document Template.

```csharp
public static FileType Dot { get; }
```

### FileType.Dotm
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/dotm.md

#### FileType.Dotm property

Microsoft Word Macro-Enabled Document Template.

```csharp
public static FileType Dotm { get; }
```

### FileType.Dotx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/dotx.md

#### FileType.Dotx property

Microsoft Word Template.

```csharp
public static FileType Dotx { get; }
```

### FileType.Dwg
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/dwg.md

#### FileType.Dwg property

AutoCAD Drawing Database File.

```csharp
public static FileType Dwg { get; }
```

### FileType.Dxf
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/dxf.md

#### FileType.Dxf property

Drawing Exchange Format File.

```csharp
public static FileType Dxf { get; }
```

### FileType.Eml
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/eml.md

#### FileType.Eml property

File in the MIME standard.

```csharp
public static FileType Eml { get; }
```

### FileType.Emlx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/emlx.md

#### FileType.Emlx property

Apple's Mail.app program file format.

```csharp
public static FileType Emlx { get; }
```

### FileType.Equals
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/equals.md

#### Equals(FileType)

File type equivalence check.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | FileType object. |

##### Return Value

True if file types are equivalent, false if not.

#### Equals(object)

Equivalence check with object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Any object. |

##### Return Value

True if file types are equivalent, false if not.

### FileType.Extension
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/extension.md

#### FileType.Extension property

File extention

```csharp
public string Extension { get; }
```

### FileType.FileFormat
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/fileformat.md

#### FileType.FileFormat property

File format

```csharp
public string FileFormat { get; }
```

### FileType.FromFileNameOrExtension
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/fromfilenameorextension.md

#### FileType.FromFileNameOrExtension method

Return FileType based on file name or extension.

```csharp
public static FileType FromFileNameOrExtension(string fileNameOrExtension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileNameOrExtension | String | The file name or file extension. |

##### Return Value

The file type.

### FileType.GetHashCode
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/gethashcode.md

#### FileType.GetHashCode method

Get hash code.

```csharp
public override int GetHashCode()
```

##### Return Value

Hash code.

### FileType.GetSupportedFileTypes
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Get supported file types enumeration.

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Enumeration of FileType.

### FileType.Htm
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/htm.md

#### FileType.Htm property

Hypertext Markup Language File.

```csharp
public static FileType Htm { get; }
```

### FileType.Html
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/html.md

#### FileType.Html property

Hypertext Markup Language File.

```csharp
public static FileType Html { get; }
```

### FileType.Jpeg
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/jpeg.md

#### FileType.Jpeg property

Joint Photographic Experts Group.

```csharp
public static FileType Jpeg { get; }
```

### FileType.Jpg
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/jpg.md

#### FileType.Jpg property

Joint Photographic Experts Group.

```csharp
public static FileType Jpg { get; }
```

### FileType.Odp
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/odp.md

#### FileType.Odp property

Open Document Presentation.

```csharp
public static FileType Odp { get; }
```

### FileType.Ods
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/ods.md

#### FileType.Ods property

OpenDocument Spreadsheet Document format

```csharp
public static FileType Ods { get; }
```

### FileType.Odt
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/odt.md

#### FileType.Odt property

Open Document Text.

```csharp
public static FileType Odt { get; }
```

### FileType.op_Equality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/op_equality.md

#### FileType Equality operator

Operator overload.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | The left file type. |
| right | FileType | The right file type. |

##### Return Value

True if file types are equivalent, false if not.

### FileType.op_Inequality
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/op_inequality.md

#### FileType Inequality operator

Operator overload.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | The left file type. |
| right | FileType | The right file type. |

##### Return Value

True if file types are different, false if not.

### FileType.Pdf
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/pdf.md

#### FileType.Pdf property

Adobe Portable Document format.

```csharp
public static FileType Pdf { get; }
```

### FileType.Png
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/png.md

#### FileType.Png property

Portable Network Graphic File.

```csharp
public static FileType Png { get; }
```

### FileType.Pps
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/pps.md

#### FileType.Pps property

Microsoft PowerPoint Slide Show (Legacy).

```csharp
public static FileType Pps { get; }
```

### FileType.Ppsx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/ppsx.md

#### FileType.Ppsx property

Microsoft PowerPoint Slide Show.

```csharp
public static FileType Ppsx { get; }
```

### FileType.Ppt
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/ppt.md

#### FileType.Ppt property

Microsoft PowerPoint Presentation.

```csharp
public static FileType Ppt { get; }
```

### FileType.Pptx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/pptx.md

#### FileType.Pptx property

Microsoft PowerPoint Open XML Presentation.

```csharp
public static FileType Pptx { get; }
```

### FileType.Rtf
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/rtf.md

#### FileType.Rtf property

Rich Text Format File.

```csharp
public static FileType Rtf { get; }
```

### FileType.Tif
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/tif.md

#### FileType.Tif property

Tagged Image File.

```csharp
public static FileType Tif { get; }
```

### FileType.Tiff
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/tiff.md

#### FileType.Tiff property

Tagged Image File Format

```csharp
public static FileType Tiff { get; }
```

### FileType.ToString
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the file type.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the file type.

### FileType.Unknown
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/unknown.md

#### FileType.Unknown property

Unknown.

```csharp
public static FileType Unknown { get; }
```

### FileType.Vsd
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vsd.md

#### FileType.Vsd property

Microsoft Visio VSD binary format.

```csharp
public static FileType Vsd { get; }
```

### FileType.Vsdm
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vsdm.md

#### FileType.Vsdm property

Microsoft Visio Macro-Enabled Drawing.

```csharp
public static FileType Vsdm { get; }
```

### FileType.Vsdx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vsdx.md

#### FileType.Vsdx property

Microsoft Visio 2013 VSDX file format.

```csharp
public static FileType Vsdx { get; }
```

### FileType.Vss
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vss.md

#### FileType.Vss property

Microsoft Visio Stencil File.

```csharp
public static FileType Vss { get; }
```

### FileType.Vssx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vssx.md

#### FileType.Vssx property

Microsoft Visio Stencil File.

```csharp
public static FileType Vssx { get; }
```

### FileType.Vst
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vst.md

#### FileType.Vst property

Microsoft Visio VST binary template format.

```csharp
public static FileType Vst { get; }
```

### FileType.Vstm
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vstm.md

#### FileType.Vstm property

Microsoft Visio Macro-Enabled Drawing Template.

```csharp
public static FileType Vstm { get; }
```

### FileType.Vsx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/vsx.md

#### FileType.Vsx property

Microsoft Visio Stencil XML File.

```csharp
public static FileType Vsx { get; }
```

### FileType.Xls
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/xls.md

#### FileType.Xls property

Microsoft Excel Spreadsheet format.

```csharp
public static FileType Xls { get; }
```

### FileType.Xlsb
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/xlsb.md

#### FileType.Xlsb property

Excel Binary File Format

```csharp
public static FileType Xlsb { get; }
```

### FileType.Xlsm
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/xlsm.md

#### FileType.Xlsm property

Microsoft Excel Spreadsheet Macros format

```csharp
public static FileType Xlsm { get; }
```

### FileType.Xlsx
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/filetype/xlsx.md

#### FileType.Xlsx property

Microsoft Excel Open XML Spreadsheet.

```csharp
public static FileType Xlsx { get; }
```

### Interface IDocumentInfo
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/idocumentinfo.md

#### IDocumentInfo interface

Interface that defines list of available document information

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | Document file type |
| PageCount { get; set; } | Amount of pages |
| PagesInfo { get; set; } | A list of information about each page |
| Size { get; set; } | File size in bytes |

### IDocumentInfo.FileType
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

Document file type

```csharp
public FileType FileType { get; set; }
```

### IDocumentInfo.PageCount
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Amount of pages

```csharp
public int PageCount { get; set; }
```

### IDocumentInfo.PagesInfo
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/idocumentinfo/pagesinfo.md

#### IDocumentInfo.PagesInfo property

A list of information about each page

```csharp
public List<PageInfo> PagesInfo { get; set; }
```

### IDocumentInfo.Size
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/idocumentinfo/size.md

#### IDocumentInfo.Size property

File size in bytes

```csharp
public long Size { get; set; }
```

### Class License
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/license.md

#### License class

Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing).

```csharp
public class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### License.License
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### License.SetLicense
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/license/setlicense.md

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | The license stream. |

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | The license path. |

### Class Metered
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/metered.md

#### Metered class

Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license.

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Activates product with Metered keys. |
| static GetConsumptionCredit() | Retrieves count of credits consumed. |
| static GetConsumptionQuantity() | Retrieves amount of MBs processed. |

### Metered.GetConsumptionCredit
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves count of credits consumed.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

consumption credit

### Metered.GetConsumptionQuantity
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Retrieves amount of MBs processed.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

consumption quantity

### Metered.Metered
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### Metered.SetMeteredKey
Path: https://reference.groupdocs.com/annotation/net/groupdocs.annotation/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Activates product with Metered keys.

```csharp
public void SetMeteredKey(string publicKey, string privateKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | String | public key |
| privateKey | String | private key |

## Python

### GroupDocs.Annotation for Python via .NET
Path: https://reference.groupdocs.com/annotation/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.annotation` | Main GroupDocs.Annotation namespace with top-level API classes. |
| `groupdocs.annotation.cache` | Types under `groupdocs.annotation.cache`. |
| `groupdocs.annotation.localization` | Types under `groupdocs.annotation.localization`. |
| `groupdocs.annotation.logging` | Logging hooks and listener interfaces. |
| `groupdocs.annotation.models` | Types under `groupdocs.annotation.models`. |
| `groupdocs.annotation.models.annotation_models` | Types under `groupdocs.annotation.models.annotation_models`. |
| `groupdocs.annotation.options` | Option classes for configuring conversions and operations. |
| `groupdocs.annotation.utility` | Types under `groupdocs.annotation.utility`. |

##### Developer Guide
* Task guides with runnable examples

### groupdocs.annotation.cache
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache.md

Types under `groupdocs.annotation.cache`.

##### Classes
| Class | Description |
| :- | :- |
| `FileCache` | Class that allows to work with the local on-disk cache. |
| `ICache` | Defines methods required for storing rendered document and document resources cache. |

### FileCache class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache.md

#### FileCache class

Class that allows to work with the local on-disk cache.

The FileCache type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `FileCache` class. |
| __init__ | Initializes a new instance of `FileCache`. |

##### Methods
| Method | Description |
| :- | :- |
| get_keys | Returns all file names that contain the filter in the filename. |
| get_keys_file |  |
| get_keys_string |  |
| set | Serializes data to the local disk. |
| set_file |  |
| set_string |  |
| try_get_value | Deserializes data associated with this key if present. |
| try_get_value_file |  |
| try_get_value_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/__init__.md

#### __init__

Initializes a new instance of `FileCache` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of `FileCache`.

```python
def __init__(self, path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| path | `str` | Path where cache data will be saved. |

### get_keys method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/get_keys.md

#### get_keys

Returns all file names that contain the filter in the filename.

```python
def get_keys(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `str` | The filter to use. |

**Returns:** list[str]: File names that contain the filter in the filename.

### get_keys_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/set.md

#### set

Serializes data to the local disk.

```python
def set(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` | An unique identifier for the cache entry. |
| value | `Any` | The object to serialize. |

### set_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/try_get_value.md

#### try_get_value

Deserializes data associated with this key if present.

```python
def try_get_value(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` | A key identifying the requested entry. |
| value | `Any` | The located value or None. |

**Returns:** bool: True if the key was found.

### try_get_value_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/try_get_value_file.md

#### try_get_value_file

```python
def try_get_value_file(self):
    ...
```

### try_get_value_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/filecache/try_get_value_string.md

#### try_get_value_string

```python
def try_get_value_string(self):
    ...
```

### ICache class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache.md

#### ICache class

Defines methods required for storing rendered document and document resources cache.

The ICache type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_keys | Returns all keys matching filter. |
| get_keys_file |  |
| get_keys_string |  |
| set | Inserts a cache entry into the cache. |
| set_file |  |
| set_string |  |
| try_get_value | Gets the entry associated with the given key if present. |
| try_get_value_file |  |
| try_get_value_string |  |

### get_keys method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/get_keys.md

#### get_keys

Returns all keys matching filter.

```python
def get_keys(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `str` | The filter to use. |

**Returns:** Keys matching the filter.

### get_keys_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/set.md

#### set

Inserts a cache entry into the cache.

```python
def set(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` | A unique identifier for the cache entry. |
| value | `Any` | The object to insert. |

### set_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/try_get_value.md

#### try_get_value

Gets the entry associated with the given key if present.

```python
def try_get_value(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` | A key identifying the requested entry. |
| value | `Any` | The located value or None. |

**Returns:** bool: True if the key was found.

### try_get_value_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/try_get_value_file.md

#### try_get_value_file

```python
def try_get_value_file(self):
    ...
```

### try_get_value_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.cache/icache/try_get_value_string.md

#### try_get_value_string

```python
def try_get_value_string(self):
    ...
```

### groupdocs.annotation.localization
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.localization.md

Types under `groupdocs.annotation.localization`.

##### Classes
| Class | Description |
| :- | :- |
| `SupportedLocales` | Class that provides methods for checking GroupDocs.Annotation supported locales. |

### SupportedLocales class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.localization/supportedlocales.md

#### SupportedLocales class

Class that provides methods for checking GroupDocs.Annotation supported locales.

The SupportedLocales type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| is_locale_supported | Determines whether the specified culture is supported by the GroupDocs.Annotation API. |
| is_locale_supported | Determines whether specified culture is supported by GroupDocs.Annotation API. |
| is_locale_supported_culture_info |  |
| is_locale_supported_file |  |
| is_locale_supported_string |  |

### is_locale_supported method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.localization/supportedlocales/is_locale_supported.md

#### is_locale_supported

Determines whether the specified culture is supported by the GroupDocs.Annotation API.

```python
def is_locale_supported(cls, culture):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| culture | `str` | The culture. |

**Returns:** bool: True if locale is supported, False otherwise.

#### is_locale_supported

Determines whether specified culture is supported by GroupDocs.Annotation API.

```python
def is_locale_supported(cls, culture):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| culture | `System.Globalization.CultureInfo` | The culture. |

### is_locale_supported_culture_info method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.localization/supportedlocales/is_locale_supported_culture_info.md

#### is_locale_supported_culture_info

```python
def is_locale_supported_culture_info(cls):
    ...
```

### is_locale_supported_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.localization/supportedlocales/is_locale_supported_file.md

#### is_locale_supported_file

```python
def is_locale_supported_file(cls):
    ...
```

### is_locale_supported_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.localization/supportedlocales/is_locale_supported_string.md

#### is_locale_supported_string

```python
def is_locale_supported_string(cls):
    ...
```

### groupdocs.annotation.logging
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging.md

Logging hooks and listener interfaces.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` | Logger implementation which logs all information to the console. |
| `ILogger` | ILogger interface that defines shared logger contract. |

### ConsoleLogger class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger.md

#### ConsoleLogger class

Logger implementation which logs all information to the console.

The ConsoleLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| error | Logs error message. |
| error_file |  |
| error_string |  |
| trace | Logs the process of annotating. |
| trace_file |  |
| trace_string |  |
| warning | Logs warning message. |
| warning_file |  |
| warning_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### error method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/error.md

#### error

Logs error message.

```python
def error(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The message. |
| exception | `Exception` | The exception that was thrown. |

### error_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/trace.md

#### trace

Logs the process of annotating.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The message. |

### trace_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/warning.md

#### warning

Logs warning message.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The message. |

### warning_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/consolelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger.md

#### ILogger class

ILogger interface that defines shared logger contract.

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| error | Error message. |
| error_file |  |
| error_string |  |
| trace | Trace message. |
| trace_file |  |
| trace_string |  |
| warning | Warning message. |
| warning_file |  |
| warning_string |  |

### error method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/error.md

#### error

Error message.

```python
def error(self, message, ex):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The string to log. |
| ex | `Exception` | The exception that was thrown. |

### error_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/trace.md

#### trace

Trace message.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The string to log. |

### trace_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/warning.md

#### warning

Warning message.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The string to log. |

### warning_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.logging/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### groupdocs.annotation.models.annotation_models
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models.md

Types under `groupdocs.annotation.models.annotation_models`.

##### Classes
| Class | Description |
| :- | :- |
| `AnnotationBase` | Base class for all annotation types. Contains basic annotation information. |
| `AreaAnnotation` | Represents area annotation properties. |
| `ArrowAnnotation` | Represents arrow annotation properties. |
| `DistanceAnnotation` | Represents distance annotation properties. |
| `EllipseAnnotation` | Represents ellipse annotation properties. |
| `HighlightAnnotation` | Represents highlight annotation properties. |
| `ImageAnnotation` | Represents image annotation properties. |
| `LinkAnnotation` | Represents link annotation properties. |
| `PointAnnotation` | Represents point annotation properties. |
| `PolylineAnnotation` | Represents polyline annotation properties. |
| `ReplacementAnnotation` | Represents replacement annotation properties. |
| `ResourcesRedactionAnnotation` | Represents resources redaction annotation properties. |
| `SearchTextFragment` | Represents searchText annotation properties. |
| `SquigglyAnnotation` | Represents squiggly annotation properties. |
| `StrikeoutAnnotation` | Represents strikeout annotation properties. |
| `TextFieldAnnotation` | Represents text field annotation properties. |
| `TextRedactionAnnotation` | Represents text redaction annotation properties. |
| `UnderlineAnnotation` | Represents underline annotation properties. |
| `WatermarkAnnotation` | Represents watermark annotation properties. |

### AnnotationBase class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase.md

#### AnnotationBase class

Base class for all annotation types. Contains basic annotation information.

The AnnotationBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns new instance with the same values. |
| equals | Compares base annotations using the IEquatable Equals method. |
| equals | Compares base annotations using the standard object `Equals` method. |
| equals_annotation_base |  |
| equals_object |  |
| get_hash_code | Returns HashCode of AnnotationBase Message, PageNumber and Type Properties. |

##### Properties
| Property | Description |
| :- | :- |
| created_on | The annotation creation date. |
| id | The annotation unique identifier. This field is auto-incremented. |
| message | The annotation message. |
| page_number | The page number where the annotation should be located. |
| replies | The list of replies (comments) attached to the annotation. |
| state_before_annotation | The previous state of the text before annotating. |
| type | The annotation type. |
| user | The annotation author. |

##### Guides
Task guides that use `AnnotationBase`:

* AI agents and LLM integration

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/clone.md

#### clone

Returns new instance with the same values.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/created_on.md

#### created_on property

The annotation creation date.

##### Definition:
```python
@property
def created_on(self):
    ...
@created_on.setter
def created_on(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/equals.md

#### equals

Compares base annotations using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `AnnotationBase` | The AnnotationBase object to compare with the current object. |

#### equals

Compares base annotations using the standard object `Equals` method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_annotation_base method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/equals_annotation_base.md

#### equals_annotation_base

```python
def equals_annotation_base(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/get_hash_code.md

#### get_hash_code

Returns HashCode of AnnotationBase Message, PageNumber and Type Properties.

```python
def get_hash_code(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/id.md

#### id property

The annotation unique identifier. This field is auto-incremented.

##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### message property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/message.md

#### message property

The annotation message.

##### Definition:
```python
@property
def message(self):
    ...
@message.setter
def message(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/page_number.md

#### page_number property

The page number where the annotation should be located.

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### replies property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/replies.md

#### replies property

The list of replies (comments) attached to the annotation.

Each reply is a `Reply` object representing a comment in the discussion thread.

##### Definition:
```python
@property
def replies(self):
    ...
@replies.setter
def replies(self, value):
    ...
```

### state_before_annotation property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/state_before_annotation.md

#### state_before_annotation property

The previous state of the text before annotating.

##### Definition:
```python
@property
def state_before_annotation(self):
    ...
@state_before_annotation.setter
def state_before_annotation(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/type.md

#### type property

The annotation type.

##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### user property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/annotationbase/user.md

#### user property

The annotation author.

##### Definition:
```python
@property
def user(self):
    ...
@user.setter
def user(self, value):
    ...
```

### AreaAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation.md

#### AreaAnnotation class

Represents area annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding area annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+area+annotation

The AreaAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes new instance of `AreaAnnotation` class. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance of the area annotation with the same values. |
| equals | Compares area annotation using the IEquatable `Equals` method. |
| equals | Compares area annotation using the standard object Equals method. |
| equals_area_annotation |  |
| equals_object |  |
| get_hash_code | Returns the hash code of the AreaAnnotation instance. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the area annotation. |
| box | The area annotation position. |
| opacity | The opacity of the area annotation. |
| pen_color | The pen color of the area annotation. |
| pen_style | The pen style of the area annotation. |
| pen_width | The pen width of the area annotation. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

area = AreaAnnotation()
area.box = Rectangle(100, 100, 200, 80)
area.background_color = Color.yellow.to_argb()
area.pen_color = Color.red.to_argb()
area.opacity = 0.7
area.page_number = 0
area.message = "Flagged region"

with Annotator("document.pdf") as annotator:
    annotator.add(area)
    annotator.save("annotated.pdf")
```

##### Guides
Task guides that use `AreaAnnotation`:

* AI agents and LLM integration
* Loading documents
* Saving documents
* Add annotations
* Comments and replies
* Hello, World!
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/__init__.md

#### __init__

Initializes new instance of `AreaAnnotation` class.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/background_color.md

#### background_color property

The background color of the area annotation.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/box.md

#### box property

The area annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/clone.md

#### clone

Returns a new instance of the area annotation with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/equals.md

#### equals

Compares area annotation using the IEquatable `Equals` method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `AreaAnnotation` | The `AreaAnnotation` object to compare with the current object. |

#### equals

Compares area annotation using the standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_area_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/equals_area_annotation.md

#### equals_area_annotation

```python
def equals_area_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the AreaAnnotation instance.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the instance.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/opacity.md

#### opacity property

The opacity of the area annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pen_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/pen_color.md

#### pen_color property

The pen color of the area annotation.

##### Definition:
```python
@property
def pen_color(self):
    ...
@pen_color.setter
def pen_color(self, value):
    ...
```

### pen_style property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/pen_style.md

#### pen_style property

The pen style of the area annotation.

##### Definition:
```python
@property
def pen_style(self):
    ...
@pen_style.setter
def pen_style(self, value):
    ...
```

### pen_width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/areaannotation/pen_width.md

#### pen_width property

The pen width of the area annotation.

##### Definition:
```python
@property
def pen_width(self):
    ...
@pen_width.setter
def pen_width(self, value):
    ...
```

### ArrowAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation.md

#### ArrowAnnotation class

Represents arrow annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding arrow annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+arrow+annotation

The ArrowAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `ArrowAnnotation` instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns new instance with same values. |
| equals | Compares area annotation using IEquatable Equals method. |
| equals | Compares arrow annotation using standard object Equals method. |
| equals_arrow_annotation |  |
| equals_object |  |
| get_hash_code | Returns HashCode of the arrow annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| box | The arrow annotation position. |
| opacity | The opacity of the arrow annotation. |
| pen_color | The arrow annotation pen color. |
| pen_style | The pen style of the arrow annotation. |
| pen_width | The pen width of the arrow annotation. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import ArrowAnnotation
from groupdocs.pydrawing import Color

def add_arrow_annotation():
    with Annotator("./sample.pdf") as annotator:
        arrow = ArrowAnnotation()
        arrow.box = Rectangle(100, 100, 100, 100)
        arrow.pen_color = Color.blue.to_argb()
        arrow.pen_width = 2
        arrow.pen_style = PenStyle.SOLID
        arrow.opacity = 0.9
        arrow.page_number = 0
        arrow.message = "This is an arrow annotation"
        annotator.add(arrow)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `ArrowAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/__init__.md

#### __init__

Initializes a new `ArrowAnnotation` instance.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import ArrowAnnotation
from groupdocs.pydrawing import Color

with Annotator("./sample.pdf") as annotator:
    arrow = ArrowAnnotation()
    arrow.box = Rectangle(100, 100, 100, 100)
    arrow.pen_color = Color.blue.to_argb()
    arrow.pen_width = 2
    arrow.pen_style = PenStyle.SOLID
    arrow.opacity = 0.9
    arrow.page_number = 0
    arrow.message = "This is an arrow annotation"
    annotator.add(arrow)
    annotator.save("./output.pdf")
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/box.md

#### box property

The arrow annotation position.

The bounding box of the arrow annotation, represented by a `Rectangle`.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/clone.md

#### clone

Returns new instance with same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/equals.md

#### equals

Compares area annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `ArrowAnnotation` | The ArrowAnnotation object to compare with the current object. |

#### equals

Compares arrow annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_arrow_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/equals_arrow_annotation.md

#### equals_arrow_annotation

```python
def equals_arrow_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/get_hash_code.md

#### get_hash_code

Returns HashCode of the arrow annotation.

```python
def get_hash_code(self):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/opacity.md

#### opacity property

The opacity of the arrow annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pen_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/pen_color.md

#### pen_color property

The arrow annotation pen color.

##### Definition:
```python
@property
def pen_color(self):
    ...
@pen_color.setter
def pen_color(self, value):
    ...
```

### pen_style property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/pen_style.md

#### pen_style property

The pen style of the arrow annotation.

##### Definition:
```python
@property
def pen_style(self):
    ...
@pen_style.setter
def pen_style(self, value):
    ...
```

### pen_width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/arrowannotation/pen_width.md

#### pen_width property

The pen width of the arrow annotation.

##### Definition:
```python
@property
def pen_width(self):
    ...
@pen_width.setter
def pen_width(self, value):
    ...
```

### DistanceAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation.md

#### DistanceAnnotation class

Represents distance annotation properties.

Learn more:

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: [How to annotate documents using GroupDocs.Annotation for .NET](https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document)
- More about adding distance annotations to documents of various types: [How to add distance annotations in C#](https://docs.groupdocs.com/display/annotationnet/Add+distance+annotation)

The DistanceAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `DistanceAnnotation`. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares this distance annotation with another using the IEquatable Equals method. |
| equals | Compares distance annotation using standard object Equals method. |
| equals_distance_annotation |  |
| equals_object |  |
| get_hash_code | Returns HashCode of the distance annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| box | The distance annotation position. |
| opacity | The opacity of the distance annotation. |
| pen_color | The pen color of the distance annotation. |
| pen_style | The pen style of the distance annotation. |
| pen_width | The distance annotation pen width. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import DistanceAnnotation
from groupdocs.pydrawing import Color

def add_distance_annotation():
    with Annotator("./sample.pdf") as annotator:
        distance = DistanceAnnotation()
        distance.box = Rectangle(100, 100, 100, 100)
        distance.pen_color = Color.blue.to_argb()
        distance.pen_width = 2
        distance.pen_style = PenStyle.SOLID
        distance.opacity = 0.7
        distance.page_number = 0
        distance.message = "This is a distance annotation"
        annotator.add(distance)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `DistanceAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/__init__.md

#### __init__

Initializes a new instance of `DistanceAnnotation`.

```python
def __init__(self):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/box.md

#### box property

The distance annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/equals.md

#### equals

Compares this distance annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `DistanceAnnotation` | The DistanceAnnotation object to compare with the current object. |

#### equals

Compares distance annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

**Returns:** bool: True if the specified object is equal to the current distance annotation; otherwise False.

### equals_distance_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/equals_distance_annotation.md

#### equals_distance_annotation

```python
def equals_distance_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/get_hash_code.md

#### get_hash_code

Returns HashCode of the distance annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the distance annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/opacity.md

#### opacity property

The opacity of the distance annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pen_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/pen_color.md

#### pen_color property

The pen color of the distance annotation.

##### Definition:
```python
@property
def pen_color(self):
    ...
@pen_color.setter
def pen_color(self, value):
    ...
```

### pen_style property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/pen_style.md

#### pen_style property

The pen style of the distance annotation.

##### Definition:
```python
@property
def pen_style(self):
    ...
@pen_style.setter
def pen_style(self, value):
    ...
```

### pen_width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/distanceannotation/pen_width.md

#### pen_width property

The distance annotation pen width.

##### Definition:
```python
@property
def pen_width(self):
    ...
@pen_width.setter
def pen_width(self, value):
    ...
```

### EllipseAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation.md

#### EllipseAnnotation class

Represents ellipse annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding ellipse annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+ellipse+annotation

The EllipseAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes new instance of `EllipseAnnotation` class. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares this ellipse annotation with another using the IEquatable Equals method. |
| equals | Compares the ellipse annotation with another object using the standard object Equals method. |
| equals_ellipse_annotation |  |
| equals_object |  |
| get_hash_code | Returns the hash code of the ellipse annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the ellipse annotation. |
| box | The ellipse annotation position. |
| opacity | The opacity of the annotation. |
| pen_color | The pen color of the ellipse annotation. |
| pen_style | The pen style of the ellipse annotation. |
| pen_width | The pen width of the ellipse annotation. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import EllipseAnnotation
from groupdocs.pydrawing import Color


def add_ellipse_annotation():
    with Annotator("./sample.pdf") as annotator:
        ellipse = EllipseAnnotation()
        ellipse.box = Rectangle(100, 100, 200, 120)
        ellipse.background_color = Color.from_argb(255, 144, 238, 144).to_argb()
        ellipse.pen_color = Color.green.to_argb()
        ellipse.pen_width = 2
        ellipse.pen_style = PenStyle.SOLID
        ellipse.opacity = 0.7
        ellipse.page_number = 0
        ellipse.message = "This is an ellipse annotation"
        annotator.add(ellipse)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_ellipse_annotation()
```

##### Guides
Task guides that use `EllipseAnnotation`:

* AI agents and LLM integration
* Saving documents
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/__init__.md

#### __init__

Initializes new instance of `EllipseAnnotation` class.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/background_color.md

#### background_color property

The background color of the ellipse annotation.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/box.md

#### box property

The ellipse annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

**Returns:** EllipseAnnotation

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/equals.md

#### equals

Compares this ellipse annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `EllipseAnnotation` | The EllipseAnnotation object to compare with the current object. |

#### equals

Compares the ellipse annotation with another object using the standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_ellipse_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/equals_ellipse_annotation.md

#### equals_ellipse_annotation

```python
def equals_ellipse_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the ellipse annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the ellipse annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/opacity.md

#### opacity property

The opacity of the annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pen_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/pen_color.md

#### pen_color property

The pen color of the ellipse annotation.

##### Definition:
```python
@property
def pen_color(self):
    ...
@pen_color.setter
def pen_color(self, value):
    ...
```

### pen_style property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/pen_style.md

#### pen_style property

The pen style of the ellipse annotation.

##### Definition:
```python
@property
def pen_style(self):
    ...
@pen_style.setter
def pen_style(self, value):
    ...
```

### pen_width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/ellipseannotation/pen_width.md

#### pen_width property

The pen width of the ellipse annotation.

##### Definition:
```python
@property
def pen_width(self):
    ...
@pen_width.setter
def pen_width(self, value):
    ...
```

### HighlightAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation.md

#### HighlightAnnotation class

Represents highlight annotation properties.

Learn more
- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding highlight annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+highlight+annotation

The HighlightAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `HighlightAnnotation`. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares highlight annotation using IEquatable Equals method. |
| equals | Compares highlight annotations using the standard object `Equals` method. |
| equals_highlight_annotation |  |
| equals_object |  |
| get_hash_code | Returns the hash code of the highlight annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the highlight annotation as an ARGB integer. |
| font_color | The highlight annotation text font color. |
| opacity | The opacity of the highlight annotation. |
| points | The collection of `Point` objects that describe rectangles with text. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import HighlightAnnotation
from groupdocs.pydrawing import Color


def add_highlight_annotation():
    with Annotator("./sample.pdf") as annotator:
        highlight = HighlightAnnotation()
        # Text-markup annotations are positioned by the corner points of the
        # text region: top-left, top-right, bottom-left, bottom-right
        highlight.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        highlight.background_color = Color.yellow.to_argb()
        highlight.opacity = 0.7
        highlight.page_number = 0
        highlight.message = "This is a highlight annotation"
        annotator.add(highlight)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `HighlightAnnotation`:

* AI agents and LLM integration
* Add annotations
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/__init__.md

#### __init__

Initializes a new instance of `HighlightAnnotation`.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/background_color.md

#### background_color property

The background color of the highlight annotation as an ARGB integer.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/equals.md

#### equals

Compares highlight annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `HighlightAnnotation` | The HighlightAnnotation object to compare with the current object. |

#### equals

Compares highlight annotations using the standard object `Equals` method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_highlight_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/equals_highlight_annotation.md

#### equals_highlight_annotation

```python
def equals_highlight_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/font_color.md

#### font_color property

The highlight annotation text font color.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the highlight annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the highlight annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/opacity.md

#### opacity property

The opacity of the highlight annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/highlightannotation/points.md

#### points property

The collection of `Point` objects that describe rectangles with text.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### ImageAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation.md

#### ImageAnnotation class

Represents image annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding image annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+image+annotation

The ImageAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new ImageAnnotation instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares image annotation using IEquatable Equals method. |
| equals | Compares image annotation using standard object Equals method. |
| equals_image_annotation |  |
| equals_object |  |
| get_hash_code | Returns the hash code of the image annotation. |
| get_image | Gets image object. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| angle | The image annotation rotation angle. |
| box | The image annotation position. |
| image_data | The image annotation data. |
| image_extension | The image extensions (png, jpg, svg etc). |
| image_path | The image annotation path. |
| opacity | The opacity of the image annotation. |
| zindex | The image annotation z-index. Default value is 0. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ImageAnnotation


def add_image_annotation():
    with Annotator("./sample.pdf") as annotator:
        image = ImageAnnotation()
        image.box = Rectangle(100, 100, 100, 100)
        image.image_path = "./stamp.png"
        image.opacity = 0.9
        image.angle = 0.0
        image.page_number = 0
        image.message = "This is an image annotation"
        annotator.add(image)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_image_annotation()
```

##### Guides
Task guides that use `ImageAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/__init__.md

#### __init__

Initializes a new ImageAnnotation instance.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ImageAnnotation

def add_image_annotation():
    with Annotator("./sample.pdf") as annotator:
        image = ImageAnnotation()
        image.box = Rectangle(100, 100, 100, 100)
        image.image_path = "./stamp.png"
        image.opacity = 0.9
        image.angle = 0.0
        image.page_number = 0
        image.message = "This is an image annotation"
        annotator.add(image)
        annotator.save("./output.pdf")
```

### angle property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/angle.md

#### angle property

The image annotation rotation angle.

##### Definition:
```python
@property
def angle(self):
    ...
@angle.setter
def angle(self, value):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/box.md

#### box property

The image annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/equals.md

#### equals

Compares image annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `ImageAnnotation` | The ImageAnnotation object to compare with the current object. |

#### equals

Compares image annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_image_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/equals_image_annotation.md

#### equals_image_annotation

```python
def equals_image_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the image annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the image annotation.

### get_image method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/get_image.md

#### get_image

Gets image object.

```python
def get_image(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/image_data.md

#### image_data property

The image annotation data.

##### Definition:
```python
@property
def image_data(self):
    ...
@image_data.setter
def image_data(self, value):
    ...
```

### image_extension property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/image_extension.md

#### image_extension property

The image extensions (png, jpg, svg etc).

##### Definition:
```python
@property
def image_extension(self):
    ...
```

### image_path property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/image_path.md

#### image_path property

The image annotation path.

##### Definition:
```python
@property
def image_path(self):
    ...
@image_path.setter
def image_path(self, value):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/opacity.md

#### opacity property

The opacity of the image annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### zindex property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/imageannotation/zindex.md

#### zindex property

The image annotation z-index. Default value is 0.

The z-index property specifies the stack order of an element.

##### Definition:
```python
@property
def zindex(self):
    ...
@zindex.setter
def zindex(self, value):
    ...
```

### LinkAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation.md

#### LinkAnnotation class

Represents link annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding link annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+link+annotation

The LinkAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `LinkAnnotation`. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares this link annotation with another using the IEquatable Equals method. |
| equals | Compares link annotation using standard object Equals method. |
| equals_link_annotation |  |
| equals_object |  |
| get_hash_code | Returns HashCode of link annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the link annotation. |
| font_color | The text color of the link annotation. |
| opacity | The opacity of the link annotation. |
| points | The link annotation coordinates as a list of points. |
| url | The annotation link URL. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import LinkAnnotation
from groupdocs.pydrawing import Color

def add_link_annotation():
    with Annotator("./sample.pdf") as annotator:
        link = LinkAnnotation()
        link.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        link.url = "https://www.groupdocs.com"
        link.background_color = Color.azure.to_argb()
        link.opacity = 0.7
        link.page_number = 0
        link.message = "This is a link annotation"
        annotator.add(link)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `LinkAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/__init__.md

#### __init__

Initializes a new instance of `LinkAnnotation`.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/background_color.md

#### background_color property

The background color of the link annotation.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

**Returns:** LinkAnnotation: A new `LinkAnnotation` instance containing the same property values as the original.

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/equals.md

#### equals

Compares this link annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `LinkAnnotation` | The LinkAnnotation object to compare with the current object. |

#### equals

Compares link annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_link_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/equals_link_annotation.md

#### equals_link_annotation

```python
def equals_link_annotation(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/font_color.md

#### font_color property

The text color of the link annotation.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/get_hash_code.md

#### get_hash_code

Returns HashCode of link annotation.

```python
def get_hash_code(self):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/opacity.md

#### opacity property

The opacity of the link annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/points.md

#### points property

The link annotation coordinates as a list of points.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### url property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/linkannotation/url.md

#### url property

The annotation link URL.

##### Definition:
```python
@property
def url(self):
    ...
@url.setter
def url(self, value):
    ...
```

### PointAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation.md

#### PointAnnotation class

Represents point annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding point annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+point+annotation

The PointAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new PointAnnotation instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns new instance with the same values. |
| equals | Compares point annotation using IEquatable Equals method. |
| equals | Compares point annotation using standard object Equals method. |
| equals_object |  |
| equals_point_annotation |  |
| get_hash_code | Returns HashCode of the point annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| box | The point annotation position. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import PointAnnotation


def add_point_annotation():
    with Annotator("./sample.pdf") as annotator:
        point = PointAnnotation()
        point.box = Rectangle(100, 100, 0, 0)   # a point is positioned by its box origin
        point.page_number = 0
        point.message = "This is a point annotation"
        annotator.add(point)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_point_annotation()
```

##### Guides
Task guides that use `PointAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/__init__.md

#### __init__

Initializes a new PointAnnotation instance.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import PointAnnotation

with Annotator("./sample.pdf") as annotator:
    point = PointAnnotation()
    point.box = Rectangle(100, 100, 0, 0)   # positioned by box origin
    point.page_number = 0
    point.message = "This is a point annotation"
    annotator.add(point)
    annotator.save("./output.pdf")
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/box.md

#### box property

The point annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/clone.md

#### clone

Returns new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/equals.md

#### equals

Compares point annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `PointAnnotation` | The PointAnnotation object to compare with the current object. |

#### equals

Compares point annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_point_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/equals_point_annotation.md

#### equals_point_annotation

```python
def equals_point_annotation(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/pointannotation/get_hash_code.md

#### get_hash_code

Returns HashCode of the point annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the point annotation.

### PolylineAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation.md

#### PolylineAnnotation class

Represents polyline annotation properties.

Learn more:

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding polyline annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+polyline+annotation

The PolylineAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `AreaAnnotation` class. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns new instance with the same values. |
| equals | Compares this polyline annotation with another using the IEquatable Equals method. |
| equals | Compares polyline annotation using standard object Equals method. |
| equals_object |  |
| equals_polyline_annotation |  |
| get_hash_code | Returns hash code of the polyline annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| box | The polyline annotation position as a `Rectangle`. |
| opacity | The polyline annotation opacity. |
| pen_color | The pen color of the polyline annotation. |
| pen_style | The pen style of the polyline annotation. |
| pen_width | The polyline annotation pen width. |
| svg_path | The SVG path of the polyline annotation. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import PolylineAnnotation
from groupdocs.pydrawing import Color


def add_polyline_annotation():
    with Annotator("./sample.pdf") as annotator:
        polyline = PolylineAnnotation()
        polyline.box = Rectangle(100, 100, 200, 100)
        polyline.svg_path = "M 0 0 L 50 50 L 100 0 L 150 50"
        polyline.pen_color = Color.purple.to_argb()
        polyline.pen_width = 2
        polyline.pen_style = PenStyle.SOLID
        polyline.opacity = 0.9
        polyline.page_number = 0
        polyline.message = "This is a polyline annotation"
        annotator.add(polyline)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_polyline_annotation()
```

##### Guides
Task guides that use `PolylineAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/__init__.md

#### __init__

Initializes a new instance of `AreaAnnotation` class.

```python
def __init__(self):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/box.md

#### box property

The polyline annotation position as a `Rectangle`.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/clone.md

#### clone

Returns new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/equals.md

#### equals

Compares this polyline annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `PolylineAnnotation` | The PolylineAnnotation object to compare with the current object. |

#### equals

Compares polyline annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_polyline_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/equals_polyline_annotation.md

#### equals_polyline_annotation

```python
def equals_polyline_annotation(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/get_hash_code.md

#### get_hash_code

Returns hash code of the polyline annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the polyline annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/opacity.md

#### opacity property

The polyline annotation opacity.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pen_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/pen_color.md

#### pen_color property

The pen color of the polyline annotation.

Accepts an ARGB integer value, typically obtained via `Color.<name>.to_argb()`.

##### Definition:
```python
@property
def pen_color(self):
    ...
@pen_color.setter
def pen_color(self, value):
    ...
```

### pen_style property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/pen_style.md

#### pen_style property

The pen style of the polyline annotation.

##### Definition:
```python
@property
def pen_style(self):
    ...
@pen_style.setter
def pen_style(self, value):
    ...
```

### pen_width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/pen_width.md

#### pen_width property

The polyline annotation pen width.

##### Definition:
```python
@property
def pen_width(self):
    ...
@pen_width.setter
def pen_width(self, value):
    ...
```

### svg_path property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/polylineannotation/svg_path.md

#### svg_path property

The SVG path of the polyline annotation.

##### Definition:
```python
@property
def svg_path(self):
    ...
@svg_path.setter
def svg_path(self, value):
    ...
```

### ReplacementAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation.md

#### ReplacementAnnotation class

Represents replacement annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding replacement annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+replacement+annotation

The ReplacementAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `ReplacementAnnotation`. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns new instance with the same values. |
| equals | Compares replacement annotation using IEquatable Equals method. |
| equals | Compares the replacement annotation with another object using the standard object Equals method. |
| equals_object |  |
| equals_replacement_annotation |  |
| get_hash_code | Returns the hash code of the replacement annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the replacement annotation. |
| font_color | The replacement annotation text color. |
| font_size | The replacement annotation text size. |
| opacity | The replacement annotation opacity. |
| points | The collection of points that describe rectangles with text. |
| text_to_replace | The text to be replaced. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import ReplacementAnnotation
from groupdocs.pydrawing import Color


def add_replacement_annotation():
    with Annotator("./sample.pdf") as annotator:
        replacement = ReplacementAnnotation()
        replacement.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        replacement.text_to_replace = "replacement text"
        replacement.font_color = Color.black.to_argb()
        replacement.font_size = 12.0
        replacement.opacity = 0.9
        replacement.page_number = 0
        replacement.message = "This is a text replacement annotation"
        annotator.add(replacement)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_replacement_annotation()
```

##### Guides
Task guides that use `ReplacementAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/__init__.md

#### __init__

Initializes a new instance of `ReplacementAnnotation`.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/background_color.md

#### background_color property

The background color of the replacement annotation.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/clone.md

#### clone

Returns new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/equals.md

#### equals

Compares replacement annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `ReplacementAnnotation` | The ReplacementAnnotation object to compare with the current object |

#### equals

Compares the replacement annotation with another object using the standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_replacement_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/equals_replacement_annotation.md

#### equals_replacement_annotation

```python
def equals_replacement_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/font_color.md

#### font_color property

The replacement annotation text color.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### font_size property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/font_size.md

#### font_size property

The replacement annotation text size.

##### Definition:
```python
@property
def font_size(self):
    ...
@font_size.setter
def font_size(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the replacement annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the replacement annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/opacity.md

#### opacity property

The replacement annotation opacity.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/points.md

#### points property

The collection of points that describe rectangles with text.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### text_to_replace property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/replacementannotation/text_to_replace.md

#### text_to_replace property

The text to be replaced.

##### Definition:
```python
@property
def text_to_replace(self):
    ...
@text_to_replace.setter
def text_to_replace(self, value):
    ...
```

### ResourcesRedactionAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation.md

#### ResourcesRedactionAnnotation class

Represents resources redaction annotation properties.

Learn more:

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding resource redaction annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+resource+redaction+annotation

The ResourcesRedactionAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `ResourcesRedactionAnnotation` instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares resource redaction annotation using IEquatable Equals method. |
| equals | Compares resource redaction annotation using standard object Equals method. |
| equals_object |  |
| equals_resources_redaction_annotation |  |
| get_hash_code | Returns the hash code of the resource redaction annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| box | The resource redaction annotation position as a `Rectangle`. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ResourcesRedactionAnnotation

def add_resources_redaction_annotation():
    with Annotator("./sample.pdf") as annotator:
        redaction = ResourcesRedactionAnnotation()
        redaction.box = Rectangle(100, 100, 200, 80)
        redaction.page_number = 0
        redaction.message = "This is a resources redaction annotation"
        annotator.add(redaction)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `ResourcesRedactionAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/__init__.md

#### __init__

Initializes a new `ResourcesRedactionAnnotation` instance.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ResourcesRedactionAnnotation

with Annotator("./sample.pdf") as annotator:
    redaction = ResourcesRedactionAnnotation()
    redaction.box = Rectangle(100, 100, 200, 80)
    redaction.page_number = 0
    redaction.message = "This is a resources redaction annotation"
    annotator.add(redaction)
    annotator.save("./output.pdf")
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/box.md

#### box property

The resource redaction annotation position as a `Rectangle`.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/equals.md

#### equals

Compares resource redaction annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `ResourcesRedactionAnnotation` | The ResourcesRedactionAnnotation object to compare with the current object. |

**Returns:** bool: True if the annotations are equal; otherwise False.

#### equals

Compares resource redaction annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_resources_redaction_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/equals_resources_redaction_annotation.md

#### equals_resources_redaction_annotation

```python
def equals_resources_redaction_annotation(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/resourcesredactionannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the resource redaction annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: The hash code.

### SearchTextFragment class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment.md

#### SearchTextFragment class

Represents searchText annotation properties.

Learn more

- More about annotation types and annotating PDF: How to annotate documents using GroupDocs.Annotation for .NET (https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document)
- More about adding searchText annotations to documents of various types: How to add searchText annotations in C# (https://docs.groupdocs.com/display/annotationnet/Add+searchText+annotation)

The SearchTextFragment type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `SearchTextFragment`. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares search text annotation using IEquatable Equals method. |
| equals | Compares search text annotation using standard object Equals method. |
| equals_object |  |
| equals_search_text_fragment |  |
| get_hash_code | Returns HashCode of SearchText Annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The text background color. |
| font_color | The text color. |
| font_family | The text font family. |
| font_size | The text size. |
| text | The text that needs to be found. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/__init__.md

#### __init__

Initializes a new instance of `SearchTextFragment`.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/background_color.md

#### background_color property

The text background color.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

**Returns:** SearchTextFragment: A new `SearchTextFragment` instance containing the same values.

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/equals.md

#### equals

Compares search text annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `SearchTextFragment` | The SearchTextFragment object to compare with the current object. |

#### equals

Compares search text annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

**Returns:** bool: True if the specified object is equal to the current search text fragment; otherwise, False.

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_search_text_fragment method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/equals_search_text_fragment.md

#### equals_search_text_fragment

```python
def equals_search_text_fragment(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/font_color.md

#### font_color property

The text color.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### font_family property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/font_family.md

#### font_family property

The text font family.

##### Definition:
```python
@property
def font_family(self):
    ...
@font_family.setter
def font_family(self, value):
    ...
```

### font_size property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/font_size.md

#### font_size property

The text size.

##### Definition:
```python
@property
def font_size(self):
    ...
@font_size.setter
def font_size(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/get_hash_code.md

#### get_hash_code

Returns HashCode of SearchText Annotation.

```python
def get_hash_code(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/searchtextfragment/text.md

#### text property

The text that needs to be found.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### SquigglyAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation.md

#### SquigglyAnnotation class

Represents squiggly annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding squiggly annotations to documents of various types: https://docs.groupdocs.com/annotation/net/add-squiggly-annotation/

The SquigglyAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `SquigglyAnnotation`. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares this squiggly annotation with another `SquigglyAnnotation` using the IEquatable Equals method. |
| equals | Compares the squiggly annotation with another object using the standard object Equals method. |
| equals_object |  |
| equals_squiggly_annotation |  |
| get_hash_code | Returns the hash code of the squiggly annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the squiggly annotation text. |
| font_color | The font color of the squiggly annotation text. |
| opacity | The opacity of the squiggly annotation. |
| points | The collection of points that describe rectangles with text. |
| squiggly_color | The color of the squiggly annotation. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import SquigglyAnnotation
from groupdocs.pydrawing import Color


def add_squiggly_annotation():
    with Annotator("./sample.pdf") as annotator:
        squiggly = SquigglyAnnotation()
        squiggly.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        squiggly.squiggly_color = Color.red.to_argb()
        squiggly.opacity = 0.9
        squiggly.page_number = 0
        squiggly.message = "This is a squiggly annotation"
        annotator.add(squiggly)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_squiggly_annotation()
```

##### Guides
Task guides that use `SquigglyAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/__init__.md

#### __init__

Initializes a new instance of `SquigglyAnnotation`.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/background_color.md

#### background_color property

The background color of the squiggly annotation text.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/equals.md

#### equals

Compares this squiggly annotation with another `SquigglyAnnotation` using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `SquigglyAnnotation` | The `SquigglyAnnotation` object to compare with the current object. |

**Returns:** bool: True if the annotations are equal; otherwise False.

#### equals

Compares the squiggly annotation with another object using the standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_squiggly_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/equals_squiggly_annotation.md

#### equals_squiggly_annotation

```python
def equals_squiggly_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/font_color.md

#### font_color property

The font color of the squiggly annotation text.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the squiggly annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: The hash code of the squiggly annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/opacity.md

#### opacity property

The opacity of the squiggly annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/points.md

#### points property

The collection of points that describe rectangles with text.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### squiggly_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/squigglyannotation/squiggly_color.md

#### squiggly_color property

The color of the squiggly annotation.

##### Definition:
```python
@property
def squiggly_color(self):
    ...
@squiggly_color.setter
def squiggly_color(self, value):
    ...
```

### StrikeoutAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation.md

#### StrikeoutAnnotation class

Represents strikeout annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding strikeout annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+strikeout+annotation

The StrikeoutAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `StrikeoutAnnotation` class. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares the strikeout annotation with another using the IEquatable Equals method. |
| equals | Compares strikeout annotation using standard object Equals method. |
| equals_object |  |
| equals_strikeout_annotation |  |
| get_hash_code | Returns the hash code of the strikeout annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the strikeout annotation text. |
| font_color | The font color of the strikeout annotation text. |
| opacity | The opacity of the strikeout annotation. |
| points | The collection of points that describe rectangles with text. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import StrikeoutAnnotation
from groupdocs.pydrawing import Color

def add_strikeout_annotation():
    with Annotator("./sample.pdf") as annotator:
        strikeout = StrikeoutAnnotation()
        strikeout.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        strikeout.font_color = Color.red.to_argb()
        strikeout.opacity = 0.9
        strikeout.page_number = 0
        strikeout.message = "This is a strikeout annotation"
        annotator.add(strikeout)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `StrikeoutAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/__init__.md

#### __init__

Initializes a new instance of `StrikeoutAnnotation` class.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import StrikeoutAnnotation
from groupdocs.pydrawing import Color

with Annotator("./sample.pdf") as annotator:
    strikeout = StrikeoutAnnotation()
    strikeout.points = [
        Point(80, 600), Point(300, 600),
        Point(80, 575), Point(300, 575),
    ]
    strikeout.font_color = Color.red.to_argb()
    strikeout.opacity = 0.9
    strikeout.page_number = 0
    strikeout.message = "This is a strikeout annotation"
    annotator.add(strikeout)
    annotator.save("./output.pdf")
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/background_color.md

#### background_color property

The background color of the strikeout annotation text.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

**Returns:** StrikeoutAnnotation: New instance with the same values.

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/equals.md

#### equals

Compares the strikeout annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `StrikeoutAnnotation` | The `StrikeoutAnnotation` object to compare with the current object. |

#### equals

Compares strikeout annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_strikeout_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/equals_strikeout_annotation.md

#### equals_strikeout_annotation

```python
def equals_strikeout_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/font_color.md

#### font_color property

The font color of the strikeout annotation text.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the strikeout annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/opacity.md

#### opacity property

The opacity of the strikeout annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/strikeoutannotation/points.md

#### points property

The collection of points that describe rectangles with text.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### TextFieldAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation.md

#### TextFieldAnnotation class

Represents text field annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: [How to annotate documents using GroupDocs.Annotation for .NET](https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document)
- More about adding text field annotations to documents of various types: [How to add text field annotations in C#](https://docs.groupdocs.com/display/annotationnet/Add+text+field+annotation)

The TextFieldAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `TextFieldAnnotation` instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares this text field annotation with another using the IEquatable Equals method. |
| equals | Compares text field annotation using standard object Equals method. |
| equals_object |  |
| equals_text_field_annotation |  |
| get_hash_code | Returns HashCode of the text field annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text field annotation. |
| box | The text field annotation position. |
| font_color | The font color of the text field annotation. |
| font_family | The font family of the text field annotation. |
| font_size | The font size of the text field annotation. |
| opacity | The opacity of the text field annotation. |
| pen_color | The pen color of the text field annotation. |
| pen_style | The pen style of the text field annotation. |
| pen_width | The pen width of the text field annotation. |
| text | The text of the text field annotation. |
| text_horizontal_alignment | The horizontal alignment of the text. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, HorizontalAlignment
from groupdocs.annotation.models.annotation_models import TextFieldAnnotation
from groupdocs.pydrawing import Color


def add_text_field_annotation():
    with Annotator("./sample.pdf") as annotator:
        text_field = TextFieldAnnotation()
        text_field.box = Rectangle(100, 100, 150, 50)
        text_field.text = "Some text in a field"
        text_field.font_family = "Arial"
        text_field.font_size = 12.0
        text_field.font_color = Color.black.to_argb()
        text_field.background_color = Color.yellow.to_argb()
        text_field.text_horizontal_alignment = HorizontalAlignment.CENTER
        text_field.opacity = 0.9
        text_field.page_number = 0
        text_field.message = "This is a text field annotation"
        annotator.add(text_field)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_text_field_annotation()
```

##### Guides
Task guides that use `TextFieldAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/__init__.md

#### __init__

Initializes a new `TextFieldAnnotation` instance.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/background_color.md

#### background_color property

The background color of the text field annotation.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/box.md

#### box property

The text field annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/equals.md

#### equals

Compares this text field annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `TextFieldAnnotation` | The TextFieldAnnotation object to compare with the current object. |

#### equals

Compares text field annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_text_field_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/equals_text_field_annotation.md

#### equals_text_field_annotation

```python
def equals_text_field_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/font_color.md

#### font_color property

The font color of the text field annotation.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### font_family property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/font_family.md

#### font_family property

The font family of the text field annotation.

##### Definition:
```python
@property
def font_family(self):
    ...
@font_family.setter
def font_family(self, value):
    ...
```

### font_size property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/font_size.md

#### font_size property

The font size of the text field annotation.

##### Definition:
```python
@property
def font_size(self):
    ...
@font_size.setter
def font_size(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/get_hash_code.md

#### get_hash_code

Returns HashCode of the text field annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code for this annotation.

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/opacity.md

#### opacity property

The opacity of the text field annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pen_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/pen_color.md

#### pen_color property

The pen color of the text field annotation.

##### Definition:
```python
@property
def pen_color(self):
    ...
@pen_color.setter
def pen_color(self, value):
    ...
```

### pen_style property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/pen_style.md

#### pen_style property

The pen style of the text field annotation.

##### Definition:
```python
@property
def pen_style(self):
    ...
@pen_style.setter
def pen_style(self, value):
    ...
```

### pen_width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/pen_width.md

#### pen_width property

The pen width of the text field annotation.

##### Definition:
```python
@property
def pen_width(self):
    ...
@pen_width.setter
def pen_width(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/text.md

#### text property

The text of the text field annotation.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### text_horizontal_alignment property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textfieldannotation/text_horizontal_alignment.md

#### text_horizontal_alignment property

The horizontal alignment of the text.

##### Definition:
```python
@property
def text_horizontal_alignment(self):
    ...
@text_horizontal_alignment.setter
def text_horizontal_alignment(self, value):
    ...
```

### TextRedactionAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation.md

#### TextRedactionAnnotation class

Represents text redaction annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding text redaction annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+text+redaction+annotation

The TextRedactionAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `TextRedactionAnnotation` instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares this text redaction annotation with another using the IEquatable Equals method. |
| equals | Compares text redaction annotation using standard object Equals method. |
| equals_object |  |
| equals_text_redaction_annotation |  |
| get_hash_code | Returns hash code of the text redaction annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| font_color | The text font color of the text redaction annotation. |
| points | The collection of points that describe rectangles with text. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import TextRedactionAnnotation
from groupdocs.pydrawing import Color


def add_text_redaction_annotation():
    with Annotator("./sample.pdf") as annotator:
        redaction = TextRedactionAnnotation()
        redaction.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        redaction.font_color = Color.black.to_argb()
        redaction.page_number = 0
        redaction.message = "This is a text redaction annotation"
        annotator.add(redaction)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_text_redaction_annotation()
```

##### Guides
Task guides that use `TextRedactionAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/__init__.md

#### __init__

Initializes a new `TextRedactionAnnotation` instance.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation.models.annotation_models import TextRedactionAnnotation

# Create a text redaction annotation with default settings
redaction = TextRedactionAnnotation()
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/equals.md

#### equals

Compares this text redaction annotation with another using the IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `TextRedactionAnnotation` | The TextRedactionAnnotation object to compare with the current object. |

#### equals

Compares text redaction annotation using standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_text_redaction_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/equals_text_redaction_annotation.md

#### equals_text_redaction_annotation

```python
def equals_text_redaction_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/font_color.md

#### font_color property

The text font color of the text redaction annotation.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/get_hash_code.md

#### get_hash_code

Returns hash code of the text redaction annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code of the annotation.

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/textredactionannotation/points.md

#### points property

The collection of points that describe rectangles with text.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### UnderlineAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation.md

#### UnderlineAnnotation class

Represents underline annotation properties.

Learn more

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding underline annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+underline+annotation

The UnderlineAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `UnderlineAnnotation` instance. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns new instance with the same values. |
| equals | Compares this underline annotation with another underline annotation. |
| equals | Compares underline annotation using the standard object Equals method. |
| equals_object |  |
| equals_underline_annotation |  |
| get_hash_code | Returns HashCode of the underline annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The underline annotation text background color. |
| font_color | The text color of the underline annotation. |
| opacity | The underline annotation opacity. |
| points | The collection of points that describe rectangles with text. |
| underline_color | The underline annotation color as an ARGB integer. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import UnderlineAnnotation
from groupdocs.pydrawing import Color


def add_underline_annotation():
    with Annotator("./sample.pdf") as annotator:
        underline = UnderlineAnnotation()
        underline.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        underline.underline_color = Color.red.to_argb()
        underline.opacity = 0.9
        underline.page_number = 0
        underline.message = "This is an underline annotation"
        annotator.add(underline)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `UnderlineAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/__init__.md

#### __init__

Initializes a new `UnderlineAnnotation` instance.

```python
def __init__(self):
    ...
```

##### Example

```python
from groupdocs.annotation.models.annotation_models import UnderlineAnnotation

underline = UnderlineAnnotation()
```

### background_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/background_color.md

#### background_color property

The underline annotation text background color.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/clone.md

#### clone

Returns new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/equals.md

#### equals

Compares this underline annotation with another underline annotation.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `UnderlineAnnotation` | The UnderlineAnnotation object to compare with the current object. |

**Returns:** bool: True if the annotations are equal; otherwise False.

#### equals

Compares underline annotation using the standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_underline_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/equals_underline_annotation.md

#### equals_underline_annotation

```python
def equals_underline_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/font_color.md

#### font_color property

The text color of the underline annotation.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/get_hash_code.md

#### get_hash_code

Returns HashCode of the underline annotation.

```python
def get_hash_code(self):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/opacity.md

#### opacity property

The underline annotation opacity.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### points property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/points.md

#### points property

The collection of points that describe rectangles with text.

##### Definition:
```python
@property
def points(self):
    ...
@points.setter
def points(self, value):
    ...
```

### underline_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/underlineannotation/underline_color.md

#### underline_color property

The underline annotation color as an ARGB integer.

##### Definition:
```python
@property
def underline_color(self):
    ...
@underline_color.setter
def underline_color(self, value):
    ...
```

### WatermarkAnnotation class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation.md

#### WatermarkAnnotation class

Represents watermark annotation properties.

- More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
- More about adding watermark annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+watermark+annotation

The WatermarkAnnotation type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes new instance of WatermarkAnnotation class. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |
| equals | Compares watermark annotation using IEquatable Equals method. |
| equals | Compares watermark annotation using the standard object Equals method. |
| equals_object |  |
| equals_watermark_annotation |  |
| get_hash_code | Returns the hash code of the watermark annotation. |
| equals_annotation_base |  (inherited from `AnnotationBase`) |

##### Properties
| Property | Description |
| :- | :- |
| angle | The rotation angle of the watermark annotation. |
| auto_scale | The auto scale setting for the watermark annotation. |
| box | The watermark annotation position. |
| font_color | The watermark annotation text color. |
| font_family | The font family of the watermark annotation text. |
| font_size | The watermark annotation text size. |
| horizontal_alignment | The watermark horizontal alignment on the document. |
| opacity | The opacity of the watermark annotation. |
| text | The watermark text. |
| vertical_alignment | The vertical alignment of the watermark on the document. |
| created_on | The annotation creation date. (inherited from `AnnotationBase`) |
| id | The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`) |
| message | The annotation message. (inherited from `AnnotationBase`) |
| page_number | The page number where the annotation should be located. (inherited from `AnnotationBase`) |
| replies | The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`) |
| state_before_annotation | The previous state of the text before annotating. (inherited from `AnnotationBase`) |
| type | The annotation type. (inherited from `AnnotationBase`) |
| user | The annotation author. (inherited from `AnnotationBase`) |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, HorizontalAlignment, VerticalAlignment
from groupdocs.annotation.models.annotation_models import WatermarkAnnotation
from groupdocs.pydrawing import Color

def add_watermark_annotation():
    with Annotator("./sample.pdf") as annotator:
        watermark = WatermarkAnnotation()
        watermark.box = Rectangle(100, 100, 200, 100)
        watermark.text = "Watermark"
        watermark.font_family = "Arial"
        watermark.font_size = 24.0
        watermark.font_color = Color.red.to_argb()
        watermark.angle = 45.0
        watermark.auto_scale = True
        watermark.horizontal_alignment = HorizontalAlignment.CENTER
        watermark.vertical_alignment = VerticalAlignment.CENTER
        watermark.opacity = 0.5
        watermark.page_number = 0
        watermark.message = "This is a watermark annotation"
        annotator.add(watermark)
        annotator.save("./output.pdf")
```

##### Guides
Task guides that use `WatermarkAnnotation`:

* AI agents and LLM integration
* Add annotations

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/__init__.md

#### __init__

Initializes new instance of WatermarkAnnotation class.

```python
def __init__(self):
    ...
```

### angle property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/angle.md

#### angle property

The rotation angle of the watermark annotation.

##### Definition:
```python
@property
def angle(self):
    ...
@angle.setter
def angle(self, value):
    ...
```

### auto_scale property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/auto_scale.md

#### auto_scale property

The auto scale setting for the watermark annotation.

##### Definition:
```python
@property
def auto_scale(self):
    ...
@auto_scale.setter
def auto_scale(self, value):
    ...
```

### box property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/box.md

#### box property

The watermark annotation position.

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/equals.md

#### equals

Compares watermark annotation using IEquatable Equals method.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `WatermarkAnnotation` | The WatermarkAnnotation object to compare with the current object. |

#### equals

Compares watermark annotation using the standard object Equals method.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current object. |

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_watermark_annotation method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/equals_watermark_annotation.md

#### equals_watermark_annotation

```python
def equals_watermark_annotation(self):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/font_color.md

#### font_color property

The watermark annotation text color.

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### font_family property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/font_family.md

#### font_family property

The font family of the watermark annotation text.

##### Definition:
```python
@property
def font_family(self):
    ...
@font_family.setter
def font_family(self, value):
    ...
```

### font_size property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/font_size.md

#### font_size property

The watermark annotation text size.

##### Definition:
```python
@property
def font_size(self):
    ...
@font_size.setter
def font_size(self, value):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/get_hash_code.md

#### get_hash_code

Returns the hash code of the watermark annotation.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: The hash code.

### horizontal_alignment property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/horizontal_alignment.md

#### horizontal_alignment property

The watermark horizontal alignment on the document.

##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
@horizontal_alignment.setter
def horizontal_alignment(self, value):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/opacity.md

#### opacity property

The opacity of the watermark annotation.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/text.md

#### text property

The watermark text.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.annotation_models/watermarkannotation/vertical_alignment.md

#### vertical_alignment property

The vertical alignment of the watermark on the document.

##### Definition:
```python
@property
def vertical_alignment(self):
    ...
@vertical_alignment.setter
def vertical_alignment(self, value):
    ...
```

### groupdocs.annotation.models
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models.md

Types under `groupdocs.annotation.models`.

##### Classes
| Class | Description |
| :- | :- |
| `PageInfo` | Class that defines Document Page Information. |
| `Point` | Point structure. |
| `Rectangle` | Rectangle structure. |
| `Reply` | Represents an annotation comment. |
| `TextLineInfo` | Class that defines text line information. |
| `User` | Class that represents a user. |
| `VersionsList` | Class that defines a serializable list of the document version information. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `BorderStyle` |  |
| `BoxStyle` |  |
| `DocumentType` |  |
| `HorizontalAlignment` |  |
| `PenStyle` |  |
| `ResolutionQuality` |  |
| `Role` |  |
| `RotationDocument` |  |
| `VerticalAlignment` |  |

### BorderStyle class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/borderstyle.md

#### BorderStyle class

The BorderStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SOLID | Solid border |
| DASHED | Dashed border |
| BEVELED | Beveled border |
| INSET | Inset border |
| UNDERLINE | Underline border |

##### Guides
Task guides that use `BorderStyle`:

* AI agents and LLM integration

### BEVELED field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/borderstyle/beveled.md

#### BEVELED field

Beveled border

##### Value
`2`

### DASHED field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/borderstyle/dashed.md

#### DASHED field

Dashed border

##### Value
`1`

### INSET field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/borderstyle/inset.md

#### INSET field

Inset border

##### Value
`3`

### SOLID field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/borderstyle/solid.md

#### SOLID field

Solid border

##### Value
`0`

### UNDERLINE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/borderstyle/underline.md

#### UNDERLINE field

Underline border

##### Value
`4`

### BoxStyle class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle.md

#### BoxStyle class

The BoxStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CIRCLE | Circle style |
| CHECK | Check style |
| CROSS | Cross style |
| DIAMOND | Diamond style |
| SQUARE | Square style |
| STAR | Star style |

##### Guides
Task guides that use `BoxStyle`:

* AI agents and LLM integration

### CHECK field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle/check.md

#### CHECK field

Check style

##### Value
`1`

### CIRCLE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle/circle.md

#### CIRCLE field

Circle style

##### Value
`0`

### CROSS field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle/cross.md

#### CROSS field

Cross style

##### Value
`2`

### DIAMOND field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle/diamond.md

#### DIAMOND field

Diamond style

##### Value
`3`

### SQUARE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle/square.md

#### SQUARE field

Square style

##### Value
`4`

### STAR field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/boxstyle/star.md

#### STAR field

Star style

##### Value
`5`

### DocumentType class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype.md

#### DocumentType class

The DocumentType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PDF | Pdf documen type |
| CELLS | Excel document type |
| SLIDES | PowerPoint document type |
| WORDS | Word document type |
| IMAGES | Image document type |
| EMAIL | Email document type |
| HTML | HTML document type |
| DIAGRAM | Visio document type |
| UNDEFINED | The undefined |

### CELLS field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/cells.md

#### CELLS field

Excel document type

##### Value
`1`

### DIAGRAM field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/diagram.md

#### DIAGRAM field

Visio document type

##### Value
`7`

### EMAIL field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/email.md

#### EMAIL field

Email document type

##### Value
`5`

### HTML field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/html.md

#### HTML field

HTML document type

##### Value
`6`

### IMAGES field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/images.md

#### IMAGES field

Image document type

##### Value
`4`

### PDF field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/pdf.md

#### PDF field

Pdf documen type

##### Value
`0`

### SLIDES field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/slides.md

#### SLIDES field

PowerPoint document type

##### Value
`2`

### UNDEFINED field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/undefined.md

#### UNDEFINED field

The undefined

##### Value
`-1`

### WORDS field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/documenttype/words.md

#### WORDS field

Word document type

##### Value
`3`

### HorizontalAlignment class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/horizontalalignment.md

#### HorizontalAlignment class

The HorizontalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Default value, aligned wont be used |
| LEFT | Target will be aligned to left side |
| CENTER | Target will be aligned to center |
| RIGHT | Target will be aligned to right side |

##### Guides
Task guides that use `HorizontalAlignment`:

* AI agents and LLM integration
* Add annotations

### CENTER field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/horizontalalignment/center.md

#### CENTER field

Target will be aligned to center

##### Value
`2`

### LEFT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/horizontalalignment/left.md

#### LEFT field

Target will be aligned to left side

##### Value
`1`

### NONE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/horizontalalignment/none.md

#### NONE field

Default value, aligned wont be used

##### Value
`0`

### RIGHT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/horizontalalignment/right.md

#### RIGHT field

Target will be aligned to right side

##### Value
`3`

### PageInfo class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/pageinfo.md

#### PageInfo class

Class that defines Document Page Information.

The PageInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `PageInfo`. |

##### Properties
| Property | Description |
| :- | :- |
| height | The page height. |
| page_number | The page number. |
| text_lines | The collection of text lines information. |
| width | The page width. |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/pageinfo/__init__.md

#### __init__

Initializes a new instance of `PageInfo`.

```python
def __init__(self, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| width | `int` | Page Width. |
| height | `int` | Page Height. |

### height property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/pageinfo/height.md

#### height property

The page height.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/pageinfo/page_number.md

#### page_number property

The page number.

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### text_lines property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/pageinfo/text_lines.md

#### text_lines property

The collection of text lines information.

##### Definition:
```python
@property
def text_lines(self):
    ...
@text_lines.setter
def text_lines(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/pageinfo/width.md

#### width property

The page width.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PenStyle class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle.md

#### PenStyle class

The PenStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SOLID | Specifies a solid line |
| DASH | Specifies a dashed line |
| DASH_DOT | Specifies a line consisting of dashes and dots |
| DOT | Specifies a dotted line |
| LONG_DASH | Specifies a line consisting of long dashes |
| DASH_DOT_DOT | Specifies a line consisting of dashes and two dots |

##### Guides
Task guides that use `PenStyle`:

* Add annotations

### DASH field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle/dash.md

#### DASH field

Specifies a dashed line

##### Value
`1`

### DASH_DOT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle/dash_dot.md

#### DASH_DOT field

Specifies a line consisting of dashes and dots

##### Value
`2`

### DASH_DOT_DOT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle/dash_dot_dot.md

#### DASH_DOT_DOT field

Specifies a line consisting of dashes and two dots

##### Value
`5`

### DOT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle/dot.md

#### DOT field

Specifies a dotted line

##### Value
`3`

### LONG_DASH field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle/long_dash.md

#### LONG_DASH field

Specifies a line consisting of long dashes

##### Value
`4`

### SOLID field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/penstyle/solid.md

#### SOLID field

Specifies a solid line

##### Value
`0`

### Point class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point.md

#### Point class

Point structure.

The Point type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new Point with the specified coordinates. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified point is equal to the current point. |
| equals_object |  |
| get_hash_code | Serves as the default hash function. |

##### Properties
| Property | Description |
| :- | :- |
| x | The X coordinate value. |
| y | The Y coordinate value. |

##### Guides
Task guides that use `Point`:

* AI agents and LLM integration
* Add annotations
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point/__init__.md

#### __init__

Initializes a new Point with the specified coordinates.

```python
def __init__(self, x, y):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| x | `float` | The x coordinate. |
| y | `float` | The y coordinate. |

##### Example

```python
from groupdocs.annotation.models import Point

p = Point(80.0, 600.0)
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point/equals.md

#### equals

Determines whether the specified point is equal to the current point.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The point to compare with the current point. |

**Returns:** bool: True if the specified point is equal to the current point; otherwise, False.

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point/get_hash_code.md

#### get_hash_code

Serves as the default hash function.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: A hash code for the current point.

### x property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point/x.md

#### x property

The X coordinate value.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/point/y.md

#### y property

The Y coordinate value.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### Rectangle class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle.md

#### Rectangle class

Rectangle structure.

The Rectangle type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new Rectangle. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified rectangle is equal to the current rectangle. |
| equals_object |  |
| get_hash_code | Serves as the default hash function. |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the rectangle. |
| width | The width of the rectangle. |
| x | The X coordinate of the rectangle. |
| y | The Y coordinate of the rectangle. |

##### Guides
Task guides that use `Rectangle`:

* AI agents and LLM integration
* Loading documents
* Saving documents
* Add annotations
* Comments and replies
* Hello, World!
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/__init__.md

#### __init__

Initializes a new Rectangle.

```python
def __init__(self, x, y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| x | `float` | The x coordinate (top left corner of the rectangle). |
| y | `float` | The y coordinate (top left corner of the rectangle). |
| width | `float` | The width of the rectangle. |
| height | `float` | The height of the rectangle. |

##### Example

```python
from groupdocs.annotation.models import Rectangle

# Create a rectangle at position (100, 100) with width 200 and height 80
rect = Rectangle(100, 100, 200, 80)
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/equals.md

#### equals

Determines whether the specified rectangle is equal to the current rectangle.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The rectangle to compare with the current rectangle. |

**Returns:** bool: True if the specified rectangle is equal to the current rectangle; otherwise, False.

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/get_hash_code.md

#### get_hash_code

Serves as the default hash function.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: A hash code for the current rectangle.

### height property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/height.md

#### height property

The height of the rectangle.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/width.md

#### width property

The width of the rectangle.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/x.md

#### x property

The X coordinate of the rectangle.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rectangle/y.md

#### y property

The Y coordinate of the rectangle.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### Reply class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply.md

#### Reply class

Represents an annotation comment.

The Reply type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| clone | Returns a new instance with the same values. |

##### Properties
| Property | Description |
| :- | :- |
| comment | The comment text content. |
| id | The comment identifier. |
| parent_reply | The parent comment (in case current one is a reply to the original one). |
| replied_on | The comment creation date and time. |
| user | The comment author. |

##### Example

```python
from groupdocs.annotation.models import Reply

# Create a reply and set its comment
reply = Reply()
reply.comment = "Please double-check this"
```

##### Guides
Task guides that use `Reply`:

* AI agents and LLM integration
* Comments and replies
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/clone.md

#### clone

Returns a new instance with the same values.

```python
def clone(self):
    ...
```

### comment property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/comment.md

#### comment property

The comment text content.

##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/id.md

#### id property

The comment identifier.

##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### parent_reply property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/parent_reply.md

#### parent_reply property

The parent comment (in case current one is a reply to the original one).

##### Definition:
```python
@property
def parent_reply(self):
    ...
@parent_reply.setter
def parent_reply(self, value):
    ...
```

### replied_on property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/replied_on.md

#### replied_on property

The comment creation date and time.

##### Definition:
```python
@property
def replied_on(self):
    ...
@replied_on.setter
def replied_on(self, value):
    ...
```

### user property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/user.md

#### user property

The comment author.

##### Definition:
```python
@property
def user(self):
    ...
@user.setter
def user(self, value):
    ...
```

### ResolutionQuality class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/resolutionquality.md

#### ResolutionQuality class

The ResolutionQuality type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Default quality |
| LOW | Allows to create documents of small size with a low image quality |
| MEDIUM | Allows to create documents of medium size with a good image quality |
| HIGH | Allows to create documents of big size with a high image quality |

### HIGH field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/resolutionquality/high.md

#### HIGH field

Allows to create documents of big size with a high image quality

##### Value
`3`

### LOW field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/resolutionquality/low.md

#### LOW field

Allows to create documents of small size with a low image quality

##### Value
`1`

### MEDIUM field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/resolutionquality/medium.md

#### MEDIUM field

Allows to create documents of medium size with a good image quality

##### Value
`2`

### NONE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/resolutionquality/none.md

#### NONE field

Default quality

##### Value
`0`

### Role class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/role.md

#### Role class

The Role type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| VIEWER | Viewer can only view comments |
| EDITOR | Editor can view and edit comments |

##### Guides
Task guides that use `Role`:

* AI agents and LLM integration
* Comments and replies

### EDITOR field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/role/editor.md

#### EDITOR field

Editor can view and edit comments

##### Value
`1`

### VIEWER field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/role/viewer.md

#### VIEWER field

Viewer can only view comments

##### Value
`0`

### RotationDocument class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rotationdocument.md

#### RotationDocument class

The RotationDocument type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Default one. Document is not rotated. |
| ON90 | Rotate the document 90 degrees |
| ON180 | Rotate the document 180 degrees |
| ON270 | Rotate the document 270 degrees |

##### Guides
Task guides that use `RotationDocument`:

* AI agents and LLM integration

### NONE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rotationdocument/none.md

#### NONE field

Default one. Document is not rotated.

##### Value
`0`

### ON180 field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rotationdocument/on180.md

#### ON180 field

Rotate the document 180 degrees

##### Value
`2`

### ON270 field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rotationdocument/on270.md

#### ON270 field

Rotate the document 270 degrees

##### Value
`3`

### ON90 field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/rotationdocument/on90.md

#### ON90 field

Rotate the document 90 degrees

##### Value
`1`

### TextLineInfo class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/textlineinfo.md

#### TextLineInfo class

Class that defines text line information.

The TextLineInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The line height. |
| left_indent | The left indent from left. |
| text | The line text content. |
| top_indent | The indent from top. |
| width | The line width. |

### height property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/textlineinfo/height.md

#### height property

The line height.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### left_indent property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/textlineinfo/left_indent.md

#### left_indent property

The left indent from left.

##### Definition:
```python
@property
def left_indent(self):
    ...
@left_indent.setter
def left_indent(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/textlineinfo/text.md

#### text property

The line text content.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### top_indent property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/textlineinfo/top_indent.md

#### top_indent property

The indent from top.

##### Definition:
```python
@property
def top_indent(self):
    ...
@top_indent.setter
def top_indent(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/textlineinfo/width.md

#### width property

The line width.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### User class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user.md

#### User class

Class that represents a user.

The User type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `User` class. |
| __init__ | Initializes a new instance of `User`. |

##### Properties
| Property | Description |
| :- | :- |
| email | The user email address. |
| id | The User identifier. |
| name | The user name. |
| role | The role of the user. |

##### Example

```python
from groupdocs.annotation.models import User, Role

user = User(name="Tom", role=Role.EDITOR)
```

##### Guides
Task guides that use `User`:

* AI agents and LLM integration
* Comments and replies

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user/__init__.md

#### __init__

Initializes a new instance of `User` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of `User`.

```python
def __init__(self, id, name, role):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | `int` | The user id. |
| name | `str` | The user name. |
| role | `Role` | The user role. |

##### Example

```python
from groupdocs.annotation.models import User, Role

# Create a user with a name and role
user = User(name="Tom", role=Role.EDITOR)

# Create a user with an explicit id
user_with_id = User(id=123, name="Jack", role=Role.VIEWER)
```

### email property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user/email.md

#### email property

The user email address.

##### Definition:
```python
@property
def email(self):
    ...
@email.setter
def email(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user/id.md

#### id property

The User identifier.

##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user/name.md

#### name property

The user name.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### role property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user/role.md

#### role property

The role of the user.

##### Definition:
```python
@property
def role(self):
    ...
@role.setter
def role(self, value):
    ...
```

### VersionsList class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist.md

#### VersionsList class

Class that defines a serializable list of the document version information.

The VersionsList type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of VersionsList. |

##### Methods
| Method | Description |
| :- | :- |
| add_version | Add list of the annotations. |
| add_version | Adds a list of annotations for a version key. |
| add_version_list |  |
| add_version_object |  |
| get_last_version_key | Gets the last version key. |
| get_penultimate_version_key | Retrieves the penultimate version key. |
| get_version | . |
| get_version | . |
| get_version_key_by_value | . |
| get_version_key_by_value_list |  |
| get_version_object |  |
| replace_last_version | . |
| replace_last_version_list |  |

##### Properties
| Property | Description |
| :- | :- |
| version | The current version. |
| versions_dictionary | The versions dictionary. |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/__init__.md

#### __init__

Initializes a new instance of VersionsList.

```python
def __init__(self):
    ...
```

### add_version method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/add_version.md

#### add_version

Add list of the annotations.

```python
def add_version(self, annotations):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotations | `List[AnnotationBase]` | List of the annotations to add. |

#### add_version

Adds a list of annotations for a version key.

```python
def add_version(self, new_version_key, annotations):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| new_version_key | `Any` | Key of the version. |
| annotations | `List[AnnotationBase]` | List of the annotations. |

| Raises | Description |
| :- | :- |
| `Exception` | If the version key already exists. |

### add_version_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/add_version_list.md

#### add_version_list

```python
def add_version_list(self):
    ...
```

### add_version_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/add_version_object.md

#### add_version_object

```python
def add_version_object(self):
    ...
```

### get_last_version_key method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/get_last_version_key.md

#### get_last_version_key

Gets the last version key.

```python
def get_last_version_key(self):
    ...
```

### get_penultimate_version_key method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/get_penultimate_version_key.md

#### get_penultimate_version_key

Retrieves the penultimate version key.

```python
def get_penultimate_version_key(self):
    ...
```

### get_version method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/get_version.md

#### get_version

.

```python
def get_version(self, version_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| version_key | `Any` |  |

#### get_version

.

```python
def get_version(self):
    ...
```

### get_version_key_by_value method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/get_version_key_by_value.md

#### get_version_key_by_value

.

```python
def get_version_key_by_value(self, annotations):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotations | `List[AnnotationBase]` |  |

### get_version_key_by_value_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/get_version_key_by_value_list.md

#### get_version_key_by_value_list

```python
def get_version_key_by_value_list(self):
    ...
```

### get_version_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/get_version_object.md

#### get_version_object

```python
def get_version_object(self):
    ...
```

### replace_last_version method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/replace_last_version.md

#### replace_last_version

.

```python
def replace_last_version(self, annotations):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotations | `List[AnnotationBase]` |  |

### replace_last_version_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/replace_last_version_list.md

#### replace_last_version_list

```python
def replace_last_version_list(self):
    ...
```

### version property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/version.md

#### version property

The current version.

##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### versions_dictionary property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/versionslist/versions_dictionary.md

#### versions_dictionary property

The versions dictionary.

##### Definition:
```python
@property
def versions_dictionary(self):
    ...
@versions_dictionary.setter
def versions_dictionary(self, value):
    ...
```

### VerticalAlignment class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/verticalalignment.md

#### VerticalAlignment class

The VerticalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Default value, aligned wont be used |
| TOP | Target will be aligned to top side |
| CENTER | Target will be aligned to center |
| BOTTOM | Target will be aligned to bottom side |

##### Guides
Task guides that use `VerticalAlignment`:

* AI agents and LLM integration
* Add annotations

### BOTTOM field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/verticalalignment/bottom.md

#### BOTTOM field

Target will be aligned to bottom side

##### Value
`3`

### CENTER field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/verticalalignment/center.md

#### CENTER field

Target will be aligned to center

##### Value
`2`

### NONE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/verticalalignment/none.md

#### NONE field

Default value, aligned wont be used

##### Value
`0`

### TOP field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/verticalalignment/top.md

#### TOP field

Target will be aligned to top side

##### Value
`1`

### groupdocs.annotation.options
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `CreatePageStream` | Delegate that defines method to create output page preview stream. |
| `LoadOptions` | Allows to specify additional options (such as password) when opening a document to annotate. |
| `PreviewOptions` | The class represents document preview options. |
| `ReleasePageStream` | Delegate that defines method to release output page preview stream. |
| `SaveOptions` | Allows to specify additional options (such as password) when saving an annotated document. |
| `WorksheetColumnsRange` | Represents a range of columns for a specified worksheet. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `AnnotationType` |  |
| `PreviewFormats` |  |

### AnnotationType class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype.md

#### AnnotationType class

The AnnotationType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Default value |
| AREA | The area annotation type that highlights rectangular area within the document page |
| ARROW | The annotation type that draws an arrow on the document page |
| DISTANCE | The annotation type that measures distance between elements of a document page |
| ELLIPSE | The annotation of elliptic form that marks parts of document content |
| LINK | The annotation type that represents a hyperlink to a remote resource |
| POINT | The point annotation type that sticks a comment to an any place within document page |
| POLYLINE | The polyline annotation type that allows add drawing shapes and freehand lines to a document page |
| RESOURCES_REDACTION | The annotation type that hides textual content behind black rectangle |
| TEXT_FIELD | The text field annotation type represents textual comment inside colored frame |
| TEXT_HIGHLIGHT | The annotation type that highlights and comments selected text |
| TEXT_REDACTION | The annotation type that fills part of selected text with black rectangle. |
| TEXT_REPLACEMENT | The annotation type that replaces original text with other provided text fragment |
| TEXT_STRIKEOUT | The annotation type that marks text fragment with a strikethrough styling |
| TEXT_SQUIGGLY | The annotation type that squiggly and comments selected text |
| SEARCH_TEXT | The annotation type that search fragment text in document |
| TEXT_UNDERLINE | The annotation type that marks text with a underline styling |
| WATERMARK | The annotation type that adds textual watermark over document page |
| IMAGE | The annotation type that adds image overlay over document page content |
| DROPDOWN | The component type that adds dropdown component for pdf document only |
| CHECKBOX | The annotation type that adds checkbox for pdf document |
| BUTTON | The annotation type that adds button for pdf document |
| ALL | All |

##### Guides
Task guides that use `AnnotationType`:

* AI agents and LLM integration
* Saving documents
* GroupDocs.Annotation for Python via .NET Overview

### ALL field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/all.md

#### ALL field

All

##### Value
`2147483647`

### AREA field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/area.md

#### AREA field

The area annotation type that highlights rectangular area within the document page

##### Value
`2`

### ARROW field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/arrow.md

#### ARROW field

The annotation type that draws an arrow on the document page

##### Value
`4`

### BUTTON field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/button.md

#### BUTTON field

The annotation type that adds button for pdf document

##### Value
`139264`

### CHECKBOX field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/checkbox.md

#### CHECKBOX field

The annotation type that adds checkbox for pdf document

##### Value
`135168`

### DISTANCE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/distance.md

#### DISTANCE field

The annotation type that measures distance between elements of a document page

##### Value
`8`

### DROPDOWN field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/dropdown.md

#### DROPDOWN field

The component type that adds dropdown component for pdf document only

##### Value
`131072`

### ELLIPSE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/ellipse.md

#### ELLIPSE field

The annotation of elliptic form that marks parts of document content

##### Value
`16`

### IMAGE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/image.md

#### IMAGE field

The annotation type that adds image overlay over document page content

##### Value
`65536`

### LINK field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/link.md

#### LINK field

The annotation type that represents a hyperlink to a remote resource

##### Value
`32`

### NONE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/none.md

#### NONE field

Default value

##### Value
`0`

### POINT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/point.md

#### POINT field

The point annotation type that sticks a comment to an any place within document page

##### Value
`64`

### POLYLINE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/polyline.md

#### POLYLINE field

The polyline annotation type that allows add drawing shapes and freehand lines to a document page

##### Value
`128`

### RESOURCES_REDACTION field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/resources_redaction.md

#### RESOURCES_REDACTION field

The annotation type that hides textual content behind black rectangle

##### Value
`256`

### SEARCH_TEXT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/search_text.md

#### SEARCH_TEXT field

The annotation type that search fragment text in document

##### Value
`9984`

### TEXT_FIELD field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_field.md

#### TEXT_FIELD field

The text field annotation type represents textual comment inside colored frame

##### Value
`512`

### TEXT_HIGHLIGHT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_highlight.md

#### TEXT_HIGHLIGHT field

The annotation type that highlights and comments selected text

##### Value
`1024`

### TEXT_REDACTION field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_redaction.md

#### TEXT_REDACTION field

The annotation type that fills part of selected text with black rectangle.

##### Value
`2048`

### TEXT_REPLACEMENT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_replacement.md

#### TEXT_REPLACEMENT field

The annotation type that replaces original text with other provided text fragment

##### Value
`4096`

### TEXT_SQUIGGLY field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_squiggly.md

#### TEXT_SQUIGGLY field

The annotation type that squiggly and comments selected text

##### Value
`9472`

### TEXT_STRIKEOUT field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_strikeout.md

#### TEXT_STRIKEOUT field

The annotation type that marks text fragment with a strikethrough styling

##### Value
`8192`

### TEXT_UNDERLINE field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/text_underline.md

#### TEXT_UNDERLINE field

The annotation type that marks text with a underline styling

##### Value
`16384`

### WATERMARK field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/watermark.md

#### WATERMARK field

The annotation type that adds textual watermark over document page

##### Value
`32768`

### CreatePageStream class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream.md

#### CreatePageStream class

Delegate that defines method to create output page preview stream.

The CreatePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/__init__.md

#### __init__

```python
def __init__(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `System.IntPtr` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self, page_number, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| callback | `System.AsyncCallback` |  |
| object | `Any` |  |

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `System.IAsyncResult` |  |

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/invoke.md

#### invoke

```python
def invoke(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

### invoke_int32 method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/createpagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/loadoptions.md

#### LoadOptions class

Allows to specify additional options (such as password) when opening a document to annotate.

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Properties
| Property | Description |
| :- | :- |
| font_directories | The list of font directories to load custom fonts from. |
| password | The document password. |
| version | The version of the document to load. Default is the latest version. |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import LoadOptions
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color


def load_password_protected_document():
    # Provide the password through LoadOptions
    load_options = LoadOptions()
    load_options.password = "secret"

    with Annotator("./protected.docx", load_options=load_options) as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Annotated a password-protected document"
        annotator.add(area)
        annotator.save("./output.docx")
```

##### Guides
Task guides that use `LoadOptions`:

* AI agents and LLM integration
* Loading documents

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/loadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### font_directories property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/loadoptions/font_directories.md

#### font_directories property

The list of font directories to load custom fonts from.

##### Definition:
```python
@property
def font_directories(self):
    ...
@font_directories.setter
def font_directories(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/loadoptions/password.md

#### password property

The document password.

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### version property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/loadoptions/version.md

#### version property

The version of the document to load. Default is the latest version.

##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### PreviewFormats class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewformats.md

#### PreviewFormats class

The PreviewFormats type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PNG | Png (by default), can be take a lot of disc space / traffic if page contains a lot of color graphics |
| JPEG | Jpeg - faster processing, small disc space using / traffic, but can be worst quality |
| BMP | BMP - slow processing, high disc space usage / traffic, but best quality |

##### Guides
Task guides that use `PreviewFormats`:

* Generate document preview

### BMP field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewformats/bmp.md

#### BMP field

BMP - slow processing, high disc space usage / traffic, but best quality

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewformats/jpeg.md

#### JPEG field

Jpeg - faster processing, small disc space using / traffic, but can be worst quality

##### Value
`1`

### PNG field
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewformats/png.md

#### PNG field

Png (by default), can be take a lot of disc space / traffic if page contains a lot of color graphics

##### Value
`0`

### PreviewOptions class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions.md

#### PreviewOptions class

The class represents document preview options.

The PreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `PreviewOptions` class. |
| __init__ | Initializes a new PreviewOptions instance. |

##### Properties
| Property | Description |
| :- | :- |
| create_page_stream | The delegate that defines a method to create an output page preview stream. |
| height | The page preview height. |
| page_numbers | The page numbers that will be previewed. |
| preview_format | The preview image format. |
| release_page_stream | The delegate which defines method to remove output page preview stream. |
| render_annotations | The property that controls whether annotations will be generated on the preview (default is True). |
| render_comments | The property that controls whether comments will be generated on the preview; default is True and it is supported only in MS Word documents. |
| resolution | The resolution for generated images, in dots per inch. |
| width | The page preview width. |
| worksheet_columns | The worksheet columns to generate. Generation proceeds in the specified order. |

##### Example

```python
import os
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import PreviewOptions, PreviewFormats

def generate_document_preview():
    output_dir = "./preview"
    os.makedirs(output_dir, exist_ok=True)

    open_streams = {}

    def create_page_stream(page_number):
        stream = open(os.path.join(output_dir, f"page_{page_number}.png"), "wb")
        open_streams[page_number] = stream
        return stream

    def release_page_stream(page_number, page_stream):
        stream = open_streams.pop(page_number, None)
        if stream:
            stream.close()

    with Annotator("./sample.pdf") as annotator:
        preview_options = PreviewOptions(create_page_stream, release_page_stream)
        preview_options.preview_format = PreviewFormats.PNG
        preview_options.page_numbers = [1]
        annotator.document.generate_preview(preview_options)

    print(f"Generated page preview image(s) in {output_dir}.")
```

##### Guides
Task guides that use `PreviewOptions`:

* Generate document preview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/__init__.md

#### __init__

Initializes a new instance of `PreviewOptions` class.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Callable that defines method to create output page preview stream. |

##### Example

```python
import os
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import PreviewOptions, PreviewFormats

def generate_document_preview():
    output_dir = "./preview"
    os.makedirs(output_dir, exist_ok=True)

    open_streams = {}

    def create_page_stream(page_number):
        stream = open(os.path.join(output_dir, f"page_{page_number}.png"), "wb")
        open_streams[page_number] = stream
        return stream

    def release_page_stream(page_number, page_stream):
        stream = open_streams.pop(page_number, None)
        if stream:
            stream.close()

    with Annotator("./sample.pdf") as annotator:
        preview_options = PreviewOptions(create_page_stream, release_page_stream)
        preview_options.preview_format = PreviewFormats.PNG
        preview_options.page_numbers = [1]
        annotator.document.generate_preview(preview_options)

    print(f"Generated page preview image(s) in {output_dir}.")
```

#### __init__

Initializes a new PreviewOptions instance.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Delegate which defines method to create output page preview stream. |
| release_page_stream | `ReleasePageStream` | Delegate which defines method to release output page preview stream. |

##### Example

```python
import os
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import PreviewOptions, PreviewFormats

def generate_document_preview():
    output_dir = "./preview"
    os.makedirs(output_dir, exist_ok=True)

    open_streams = {}

    def create_page_stream(page_number):
        stream = open(os.path.join(output_dir, f"page_{page_number}.png"), "wb")
        open_streams[page_number] = stream
        return stream

    def release_page_stream(page_number, page_stream):
        stream = open_streams.pop(page_number, None)
        if stream:
            stream.close()

    with Annotator("./sample.pdf") as annotator:
        preview_options = PreviewOptions(create_page_stream, release_page_stream)
        preview_options.preview_format = PreviewFormats.PNG
        preview_options.page_numbers = [1]
        annotator.document.generate_preview(preview_options)

    print(f"Generated page preview image(s) in {output_dir}.")
```

### create_page_stream property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/create_page_stream.md

#### create_page_stream property

The delegate that defines a method to create an output page preview stream.

The callable should accept a page number (`int`) and return a writable stream (`io.RawIOBase`).

##### Definition:
```python
@property
def create_page_stream(self):
    ...
@create_page_stream.setter
def create_page_stream(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/height.md

#### height property

The page preview height.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/page_numbers.md

#### page_numbers property

The page numbers that will be previewed.

##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### preview_format property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/preview_format.md

#### preview_format property

The preview image format.

##### Definition:
```python
@property
def preview_format(self):
    ...
@preview_format.setter
def preview_format(self, value):
    ...
```

### release_page_stream property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/release_page_stream.md

#### release_page_stream property

The delegate which defines method to remove output page preview stream.

##### Definition:
```python
@property
def release_page_stream(self):
    ...
@release_page_stream.setter
def release_page_stream(self, value):
    ...
```

### render_annotations property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/render_annotations.md

#### render_annotations property

The property that controls whether annotations will be generated on the preview (default is True).

##### Definition:
```python
@property
def render_annotations(self):
    ...
@render_annotations.setter
def render_annotations(self, value):
    ...
```

### render_comments property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/render_comments.md

#### render_comments property

The property that controls whether comments will be generated on the preview; default is True and it is supported only in MS Word documents.

##### Definition:
```python
@property
def render_comments(self):
    ...
@render_comments.setter
def render_comments(self, value):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/resolution.md

#### resolution property

The resolution for generated images, in dots per inch.

The default value is 96.

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/width.md

#### width property

The page preview width.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### worksheet_columns property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/worksheet_columns.md

#### worksheet_columns property

The worksheet columns to generate. Generation proceeds in the specified order.

##### Definition:
```python
@property
def worksheet_columns(self):
    ...
@worksheet_columns.setter
def worksheet_columns(self, value):
    ...
```

### ReleasePageStream class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream.md

#### ReleasePageStream class

Delegate that defines method to release output page preview stream.

The ReleasePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| begin_invoke |  |
| begin_invoke_int32 |  |
| begin_invoke_stream |  |
| begin_invoke_streams |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |
| invoke_stream |  |
| invoke_streams |  |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/__init__.md

#### __init__

```python
def __init__(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `System.IntPtr` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self, page_number, page_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `io.RawIOBase` |  |
| callback | `System.AsyncCallback` |  |
| object | `Any` |  |

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `System.IAsyncResult` |  |

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/invoke.md

#### invoke

```python
def invoke(self, page_number, page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `io.RawIOBase` |  |

### invoke_int32 method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/releasepagestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### SaveOptions class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions.md

#### SaveOptions class

Allows to specify additional options (such as password) when saving an annotated document.

The SaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Properties
| Property | Description |
| :- | :- |
| annotation_types | The annotations that will be in the resultant document. |
| first_page | The first page number when saving a page range. |
| last_page | The last page number when saving a page range. |
| only_annotated_pages | The property indicates whether to save only annotated pages. |
| version | The version key that will be used to access the current version. |

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import SaveOptions, AnnotationType

with Annotator("document.pdf") as annotator:
    options = SaveOptions()
    options.annotation_types = AnnotationType.AREA
    options.first_page = 1
    options.last_page = 2
    annotator.save("filtered.pdf", save_options=options)
```

##### Guides
Task guides that use `SaveOptions`:

* AI agents and LLM integration
* Saving documents
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### annotation_types property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/annotation_types.md

#### annotation_types property

The annotations that will be in the resultant document.

##### Definition:
```python
@property
def annotation_types(self):
    ...
@annotation_types.setter
def annotation_types(self, value):
    ...
```

### first_page property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/first_page.md

#### first_page property

The first page number when saving a page range.

##### Definition:
```python
@property
def first_page(self):
    ...
@first_page.setter
def first_page(self, value):
    ...
```

### last_page property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/last_page.md

#### last_page property

The last page number when saving a page range.

##### Definition:
```python
@property
def last_page(self):
    ...
@last_page.setter
def last_page(self, value):
    ...
```

### only_annotated_pages property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/only_annotated_pages.md

#### only_annotated_pages property

The property indicates whether to save only annotated pages.

##### Definition:
```python
@property
def only_annotated_pages(self):
    ...
@only_annotated_pages.setter
def only_annotated_pages(self, value):
    ...
```

### version property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/version.md

#### version property

The version key that will be used to access the current version.

##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### WorksheetColumnsRange class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/worksheetcolumnsrange.md

#### WorksheetColumnsRange class

Represents a range of columns for a specified worksheet.

The WorksheetColumnsRange type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `WorksheetColumnsRange`. |
| __init__ | Initializes a new instance of `WorksheetColumnsRange` class. |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/worksheetcolumnsrange/__init__.md

#### __init__

Initializes a new instance of `WorksheetColumnsRange`.

```python
def __init__(self, worksheet_index, first_column, last_column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | `int` | Worksheet index |
| first_column | `int` | First column |
| last_column | `int` | Last column |

#### __init__

Initializes a new instance of `WorksheetColumnsRange` class.

```python
def __init__(self, worksheet_name, first_column, last_column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_name | `str` | Worksheet name. |
| first_column | `int` | First column. |
| last_column | `int` | Last column. |

### groupdocs.annotation.utility
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility.md

Types under `groupdocs.annotation.utility`.

##### Classes
| Class | Description |
| :- | :- |
| `SerializableDictionary` |  |

### SerializableDictionary class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary.md

#### SerializableDictionary class

The SerializableDictionary type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| get_object_data |  |
| get_object_data_serialization_info |  |
| get_schema |  |
| read_xml |  |
| read_xml_xml_reader |  |
| write_xml |  |
| write_xml_xml_writer |  |

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### get_object_data method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/get_object_data.md

#### get_object_data

```python
def get_object_data(self, info, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| info | `System.Runtime.Serialization.SerializationInfo` |  |
| context | `System.Runtime.Serialization.StreamingContext` |  |

### get_object_data_serialization_info method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/get_object_data_serialization_info.md

#### get_object_data_serialization_info

```python
def get_object_data_serialization_info(self):
    ...
```

### get_schema method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/get_schema.md

#### get_schema

```python
def get_schema(self):
    ...
```

### read_xml method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/read_xml.md

#### read_xml

```python
def read_xml(self, reader):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| reader | `System.Xml.XmlReader` |  |

### read_xml_xml_reader method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/read_xml_xml_reader.md

#### read_xml_xml_reader

```python
def read_xml_xml_reader(self):
    ...
```

### write_xml method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/write_xml.md

#### write_xml

```python
def write_xml(self, writer):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| writer | `System.Xml.XmlWriter` |  |

### write_xml_xml_writer method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.utility/serializabledictionary/write_xml_xml_writer.md

#### write_xml_xml_writer

```python
def write_xml_xml_writer(self):
    ...
```

### groupdocs.annotation
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.md

Main GroupDocs.Annotation namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `Annotator` | The Annotator class is the central component of the GroupDocs.Annotation API, designed to manage and facilitate the document annotation process across various formats. |
| `AnnotatorSettings` | Defines settings for customizing `Annotator` behavior. |
| `Document` | Represents various document properties. |
| `FileType` | Information about file, such as type, extension, etc. |
| `IDocumentInfo` | Interface that defines list of available document information. |
| `License` | Manages GroupDocs.Annotation licensing. |
| `Metered` | Manages metered (pay-per-use) licensing. |

##### Exceptions
| Exception | Description |
| :- | :- |
| `AnnotatorException` | An error that occur during the document annotation process. |
| `ConvertFileException` | The exception that is thrown if file conversion failed. |
| `CorruptedOrDamagedFileException` | The exception that is thrown when file is corrupted or damaged. |
| `FileTypeNotSupportedException` | The exception that is thrown when file type is not supported. |
| `GroupDocsAnnotationException` | Product-root exception for 'annotation' — every |
| `IOException` | The exception that is thrown when trying to apply format-specific annotation to the wrong file type. |
| `ImageNotLoadedException` | The exception that is thrown when image cannot be loaded from remote or local path. Usually happens if the provided "path" is incorrect. |
| `PasswordProtectedFileException` | The exception that is thrown when provided password is incorrect. |

### Annotator class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator.md

#### Annotator class

The Annotator class is the central component of the GroupDocs.Annotation API, designed to manage and facilitate the document annotation process across various formats.

Learn more

- More about GroupDocs.Annotation features: GroupDocs.Annotation Developer Guide (https://docs.groupdocs.com/display/annotationnet/Developer+Guide)

The Annotator type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes annotator class which accepts a document path. |
| __init__ | Initializes annotator class which accepts document path and options. |
| __init__ | Initializes annotator class which accepts document path and settings. |
| __init__ | Initializes annotator class which accept document path, options and settings. |
| __init__ | Initializes annotator class which accepts a document stream. |
| __init__ | Initializes annotator class which accepts a document stream and options. |
| __init__ | Initializes annotator class which accepts a document stream and settings. |
| __init__ | Initializes annotator class which accepts a document stream, load options, and settings. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds annotation to document. |
| add | Adds a collection of annotations to a document. |
| add_annotation_base |  |
| add_list |  |
| dispose | Dispose. |
| export_annotations_to_xml_file | Exports annotations from the document to an XML file. |
| export_annotations_to_xml_file_file |  |
| export_annotations_to_xml_file_string |  |
| get | Gets collections of document annotations. |
| get | Returns a collection of document annotations filtered by the specified annotation type. |
| get_annotation_type |  |
| get_version | Retrieves annotations from a specific version. |
| get_version_object |  |
| get_versions_list | Retrieves the list of versions. |
| import_annotations_from_xml_file | Export annotations from XML file. |
| import_annotations_from_xml_file_file |  |
| import_annotations_from_xml_file_string |  |
| remove | Removes an annotation from the document by its identifier. |
| remove | Removes an annotation from the document. |
| remove | Removes a collection of annotations from the document using the provided annotation IDs. |
| remove | Removes collection of annotations from document. |
| remove_annotation_base |  |
| remove_int32 |  |
| remove_list |  |
| save | Saves document after adding, updating or removing annotations. |
| save | Saves the document after adding, updating, or removing annotations. |
| save | Saves document after adding, updating or removing annotations. |
| save | Saves the document after adding, updating, or removing annotations. |
| save | Saves document after adding, updating or removing annotations. |
| save | Saves document after adding, updating or removing annotations. |
| save_file |  |
| save_save_options |  |
| save_stream |  |
| save_streams |  |
| save_string |  |
| update | Updates document annotation by id. |
| update | Updates collection of document annotations by overriding the previous list with a new one. |
| update_annotation_base |  |
| update_list |  |

##### Properties
| Property | Description |
| :- | :- |
| document | The document contains various information about the uploaded document. |
| process_pages | The count of processed pages. |
| rotation | The document rotation angle. |

##### Example

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")
```

##### Guides
Task guides that use `Annotator`:

* AI agents and LLM integration
* Generate document preview
* Loading documents
* Saving documents
* Add annotations
* Comments and replies
* Import and export annotations
* Manage annotations
* Hello, World!
* GroupDocs.Annotation for Python via .NET Overview

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/__init__.md

#### __init__

Initializes annotator class which accepts a document path.

- More about file types supported by GroupDocs.Annotation: https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats
- More about GroupDocs.Annotation for .NET features: https://docs.groupdocs.com/display/annotationnet/Developer+Guide

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | File path. |

##### Example

```python
from groupdocs.annotation import Annotator

with Annotator("./annotated.pdf") as annotator:
    # Export annotations to an XML file
    annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
```

#### __init__

Initializes annotator class which accepts document path and options.

Learn more

- More about file types supported by GroupDocs.Annotation: https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats
- More about GroupDocs.Annotation for .NET features: https://docs.groupdocs.com/display/annotationnet/Developer+Guide
- More about how to open and annotate password-protected document: https://docs.groupdocs.com/display/annotationnet/Load+password-protected+documents
- More about how to open and annotate document from URL, FTP, Amazon S3, Azure Blob Storage and others: https://docs.groupdocs.com/display/annotationnet/Loading+documents+from+different+sources

```python
def __init__(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | File path. |
| load_options | `LoadOptions` | Load options. |

##### Example

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")
```

#### __init__

Initializes annotator class which accepts document path and settings.

- More about file types supported by GroupDocs.Annotation: https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats
- More about GroupDocs.Annotation for .NET features: https://docs.groupdocs.com/display/annotationnet/Developer+Guide

```python
def __init__(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | File path. |
| settings | `AnnotatorSettings` | Annotator settings. |

##### Example

```python
from groupdocs.annotation import Annotator

with Annotator("./sample.pdf") as annotator:
    # perform annotation operations here
    annotator.save("./output.pdf")
```

#### __init__

Initializes annotator class which accept document path, options and settings.

Learn more:

- More about file types supported by GroupDocs.Annotation: Document formats supported by GroupDocs.Annotation (https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats)
- More about GroupDocs.Annotation for .NET features: Developer Guide (https://docs.groupdocs.com/display/annotationnet/Developer+Guide)
- More about how to open and annotate password-protected document: Open and annotate password-protected document (https://docs.groupdocs.com/display/annotationnet/Load+password-protected+documents)
- More about how to open and annotate document from URL, FTP, Amazon S3, Azure Blob Storage and others: Open and annotate documents from third-party storages (https://docs.groupdocs.com/display/annotationnet/Loading+documents+from+different+sources)

```python
def __init__(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | File path. |
| load_options | `LoadOptions` | Load options. |
| settings | `AnnotatorSettings` | Annotator settings. |

##### Example

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")
```

#### __init__

Initializes annotator class which accepts a document stream.

Learn more

- More about file types supported by GroupDocs.Annotation: https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats
- More about GroupDocs.Annotation for .NET features: https://docs.groupdocs.com/display/annotationnet/Developer+Guide

```python
def __init__(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | Document stream. |

##### Example

```python
import io
from groupdocs.annotation import Annotator

with Annotator("document.pdf") as annotator:
    # add annotations here, e.g., annotator.add(area)
    buf = io.BytesIO()
    annotator.save(buf)  # BytesIO is updated after save
    data = buf.getvalue()
```

#### __init__

Initializes annotator class which accepts a document stream and options.

```python
def __init__(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | Document stream. |
| load_options | `LoadOptions` | Load options. - More about file types supported by GroupDocs.Annotation: https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats - More about GroupDocs.Annotation for .NET features: https://docs.groupdocs.com/display/annotationnet/Developer+Guide - More about how to open and annotate password-protected document: https://docs.groupdocs.com/display/annotationnet/Load+password-protected+documents - More about how to open and annotate document from URL, FTP, Amazon S3, Azure Blob Storage and others: https://docs.groupdocs.com/display/annotationnet/Loading+documents+from+different+sources |

##### Example

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")
```

#### __init__

Initializes annotator class which accepts a document stream and settings.

- More about file types supported by GroupDocs.Annotation: [Document formats supported by GroupDocs.Annotation](https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats)
- More about GroupDocs.Annotation for .NET features: [Developer Guide](https://docs.groupdocs.com/display/annotationnet/Developer+Guide)

```python
def __init__(self, document, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | Document stream. |
| settings | `AnnotatorSettings` | Annotator settings. |

##### Example

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")
```

#### __init__

Initializes annotator class which accepts a document stream, load options, and settings.

Learn more.

- More about file types supported by GroupDocs.Annotation: https://docs.groupdocs.com/display/annotationnet/Supported+Document+Formats
- More about GroupDocs.Annotation for .NET features: https://docs.groupdocs.com/display/annotationnet/Developer+Guide
- More about how to open and annotate password-protected document: https://docs.groupdocs.com/display/annotationnet/Load+password-protected+documents
- More about how to open and annotate document from URL, FTP, Amazon S3, Azure Blob Storage and others: https://docs.groupdocs.com/display/annotationnet/Loading+documents+from+different+sources

```python
def __init__(self, document, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | Document stream. |
| load_options | `LoadOptions` | Load options. |
| settings | `AnnotatorSettings` | Annotator settings. |

### add method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/add.md

#### add

Adds annotation to document.

Learn more

- More about how to add annotation to document: How to annotate document in C# (https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document)

```python
def add(self, annotation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotation | `AnnotationBase` | The annotation to add. |

**Returns:** None.

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import PointAnnotation

with Annotator("./sample.pdf") as annotator:
    point = PointAnnotation()
    point.box = Rectangle(100, 100, 0, 0)
    point.page_number = 0
    point.message = "This is a point annotation"
    annotator.add(point)
    annotator.save("./output.pdf")
```

#### add

Adds a collection of annotations to a document.

Learn more

- More about how to add annotation to document: [How to annotate document in C#](https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document)

```python
def add(self, annotations):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotations | `List[AnnotationBase]` | The annotations list to add. |

**Returns:** None.

##### Example

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import PointAnnotation

def add_point_annotation():
    with Annotator("./sample.pdf") as annotator:
        point = PointAnnotation()
        point.box = Rectangle(100, 100, 0, 0)   # a point is positioned by its box origin
        point.page_number = 0
        point.message = "This is a point annotation"
        annotator.add([point])
        annotator.save("./output.pdf")
```

### add_annotation_base method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/add_annotation_base.md

#### add_annotation_base

```python
def add_annotation_base(self):
    ...
```

### add_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/add_list.md

#### add_list

```python
def add_list(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/dispose.md

#### dispose

Dispose.

```python
def dispose(self):
    ...
```

### document property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/document.md

#### document property

The document contains various information about the uploaded document.

##### Definition:
```python
@property
def document(self):
    ...
```

### export_annotations_to_xml_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/export_annotations_to_xml_file.md

#### export_annotations_to_xml_file

Exports annotations from the document to an XML file.

Learn more:

- More about how to import annotations: https://docs.groupdocs.com/display/annotationnet/Import+annotations+from+document

```python
def export_annotations_to_xml_file(self, output_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_path | `str` | The output file path (must be in .xml format). |

##### Example

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")
```

### export_annotations_to_xml_file_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/export_annotations_to_xml_file_file.md

#### export_annotations_to_xml_file_file

```python
def export_annotations_to_xml_file_file(self):
    ...
```

### export_annotations_to_xml_file_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/export_annotations_to_xml_file_string.md

#### export_annotations_to_xml_file_string

```python
def export_annotations_to_xml_file_string(self):
    ...
```

### get method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/get.md

#### get

Gets collections of document annotations.

Learn more:

- More about how to get document annotations collection: How to get document annotations in C# (https://docs.groupdocs.com/display/annotationnet/Extract+annotations+from+document)

```python
def get(self):
    ...
```

**Returns:** The list of annotations.

##### Example

```python
from groupdocs.annotation import Annotator


def get_all_annotations():
    # Open a document that already contains annotations and list them
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        print(f"Found {len(annotations)} annotation(s):")
        for annotation in annotations:
            print(f"  [{annotation.id}] {type(annotation).__name__}: {annotation.message}")


if __name__ == "__main__":
    get_all_annotations()
```

#### get

Returns a collection of document annotations filtered by the specified annotation type.

```python
def get(self, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| type | `AnnotationType` | The annotation type that must be returned. |

**Returns:** list[GroupDocs.Annotation.Annotation]: The list of annotations of the specified type.

- Learn more: More about how to get document annotations collection: https://docs.groupdocs.com/display/annotationnet/Extract+annotations+from+document

##### Example

```python
from groupdocs.annotation import Annotator


def get_all_annotations():
    # Open a document that already contains annotations and list them
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        print(f"Found {len(annotations)} annotation(s):")
        for annotation in annotations:
            print(f"  [{annotation.id}] {type(annotation).__name__}: {annotation.message}")


if __name__ == "__main__":
    get_all_annotations()
```

### get_annotation_type method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/get_annotation_type.md

#### get_annotation_type

```python
def get_annotation_type(self):
    ...
```

### get_version method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/get_version.md

#### get_version

Retrieves annotations from a specific version.

```python
def get_version(self, version):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| version | `Any` | The version's key of the version you want to return. |

**Returns:** The list of annotations from the specified version. If `None`, returns the latest version.

### get_version_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/get_version_object.md

#### get_version_object

```python
def get_version_object(self):
    ...
```

### get_versions_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/get_versions_list.md

#### get_versions_list

Retrieves the list of versions.

```python
def get_versions_list(self):
    ...
```

**Returns:** The list of versions.

### import_annotations_from_xml_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/import_annotations_from_xml_file.md

#### import_annotations_from_xml_file

Export annotations from XML file.

Learn more
- More about how to export annotations: https://docs.groupdocs.com/display/annotationnet/Export+annotations+from+document

```python
def import_annotations_from_xml_file(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The path to XML file. |

##### Example

```python
from groupdocs.annotation import Annotator

def import_annotations_from_xml():
    with Annotator("./sample.pdf") as annotator:
        annotator.import_annotations_from_xml_file(file_path="./annotations.xml")
        annotator.save("./output.pdf")

    print("Imported annotations from ./annotations.xml. Output saved to ./output.pdf.")

if __name__ == "__main__":
    import_annotations_from_xml()
```

### import_annotations_from_xml_file_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/import_annotations_from_xml_file_file.md

#### import_annotations_from_xml_file_file

```python
def import_annotations_from_xml_file_file(self):
    ...
```

### import_annotations_from_xml_file_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/import_annotations_from_xml_file_string.md

#### import_annotations_from_xml_file_string

```python
def import_annotations_from_xml_file_string(self):
    ...
```

### process_pages property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/process_pages.md

#### process_pages property

The count of processed pages.

##### Definition:
```python
@property
def process_pages(self):
    ...
@process_pages.setter
def process_pages(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/remove.md

#### remove

Removes an annotation from the document by its identifier.

- More about how to remove document annotations: https://docs.groupdocs.com/display/annotationnet/Remove+annotation+from+document

```python
def remove(self, annotation_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotation_id | `int` | The annotation's id that must be removed. |

##### Example

```python
from groupdocs.annotation import Annotator

def remove_annotation_by_id():
    # Open an annotated document and remove a single annotation by its id
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        if annotations:
            annotator.remove(annotation_id=annotations[0].id)
        annotator.save("./output.pdf")
```

#### remove

Removes an annotation from the document.

- More about how to remove document annotations: How to remove document annotations in C# (https://docs.groupdocs.com/display/annotationnet/Remove+annotation+from+document)

```python
def remove(self, annotation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotation | `AnnotationBase` | Annotation that must be removed. |

**Returns:** None.

##### Example

```python
from groupdocs.annotation import Annotator

def remove_annotation_by_object():
    # Open an annotated document and remove a single annotation by its object
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        if annotations:
            annotator.remove(annotation=annotations[0])
        annotator.save("./output.pdf")
```

#### remove

Removes a collection of annotations from the document using the provided annotation IDs.

More about how to remove document annotations:
- https://docs.groupdocs.com/display/annotationnet/Remove+annotation+from+document

```python
def remove(self, annotation_ids):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotation_ids | `List[int]` | Iterable of annotation IDs (e.g., list of str) that should be removed. |

##### Example

```python
from groupdocs.annotation import Annotator

def remove_annotation_by_id():
    # Open an annotated document and remove a single annotation by its id
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        if annotations:
            annotator.remove(annotation_id=annotations[0].id)
        annotator.save("./output.pdf")
```

#### remove

Removes collection of annotations from document.

- More about how to remove document annotations: https://docs.groupdocs.com/display/annotationnet/Remove+annotation+from+document

```python
def remove(self, annotations_to_delete):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotations_to_delete | `List[AnnotationBase]` | The annotations that must be removed. |

##### Example

```python
from groupdocs.annotation import Annotator

def remove_all_annotations():
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        if annotations:
            annotator.remove(annotations_to_delete=annotations)
        annotator.save("./output.pdf")
```

### remove_annotation_base method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/remove_annotation_base.md

#### remove_annotation_base

```python
def remove_annotation_base(self):
    ...
```

### remove_int32 method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/remove_int32.md

#### remove_int32

```python
def remove_int32(self):
    ...
```

### remove_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/remove_list.md

#### remove_list

```python
def remove_list(self):
    ...
```

### rotation property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/rotation.md

#### rotation property

The document rotation angle.

##### Definition:
```python
@property
def rotation(self):
    ...
@rotation.setter
def rotation(self, value):
    ...
```

### save method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/save.md

#### save

Saves document after adding, updating or removing annotations.

Learn more about saving annotated documents

- More about how to save only annotated document pages: https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages
- More about how to save document with specific annotation types only: https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types
- More about how to save specific pages from the whole document: https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range

```python
def save(self):
    ...
```

##### Example

```python
import io
from groupdocs.annotation import Annotator

with Annotator("document.pdf") as annotator:
    # add annotations here, e.g., annotator.add(area)
    buf = io.BytesIO()
    annotator.save(buf)  # BytesIO is updated after save
    data = buf.getvalue()
```

#### save

Saves the document after adding, updating, or removing annotations.

```python
def save(self, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| save_options | `SaveOptions` | The save options. |

**Returns:** None.

- More about how to save only annotated document pages: Save only annotated pages (https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages)
- More about how to save document with specific annotation types only: Filtering annotation types on save (https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types)
- More about how to save specific pages from the whole document: Save specific page range (https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range)

##### Example

```python
import io
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import SaveOptions, AnnotationType

with Annotator("document.pdf") as annotator:
    # add annotations here, e.g., annotator.add(area)

    # Save to a memory stream
    stream = io.BytesIO()
    annotator.save(stream)
    data = stream.getvalue()

    # Save with specific options
    options = SaveOptions()
    options.annotation_types = AnnotationType.AREA
    annotator.save("filtered.pdf", save_options=options)
```

#### save

Saves document after adding, updating or removing annotations.

Learn more about saving annotated documents.

- More about how to save only annotated document pages: https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages
- More about how to save document with specific annotation types only: https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types
- More about how to save specific pages from the whole document: https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range

```python
def save(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The output stream. |

##### Example

```python
import io
from groupdocs.annotation import Annotator

with Annotator("document.pdf") as annotator:
    # add annotations as needed, e.g., annotator.add(area)
    buf = io.BytesIO()
    annotator.save(buf)  # BytesIO is updated after save
    data = buf.getvalue()
```

#### save

Saves the document after adding, updating, or removing annotations.

Learn more about saving annotated documents.

- More about how to save only annotated document pages: https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages
- More about how to save document with specific annotation types only: https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types
- More about how to save specific pages from the whole document: https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range

```python
def save(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The output file path. |

##### Example

```python
import io
from groupdocs.annotation import Annotator

with Annotator("document.pdf") as annotator:
    # add annotations here, e.g., annotator.add(area)
    buf = io.BytesIO()
    annotator.save(buf)  # BytesIO is updated after save
    data = buf.getvalue()
```

#### save

Saves document after adding, updating or removing annotations.

**Learn more about saving annotated documents**

- More about how to save only annotated document pages: <https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages>
- More about how to save document with specific annotation types only: <https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types>
- More about how to save specific pages from the whole document: <https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range>

```python
def save(self, document, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The output stream or file path where the annotated document will be saved. |
| save_options | `SaveOptions` | The save options that control which pages or annotation types are saved. |

##### Example

```python
import io
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import SaveOptions, AnnotationType

# Save to a stream
with Annotator("document.pdf") as annotator:
    # add annotations here
    buf = io.BytesIO()
    annotator.save(buf)                # BytesIO is updated after save
    data = buf.getvalue()

# Save to a file with filtering options
options = SaveOptions()
options.annotation_types = AnnotationType.AREA   # render only area annotations
options.first_page = 1                           # 1‑based page index
options.last_page = 2
with Annotator("document.pdf") as annotator:
    # add annotations here
    annotator.save("filtered.pdf", saveOptions=options)
```

#### save

Saves document after adding, updating or removing annotations.

- More about how to save only annotated document pages: <https://docs.groupdocs.com/display/annotationnet/Save+only+annotated+pages>
- More about how to save document with specific annotation types only: <https://docs.groupdocs.com/display/annotationnet/Filtering+annotation+types>
- More about how to save specific pages from the whole document: <https://docs.groupdocs.com/display/annotationnet/Save+specific+page+range>

```python
def save(self, file_path, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The output file path. |
| save_options | `SaveOptions` | The save options. |

##### Example

```python
import io
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import SaveOptions, AnnotationType

# Save to a stream
with Annotator("document.pdf") as annotator:
    # add annotations here
    buffer = io.BytesIO()
    annotator.save(buffer)  # buffer now contains the PDF bytes
    data = buffer.getvalue()

# Save with options (filter by type and page range)
with Annotator("document.pdf") as annotator:
    # add annotations here
    options = SaveOptions()
    options.annotation_types = AnnotationType.AREA  # render only area annotations
    options.first_page = 1  # 1‑based page numbers
    options.last_page = 2
    annotator.save("filtered.pdf", save_options=options)
```

### save_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_save_options method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/save_save_options.md

#### save_save_options

```python
def save_save_options(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### update method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/update.md

#### update

Updates document annotation by id.

Learn more

- More about how to update document annotations: https://docs.groupdocs.com/display/annotationnet/Update+annotations

```python
def update(self, new_annotation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| new_annotation | `AnnotationBase` | The annotation to update (Id should be provided). |

##### Example

```python
from groupdocs.annotation import Annotator

with Annotator("annotated.pdf") as annotator:
    annotations = annotator.get()
    annotator.update(annotations[0])
```

#### update

Updates collection of document annotations by overriding the previous list with a new one.

- More about how to update document annotations: https://docs.groupdocs.com/display/annotationnet/Update+annotations

```python
def update(self, annotations):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| annotations | `List[AnnotationBase]` | The annotations list that will be set. |

##### Example

```python
from groupdocs.annotation import Annotator

with Annotator("annotated.pdf") as annotator:
    all_annotations = annotator.get()
    # modify an annotation as needed
    annotator.update([all_annotations[0]])  # replace the current list with the modified annotation
    annotator.save("edited.pdf")
```

### update_annotation_base method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/update_annotation_base.md

#### update_annotation_base

```python
def update_annotation_base(self):
    ...
```

### update_list method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/update_list.md

#### update_list

```python
def update_list(self):
    ...
```

### AnnotatorException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotatorexception.md

#### AnnotatorException class

An error that occur during the document annotation process.

The AnnotatorException type exposes the following members:

### AnnotatorSettings class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotatorsettings.md

#### AnnotatorSettings class

Defines settings for customizing `Annotator` behavior.

The AnnotatorSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Properties
| Property | Description |
| :- | :- |
| cache | The cache. |
| logger | The logger. |

##### Guides
Task guides that use `AnnotatorSettings`:

* AI agents and LLM integration

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotatorsettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### cache property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotatorsettings/cache.md

#### cache property

The cache.

##### Definition:
```python
@property
def cache(self):
    ...
@cache.setter
def cache(self, value):
    ...
```

### logger property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotatorsettings/logger.md

#### logger property

The logger.

##### Definition:
```python
@property
def logger(self):
    ...
@logger.setter
def logger(self, value):
    ...
```

### ConvertFileException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/convertfileexception.md

#### ConvertFileException class

The exception that is thrown if file conversion failed.

The ConvertFileException type exposes the following members:

### CorruptedOrDamagedFileException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/corruptedordamagedfileexception.md

#### CorruptedOrDamagedFileException class

The exception that is thrown when file is corrupted or damaged.

The CorruptedOrDamagedFileException type exposes the following members:

### Document class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document.md

#### Document class

Represents various document properties.

The Document type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `Document` class. |
| __init__ | Initializes a new Document instance. |

##### Methods
| Method | Description |
| :- | :- |
| add_image_to_document | Change image quality and add image to document. |
| add_image_to_document_file |  |
| add_image_to_document_string |  |
| generate_preview | Generates document pages preview (screenshots of every page). |
| generate_preview_preview_options |  |
| get_document_info | Retrieves information about the document, including its type, size, page count, and detailed page data. |

##### Properties
| Property | Description |
| :- | :- |
| name | The document name. |
| password | The document password. |
| stream | The document stream. |

##### Guides
Task guides that use `Document`:

* AI agents and LLM integration

### __init__ constructor
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/__init__.md

#### __init__

Initializes a new instance of `Document` class.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | The document stream. |

#### __init__

Initializes a new Document instance.

```python
def __init__(self, stream, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | The document stream. |
| password | `str` | The document password. |

### add_image_to_document method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/add_image_to_document.md

#### add_image_to_document

Change image quality and add image to document.

```python
def add_image_to_document(self, data_dir, jpg_file_name, page_number, image_quality):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_dir | `str` | Specify the path to the input PDF file. |
| jpg_file_name | `str` | The path to the JPG file. |
| page_number | `int` | Page where the image will be inserted. |
| image_quality | `int` | Set image quality from 1 to 100, 1 is the smallest resolution, 100 is the largest. |

### add_image_to_document_file method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/add_image_to_document_file.md

#### add_image_to_document_file

```python
def add_image_to_document_file(self):
    ...
```

### add_image_to_document_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/add_image_to_document_string.md

#### add_image_to_document_string

```python
def add_image_to_document_string(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/generate_preview.md

#### generate_preview

Generates document pages preview (screenshots of every page).

```python
def generate_preview(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | `PreviewOptions` | The document preview options |

##### Example

```python
def generate_document_preview():
    output_dir = "./preview"
    os.makedirs(output_dir, exist_ok=True)

    open_streams = {}

    def create_page_stream(page_number):
        stream = open(os.path.join(output_dir, f"page_{page_number}.png"), "wb")
        open_streams[page_number] = stream
        return stream

    def release_page_stream(page_number, page_stream):
        stream = open_streams.pop(page_number, None)
        if stream:
            stream.close()

    with Annotator("./sample.pdf") as annotator:
        preview_options = PreviewOptions(create_page_stream, release_page_stream)
        preview_options.preview_format = PreviewFormats.PNG
        preview_options.page_numbers = [1]
        annotator.document.generate_preview(preview_options)

    print(f"Generated page preview image(s) in {output_dir}.")


if __name__ == "__main__":
    generate_document_preview()
```

### generate_preview_preview_options method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/generate_preview_preview_options.md

#### generate_preview_preview_options

```python
def generate_preview_preview_options(self):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/get_document_info.md

#### get_document_info

Retrieves information about the document, including its type, size, page count, and detailed page data.

```python
def get_document_info(self):
    ...
```

##### Example

```python
with Annotator("document.pdf") as annotator:
    info = annotator.document.get_document_info()
    print(info.file_type.file_format, info.page_count, info.size)
```

### name property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/name.md

#### name property

The document name.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/password.md

#### password property

The document password.

##### Definition:
```python
@property
def password(self):
    ...
```

### stream property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/stream.md

#### stream property

The document stream.

##### Definition:
```python
@property
def stream(self):
    ...
```

### FileType class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype.md

#### FileType class

Information about file, such as type, extension, etc.

The FileType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| equals | File type equivalence check. |
| equals | Equivalence check with object. |
| equals_file_type |  |
| equals_object |  |
| from_file_name_or_extension | Return FileType based on file name or extension. |
| get_hash_code | Get hash code. |
| get_supported_file_types | Get supported file types enumeration. |
| to_string | Returns a string that represents the file type. |

##### Properties
| Property | Description |
| :- | :- |
| extension | The file extension. |
| file_format | The file format. |

##### Example

```python
from groupdocs.annotation import FileType

# Retrieve a list of all supported file types
supported = FileType.get_supported_file_types()
print(supported)
```

### equals method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/equals.md

#### equals

File type equivalence check.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FileType` | FileType object. |

**Returns:** bool: True if file types are equivalent, False if not.

#### equals

Equivalence check with object.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | Any object. |

**Returns:** bool: True if file types are equivalent, False if not.

### equals_file_type method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/equals_file_type.md

#### equals_file_type

```python
def equals_file_type(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/extension.md

#### extension property

The file extension.

##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/file_format.md

#### file_format property

The file format.

##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_file_name_or_extension method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/from_file_name_or_extension.md

#### from_file_name_or_extension

Return FileType based on file name or extension.

```python
def from_file_name_or_extension(cls, file_name_or_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name_or_extension | `str` | The file name or file extension. |

**Returns:** FileType: The file type.

### get_hash_code method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/get_hash_code.md

#### get_hash_code

Get hash code.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: Hash code.

### get_supported_file_types method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/get_supported_file_types.md

#### get_supported_file_types

Get supported file types enumeration.

```python
def get_supported_file_types(cls):
    ...
```

**Returns:** Iterable[FileType]: Enumeration of supported file types.

##### Example

```python
    from groupdocs.annotation import FileType

    supported_formats = FileType.get_supported_file_types()
    for fmt in supported_formats:
        print(fmt)
    ```

### to_string method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetype/to_string.md

#### to_string

Returns a string that represents the file type.

```python
def to_string(self):
    ...
```

**Returns:** str: A string that represents the file type.

### FileTypeNotSupportedException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

The exception that is thrown when file type is not supported.

The FileTypeNotSupportedException type exposes the following members:

### GroupDocsAnnotationException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/groupdocsannotationexception.md

#### GroupDocsAnnotationException class

Product-root exception for 'annotation' — every

generated exception subclasses this, and callers can
``except GroupDocsAnnotationException:`` as a catch-all for
this product without catching other GroupDocs errors.

The GroupDocsAnnotationException type exposes the following members:

### IDocumentInfo class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/idocumentinfo.md

#### IDocumentInfo class

Interface that defines list of available document information.

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type | The document file type. |
| page_count | The amount of pages. |
| pages_info | The list of information about each page. |
| size | The file size in bytes. |

### file_type property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/idocumentinfo/file_type.md

#### file_type property

The document file type.

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/idocumentinfo/page_count.md

#### page_count property

The amount of pages.

##### Definition:
```python
@property
def page_count(self):
    ...
@page_count.setter
def page_count(self, value):
    ...
```

### pages_info property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/idocumentinfo/pages_info.md

#### pages_info property

The list of information about each page.

##### Definition:
```python
@property
def pages_info(self):
    ...
@pages_info.setter
def pages_info(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/idocumentinfo/size.md

#### size property

The file size in bytes.

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### ImageNotLoadedException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/imagenotloadedexception.md

#### ImageNotLoadedException class

The exception that is thrown when image cannot be loaded from remote or local path. Usually happens if the provided "path" is incorrect.

The ImageNotLoadedException type exposes the following members:

### IOException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/ioexception.md

#### IOException class

The exception that is thrown when trying to apply format-specific annotation to the wrong file type.

The IOException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/license.md

#### License class

Manages GroupDocs.Annotation licensing.

Licensed builds unlock the full feature set of the wrapper at
runtime. Unlicensed builds run in evaluation mode with the same API
surface but with limits on output size and watermarked content.

The License type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| set_license | Apply a license to the current process. |

##### Guides
Task guides that use `License`:

* AI agents and LLM integration
* Licensing and evaluation

### set_license method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/license/set_license.md

#### set_license

Apply a license to the current process.

```python
def set_license(self, license_source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_source |  | Either a string path to a ``.lic`` file or a readable file-like object that yields the license bytes. File-like inputs are written to a temporary file before being passed to the bridge. |

| Raises | Description |
| :- | :- |
| `TypeError` | If ``license_source`` is neither a string path nor a readable file-like object. |

### Metered class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/metered.md

#### Metered class

Manages metered (pay-per-use) licensing.

Metered licenses bill on actual consumption (typically pages or
documents processed). Set the public/private key pair once at
application startup; the wrapper reports usage back to the GroupDocs
license server in the background.

The Metered type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_consumption_credit | Return the remaining metered credit for the current key. |
| get_consumption_quantity | Return the total metered quantity consumed so far. |
| set_metered_key | Activate metered billing with the given public/private key pair. |

##### Guides
Task guides that use `Metered`:

* AI agents and LLM integration
* Licensing and evaluation

### get_consumption_credit method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/metered/get_consumption_credit.md

#### get_consumption_credit

Return the remaining metered credit for the current key.

```python
def get_consumption_credit():
    ...
```

**Returns:** float: The remaining credit balance reported by the license
server.

### get_consumption_quantity method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/metered/get_consumption_quantity.md

#### get_consumption_quantity

Return the total metered quantity consumed so far.

```python
def get_consumption_quantity():
    ...
```

**Returns:** float: The cumulative usage (typically in pages or documents)
recorded against the current metered key.

### set_metered_key method
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/metered/set_metered_key.md

#### set_metered_key

Activate metered billing with the given public/private key pair.

```python
def set_metered_key(self, public_key, private_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| public_key |  | The public key half of the metered credentials. |
| private_key |  | The private key half of the metered credentials. |

### PasswordProtectedFileException class
Path: https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/passwordprotectedfileexception.md

#### PasswordProtectedFileException class

The exception that is thrown when provided password is incorrect.

The PasswordProtectedFileException type exposes the following members:

### Developer Guide
Path: https://reference.groupdocs.com/annotation/python-net/guides.md

#### Developer Guide

Task-oriented guides with runnable Python examples.

| Guide | |
| :- | :- |
| Add annotations | |
| Features Overview | |
| GroupDocs.Annotation for Python via .NET Overview | |
| Install GroupDocs.Annotation for Python via .NET | |
| Loading documents | |
| Hello, World! | |
| Manage annotations | |
| Saving documents | |
| Supported Document Formats | |
| Comments and replies | |
| Generate document preview | |
| Import and export annotations | |
| Showcases | |
| Licensing and evaluation | |
| AI agents and LLM integration | |
| System Requirements | |
| How to Run Examples | |
| Technical Support | |

### Add annotations
Path: https://reference.groupdocs.com/annotation/python-net/guides/add-annotations.md

GroupDocs.Annotation lets you add many kinds of annotations to PDF, Word, Excel, PowerPoint, image, and other documents. You create an annotation object, set its properties, call [`add`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/) on the [`Annotator`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/), and `save` the result.

A few rules apply to every annotation:

- **Position.** Box-style annotations (area, ellipse, point, arrow, distance, polyline, text field, watermark, resources redaction, image) are positioned with a `Rectangle(x, y, width, height)` assigned to the `.box` property. Text-markup annotations (highlight, underline, strikeout, squiggly, replacement, text redaction, link) are positioned with a list of corner `Point` objects assigned to the `.points` property, in the order top-left, top-right, bottom-left, bottom-right.
- **Colors.** Every color property (`background_color`, `font_color`, `pen_color`, `underline_color`, `squiggly_color`) is a packed **ARGB integer**, not a `Color` object. Use `Color.<name>.to_argb()` or `Color.from_argb(a, r, g, b).to_argb()`.
- **Page index.** `page_number` is **0-based** — `0` is the first page.

#### Add an area annotation

An area annotation draws a filled rectangle over a region of the page.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def add_area_annotation():
    # Load the document to be annotated
    with Annotator("./sample.pdf") as annotator:
        # Configure an area (rectangle) annotation
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)   # x, y, width, height
        area.background_color = Color.yellow.to_argb()
        area.pen_color = Color.red.to_argb()
        area.pen_width = 3
        area.pen_style = PenStyle.SOLID
        area.opacity = 0.7
        area.page_number = 0
        area.message = "This is an area annotation"

        # Add the annotation and save the result
        annotator.add(area)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_area_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_area_annotation/output.pdf)

#### Add an ellipse annotation

An ellipse annotation draws a filled oval inside the bounding box.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import EllipseAnnotation
from groupdocs.pydrawing import Color

def add_ellipse_annotation():
    with Annotator("./sample.pdf") as annotator:
        ellipse = EllipseAnnotation()
        ellipse.box = Rectangle(100, 100, 200, 120)
        ellipse.background_color = Color.from_argb(255, 144, 238, 144).to_argb()
        ellipse.pen_color = Color.green.to_argb()
        ellipse.pen_width = 2
        ellipse.pen_style = PenStyle.SOLID
        ellipse.opacity = 0.7
        ellipse.page_number = 0
        ellipse.message = "This is an ellipse annotation"
        annotator.add(ellipse)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_ellipse_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_ellipse_annotation/output.pdf)

#### Add a point annotation

A point annotation marks a single location on the page. It is positioned by the origin of its box, so the width and height are `0`.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import PointAnnotation

def add_point_annotation():
    with Annotator("./sample.pdf") as annotator:
        point = PointAnnotation()
        point.box = Rectangle(100, 100, 0, 0)   # a point is positioned by its box origin
        point.page_number = 0
        point.message = "This is a point annotation"
        annotator.add(point)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_point_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_point_annotation/output.pdf)

#### Add an arrow annotation

An arrow annotation draws a directed line across the bounding box.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import ArrowAnnotation
from groupdocs.pydrawing import Color

def add_arrow_annotation():
    with Annotator("./sample.pdf") as annotator:
        arrow = ArrowAnnotation()
        arrow.box = Rectangle(100, 100, 100, 100)
        arrow.pen_color = Color.blue.to_argb()
        arrow.pen_width = 2
        arrow.pen_style = PenStyle.SOLID
        arrow.opacity = 0.9
        arrow.page_number = 0
        arrow.message = "This is an arrow annotation"
        annotator.add(arrow)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_arrow_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_arrow_annotation/output.pdf)

#### Add a distance annotation

A distance annotation measures the span between two points on the page.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import DistanceAnnotation
from groupdocs.pydrawing import Color

def add_distance_annotation():
    with Annotator("./sample.pdf") as annotator:
        distance = DistanceAnnotation()
        distance.box = Rectangle(100, 100, 100, 100)
        distance.pen_color = Color.blue.to_argb()
        distance.pen_width = 2
        distance.pen_style = PenStyle.SOLID
        distance.opacity = 0.7
        distance.page_number = 0
        distance.message = "This is a distance annotation"
        annotator.add(distance)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_distance_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_distance_annotation/output.pdf)

#### Add a polyline annotation

A polyline annotation draws a free-form shape described by an SVG path inside the bounding box.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import PolylineAnnotation
from groupdocs.pydrawing import Color

def add_polyline_annotation():
    with Annotator("./sample.pdf") as annotator:
        polyline = PolylineAnnotation()
        polyline.box = Rectangle(100, 100, 200, 100)
        polyline.svg_path = "M 0 0 L 50 50 L 100 0 L 150 50"
        polyline.pen_color = Color.purple.to_argb()
        polyline.pen_width = 2
        polyline.pen_style = PenStyle.SOLID
        polyline.opacity = 0.9
        polyline.page_number = 0
        polyline.message = "This is a polyline annotation"
        annotator.add(polyline)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_polyline_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_polyline_annotation/output.pdf)

#### Add a highlight annotation

Highlight, underline, strikeout, and squiggly are text-markup annotations: they are positioned by the corner `Point` objects of the text region rather than a box.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import HighlightAnnotation
from groupdocs.pydrawing import Color

def add_highlight_annotation():
    with Annotator("./sample.pdf") as annotator:
        highlight = HighlightAnnotation()
        # Text-markup annotations are positioned by the corner points of the
        # text region: top-left, top-right, bottom-left, bottom-right
        highlight.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        highlight.background_color = Color.yellow.to_argb()
        highlight.opacity = 0.7
        highlight.page_number = 0
        highlight.message = "This is a highlight annotation"
        annotator.add(highlight)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_highlight_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_highlight_annotation/output.pdf)

#### Add an underline annotation

An underline annotation draws a line beneath the selected text region.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import UnderlineAnnotation
from groupdocs.pydrawing import Color

def add_underline_annotation():
    with Annotator("./sample.pdf") as annotator:
        underline = UnderlineAnnotation()
        underline.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        underline.underline_color = Color.red.to_argb()
        underline.opacity = 0.9
        underline.page_number = 0
        underline.message = "This is an underline annotation"
        annotator.add(underline)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_underline_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_underline_annotation/output.pdf)

#### Add a strikeout annotation

A strikeout annotation draws a line through the selected text region.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import StrikeoutAnnotation
from groupdocs.pydrawing import Color

def add_strikeout_annotation():
    with Annotator("./sample.pdf") as annotator:
        strikeout = StrikeoutAnnotation()
        strikeout.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        strikeout.font_color = Color.red.to_argb()
        strikeout.opacity = 0.9
        strikeout.page_number = 0
        strikeout.message = "This is a strikeout annotation"
        annotator.add(strikeout)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_strikeout_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_strikeout_annotation/output.pdf)

#### Add a squiggly annotation

A squiggly annotation draws a wavy line under the selected text region.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import SquigglyAnnotation
from groupdocs.pydrawing import Color

def add_squiggly_annotation():
    with Annotator("./sample.pdf") as annotator:
        squiggly = SquigglyAnnotation()
        squiggly.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        squiggly.squiggly_color = Color.red.to_argb()
        squiggly.opacity = 0.9
        squiggly.page_number = 0
        squiggly.message = "This is a squiggly annotation"
        annotator.add(squiggly)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_squiggly_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_squiggly_annotation/output.pdf)

#### Add a text field annotation

A text field annotation places editable text inside a box, with font and alignment control.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, HorizontalAlignment
from groupdocs.annotation.models.annotation_models import TextFieldAnnotation
from groupdocs.pydrawing import Color

def add_text_field_annotation():
    with Annotator("./sample.pdf") as annotator:
        text_field = TextFieldAnnotation()
        text_field.box = Rectangle(100, 100, 150, 50)
        text_field.text = "Some text in a field"
        text_field.font_family = "Arial"
        text_field.font_size = 12.0
        text_field.font_color = Color.black.to_argb()
        text_field.background_color = Color.yellow.to_argb()
        text_field.text_horizontal_alignment = HorizontalAlignment.CENTER
        text_field.opacity = 0.9
        text_field.page_number = 0
        text_field.message = "This is a text field annotation"
        annotator.add(text_field)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_text_field_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_text_field_annotation/output.pdf)

#### Add a text replacement annotation

A text replacement annotation marks a text region and provides replacement text.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import ReplacementAnnotation
from groupdocs.pydrawing import Color

def add_replacement_annotation():
    with Annotator("./sample.pdf") as annotator:
        replacement = ReplacementAnnotation()
        replacement.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        replacement.text_to_replace = "replacement text"
        replacement.font_color = Color.black.to_argb()
        replacement.font_size = 12.0
        replacement.opacity = 0.9
        replacement.page_number = 0
        replacement.message = "This is a text replacement annotation"
        annotator.add(replacement)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_replacement_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_replacement_annotation/output.pdf)

#### Add a text redaction annotation

A text redaction annotation hides a text region behind a solid block.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import TextRedactionAnnotation
from groupdocs.pydrawing import Color

def add_text_redaction_annotation():
    with Annotator("./sample.pdf") as annotator:
        redaction = TextRedactionAnnotation()
        redaction.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        redaction.font_color = Color.black.to_argb()
        redaction.page_number = 0
        redaction.message = "This is a text redaction annotation"
        annotator.add(redaction)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_text_redaction_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_text_redaction_annotation/output.pdf)

#### Add a resources redaction annotation

A resources redaction annotation blacks out a rectangular region, removing the underlying page resources.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ResourcesRedactionAnnotation

def add_resources_redaction_annotation():
    with Annotator("./sample.pdf") as annotator:
        redaction = ResourcesRedactionAnnotation()
        redaction.box = Rectangle(100, 100, 200, 80)
        redaction.page_number = 0
        redaction.message = "This is a resources redaction annotation"
        annotator.add(redaction)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_resources_redaction_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_resources_redaction_annotation/output.pdf)

#### Add a watermark annotation

A watermark annotation places rotated, scalable text over the page.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, HorizontalAlignment, VerticalAlignment
from groupdocs.annotation.models.annotation_models import WatermarkAnnotation
from groupdocs.pydrawing import Color

def add_watermark_annotation():
    with Annotator("./sample.pdf") as annotator:
        watermark = WatermarkAnnotation()
        watermark.box = Rectangle(100, 100, 200, 100)
        watermark.text = "Watermark"
        watermark.font_family = "Arial"
        watermark.font_size = 24.0
        watermark.font_color = Color.red.to_argb()
        watermark.angle = 45.0
        watermark.auto_scale = True
        watermark.horizontal_alignment = HorizontalAlignment.CENTER
        watermark.vertical_alignment = VerticalAlignment.CENTER
        watermark.opacity = 0.5
        watermark.page_number = 0
        watermark.message = "This is a watermark annotation"
        annotator.add(watermark)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_watermark_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_watermark_annotation/output.pdf)

#### Add a link annotation

A link annotation turns a text region into a clickable hyperlink.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import LinkAnnotation
from groupdocs.pydrawing import Color

def add_link_annotation():
    with Annotator("./sample.pdf") as annotator:
        link = LinkAnnotation()
        link.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        link.url = "https://www.groupdocs.com"
        link.background_color = Color.azure.to_argb()
        link.opacity = 0.7
        link.page_number = 0
        link.message = "This is a link annotation"
        annotator.add(link)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_link_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_link_annotation/output.pdf)

#### Add an image annotation

An image annotation stamps a picture from disk onto the page. Set `image_path` to a local image file.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ImageAnnotation

def add_image_annotation():
    with Annotator("./sample.pdf") as annotator:
        image = ImageAnnotation()
        image.box = Rectangle(100, 100, 100, 100)
        image.image_path = "./stamp.png"
        image.opacity = 0.9
        image.angle = 0.0
        image.page_number = 0
        image.message = "This is an image annotation"
        annotator.add(image)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_image_annotation()
```

`sample.pdf` is the document used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/sample.pdf) to download it.

`stamp.png` is the image stamped onto the page. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/add-annotations/stamp.png) to download it.

```text
Binary file (PDF, 95 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/add-annotations/add_image_annotation/output.pdf)

### AI agents and LLM integration
Path: https://reference.groupdocs.com/annotation/python-net/guides/agents-and-llm-integration.md

GroupDocs.Annotation for Python via .NET is designed to work smoothly with AI coding assistants such as Claude Code, Cursor, and GitHub Copilot in agent mode.

#### Built into the package

The `groupdocs-annotation-net` wheel ships a bundled `AGENTS.md` reference. Once the package is installed, AI tools discover it automatically at `groupdocs/annotation/AGENTS.md`. It covers the canonical imports, the open → add → save workflow, per-operation recipes, licensing, the full API-surface tables, and troubleshooting — everything an agent needs to write correct annotation code without guessing.

#### MCP server

For on-demand documentation lookups, point your AI tool at the GroupDocs MCP server:

```json
{
  "mcpServers": {
    "groupdocs-docs": {
      "url": "https://docs.groupdocs.com/mcp"
    }
  }
}
```

This works with Claude Code (`~/.claude/settings.json`), Cursor (`.cursor/mcp.json`), VS Code Copilot (`.vscode/mcp.json`), and any MCP-compatible client.

#### Machine-readable documentation

LLM-optimized documentation for retrieval-augmented generation and context loading is available at [`https://docs.groupdocs.com/annotation/python-net/llms-full.txt`](https://docs.groupdocs.com/annotation/python-net/llms-full.txt).

#### AGENTS.md reference

The complete reference bundled inside the wheel is reproduced below.

````markdown
# GroupDocs.Annotation for Python via .NET -- AGENTS.md

> Instructions for AI agents working with this package.

Add, edit, and remove annotations and markup on documents and images -- area/ellipse/arrow/point/distance/polyline shapes, text highlight/underline/strikeout/squiggly, replacement and redaction markups, watermarks, image and link stamps, editable text fields, and threaded review comments (replies) -- then save back to the original format. Works across PDF, Word, Excel, PowerPoint, Visio, CAD, images, email, and more through one unified API, with no MS Office or external software installed.

## Install

```bash
pip install groupdocs-annotation-net
```

**Python**: 3.5 - 3.14 | **Platforms**: Windows, Linux, macOS

## Resources

| Resource | URL |
|---|---|
| Documentation | https://docs.groupdocs.com/annotation/python-net/ |
| LLM-optimized docs | https://docs.groupdocs.com/annotation/python-net/llms-full.txt |
| API reference | https://reference.groupdocs.com/annotation/python-net/ |
| Code examples | https://docs.groupdocs.com/annotation/python-net/developer-guide/ |
| Release notes | https://releases.groupdocs.com/annotation/python-net/release-notes/ |
| PyPI | https://pypi.org/project/groupdocs-annotation-net/ |
| Free support forum | https://forum.groupdocs.com/c/annotation/ |
| Temporary license | https://purchase.groupdocs.com/temporary-license |

## MCP Server

If your environment has MCP configured, you can connect your AI tool to the GroupDocs documentation server for on-demand API lookups:

```json
{
  "mcpServers": {
    "groupdocs-docs": {
      "url": "https://docs.groupdocs.com/mcp"
    }
  }
}
```

Works with Claude Code (`~/.claude/settings.json`), Cursor (`.cursor/mcp.json`), VS Code Copilot (`.vscode/mcp.json`), and any MCP-compatible client. If MCP is unavailable, fall back to the LLM-optimized docs URL above and this file -- both are shipped inside the wheel.

## Imports

```python
from groupdocs.annotation import Annotator, AnnotatorSettings, Document, FileType, License, Metered
from groupdocs.annotation.options import (
    AnnotationType, LoadOptions, SaveOptions,
)
from groupdocs.annotation.models import (
    Rectangle, Point, Reply, User, Role, PageInfo,
    BorderStyle, BoxStyle, HorizontalAlignment, VerticalAlignment, RotationDocument,
)
from groupdocs.annotation.models.annotation_models import (
    AnnotationBase,
    # shapes
    AreaAnnotation, ArrowAnnotation, DistanceAnnotation, EllipseAnnotation,
    PointAnnotation, PolylineAnnotation,
    # text markup
    HighlightAnnotation, UnderlineAnnotation, StrikeoutAnnotation, SquigglyAnnotation,
    ReplacementAnnotation, TextRedactionAnnotation, ResourcesRedactionAnnotation,
    # content
    WatermarkAnnotation, ImageAnnotation, LinkAnnotation, TextFieldAnnotation,
)
from groupdocs.pydrawing import Color   # use Color.<name>.to_argb() for ARGB ints
```

## Open + annotate + save (the core workflow)

`Annotator` is the entry point. The flow is always: **open → one or more `add(...)` calls → `save()`**. Each annotation is a plain object you configure with properties, then hand to `add`. Use `Annotator` as a context manager so the native document handle is released.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

with Annotator("document.pdf") as annotator:
    area = AreaAnnotation()
    area.box = Rectangle(100, 100, 200, 80)        # x, y, width, height
    area.page_number = 0                            # 0-based page index
    area.background_color = Color.yellow.to_argb()  # ARGB int, NOT a Color object
    area.message = "Review this"
    annotator.add(area)
    annotator.save("annotated.pdf")
```

**`Annotator(...)` constructor.** `Annotator(file_path)` or `Annotator(stream)`, optionally with `LoadOptions` and/or `AnnotatorSettings`: `Annotator("doc.pdf", LoadOptions(password="..."))`, `Annotator(stream, LoadOptions(), AnnotatorSettings(...))`.

**`add(...)`** accepts a single annotation or a list of annotations. **`save(...)`** writes to a path or a writable stream; pass `SaveOptions` (as `save_options=...`) to control which annotation types and pages are rendered. By default `save()` renders all annotations onto the document.

**Coordinates & colors.** Geometry uses `Rectangle(x, y, width, height)` and `Point(x, y)` from `groupdocs.annotation.models`. **Colors are ARGB integers**, not `Color` objects — always pass `Color.<name>.to_argb()` (or a literal ARGB int) to `background_color`, `font_color`, `pen_color`, `underline_color`, and `squiggly_color`.

**Pages.** Annotation `page_number` is **0-based**, but `SaveOptions.first_page` / `last_page` are **1-based**.

## Operations

### Shape annotations (area / ellipse / arrow / point / distance / polyline)

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation, EllipseAnnotation
from groupdocs.pydrawing import Color

area = AreaAnnotation()
area.box = Rectangle(100, 100, 200, 80)
area.background_color = Color.yellow.to_argb()   # ARGB int
area.pen_color = Color.red.to_argb()             # ARGB int
area.opacity = 0.7
area.page_number = 0
area.message = "Flagged region"

ell = EllipseAnnotation()
ell.box = Rectangle(50, 200, 120, 60)
ell.page_number = 0

with Annotator("document.pdf") as annotator:
    annotator.add([area, ell])     # add several at once
    annotator.save("annotated.pdf")
```

Shape types share `box`, `background_color` / `pen_color`, and `opacity`. `ArrowAnnotation`, `DistanceAnnotation`, and `PolylineAnnotation` use the same box/points surface; `PointAnnotation` anchors a comment at a single point.

### Text markup (highlight / underline / strikeout / squiggly / replacement)

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import HighlightAnnotation
from groupdocs.pydrawing import Color

hl = HighlightAnnotation()
hl.font_color = Color.yellow.to_argb()
hl.page_number = 0
# Quad points around the target text (top-left, top-right, bottom-right, bottom-left):
hl.points = [Point(80, 730), Point(240, 730), Point(240, 750), Point(80, 750)]

with Annotator("document.pdf") as annotator:
    annotator.add(hl)
    annotator.save("highlighted.pdf")
```

Text-markup types expose `points` (a list of `Point` describing the marked region) and `font_color`; the rest of the markup family (`UnderlineAnnotation`, `StrikeoutAnnotation`, `SquigglyAnnotation`, `ReplacementAnnotation`, `TextRedactionAnnotation`, `ResourcesRedactionAnnotation`) follows the same shape.

### Review comments (replies)

```python
from groupdocs.annotation.models import Reply

r1 = Reply(); r1.comment = "Please double-check this"
r2 = Reply(); r2.comment = "Confirmed"

area.replies = [r1, r2]            # attach a comment thread to any annotation
```

`Reply` has `comment`, `user` (a `User`), `replied_on`, and `id`. A `User(id, name, role)` carries a `Role` (`VIEWER` / `EDITOR`).

### Content annotations (watermark / image / link / text field)

`WatermarkAnnotation`, `ImageAnnotation` (set `image_path`), `LinkAnnotation` (set `url`), and `TextFieldAnnotation` are created and added the same way — configure their properties, then `annotator.add(...)`.

### List, update, remove

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import AnnotationType

with Annotator("annotated.pdf") as annotator:
    all_annotations = annotator.get()              # every annotation -> list
    areas = annotator.get(AnnotationType.AREA)     # filter by type -> list
    annotator.update(all_annotations[0])           # push a modified annotation back
    annotator.remove(all_annotations[0])           # by object, or annotator.remove(id)
    annotator.save("edited.pdf")
```

### Save options (page range + annotation-type filter)

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import SaveOptions, AnnotationType

with Annotator("document.pdf") as annotator:
    annotator.add(area)
    options = SaveOptions()
    options.annotation_types = AnnotationType.AREA   # render only area annotations
    options.first_page = 1                           # 1-based
    options.last_page = 2
    annotator.save("filtered.pdf", save_options=options)
```

### Document info

```python
with Annotator("document.pdf") as annotator:
    info = annotator.document.get_document_info()    # format, page count, size
    print(info.file_type.file_format, info.page_count, info.size)
```

### Save to a stream

```python
import io
with Annotator("document.pdf") as annotator:
    annotator.add(area)
    buf = io.BytesIO()
    annotator.save(buf)                # BytesIO is updated after save
    data = buf.getvalue()
```

## Licensing

```python
from groupdocs.annotation import License

# From file
License().set_license("path/to/license.lic")

# From stream
with open("license.lic", "rb") as f:
    License().set_license(f)
```

Or auto-apply: `export GROUPDOCS_LIC_PATH="path/to/license.lic"`

Metered licensing is also available:

```python
from groupdocs.annotation import Metered

Metered().set_metered_key("public-key", "private-key")
print(Metered().get_consumption_quantity(), Metered().get_consumption_credit())
```

**Evaluation vs licensed.** Without a license the library still runs and `save()` completes normally, but the output carries an evaluation watermark/banner (the output file is noticeably larger). There is no per-process document-open cap. Set `GROUPDOCS_LIC_PATH` (or call `License().set_license(...)`) and re-run to clear the watermark. A 30-day full license is free: https://purchase.groupdocs.com/temporary-license

## API Reference

### Annotator

| Method | Returns | Description |
|---|---|---|
| `Annotator(file_path / stream [, load_options [, settings]])` | | Open by path or binary stream; optional `LoadOptions` / `AnnotatorSettings`. Context manager. |
| `add(annotation)` / `add([annotations])` | `None` | Add one annotation or a list. |
| `update(annotation)` | `None` | Replace an existing annotation (matched by id). |
| `remove(annotation)` / `remove(id)` | `None` | Remove by object or by id; a list is also accepted. |
| `get()` | `list` | All annotations on the document. |
| `get(annotation_type)` | `list` | Annotations of one `AnnotationType`. |
| `save(path)` / `save(path, save_options=...)` / `save(stream)` | `None` | Render annotations and write the result. |
| `dispose()` | `None` | Release native resources (handled by `with`). |

`Annotator` properties: `document` (`Document` — `get_document_info()`), `rotation`, `process_pages`. `AnnotatorSettings` carries `logger` / `cache`.

### Annotation types (`groupdocs.annotation.models.annotation_models`)

| Type | Notes |
|---|---|
| `AreaAnnotation`, `EllipseAnnotation` | `box` (`Rectangle`), `background_color`, `pen_color`, `opacity` (ARGB-int colors). |
| `ArrowAnnotation`, `DistanceAnnotation`, `PolylineAnnotation` | Line/shape markups; box + points. |
| `PointAnnotation` | A single comment anchor at a point. |
| `HighlightAnnotation`, `UnderlineAnnotation`, `StrikeoutAnnotation`, `SquigglyAnnotation` | Text markup; `points` (quad) + `font_color`. |
| `ReplacementAnnotation`, `TextRedactionAnnotation`, `ResourcesRedactionAnnotation` | Replace / redact text or resources. |
| `WatermarkAnnotation` | Text watermark stamp. |
| `ImageAnnotation` | Image stamp (`image_path`). |
| `LinkAnnotation` | Hyperlink over a region (`url`). |
| `TextFieldAnnotation` | Editable text field. |
| All | Inherit `id`, `message`, `page_number`, `replies`, `created_on`, `user`, `type` from `AnnotationBase`. |

### Options, models & enums

| Type | Notes |
|---|---|
| `LoadOptions(password=...)` | Open protected input. |
| `SaveOptions` | `annotation_types`, `first_page` (1-based), `last_page`, `only_annotated_pages`. |
| `AnnotationType` | Enum of annotation kinds (filter for `get(...)` / `SaveOptions`). |
| `Rectangle(x, y, width, height)` / `Point(x, y)` | Geometry (from `...models`). |
| `Reply` | `comment`, `user`, `replied_on`, `id`. |
| `User(id, name, role)` / `Role` | `VIEWER`, `EDITOR`. |
| `BorderStyle`, `BoxStyle`, `HorizontalAlignment`, `VerticalAlignment`, `RotationDocument` | Styling enums. |

### License / Metered

`License().set_license(path_or_stream)` · `Metered().set_metered_key(public, private)` · `Metered().get_consumption_quantity()` · `Metered().get_consumption_credit()`

## Key Patterns

- **Properties**: use `snake_case` -- auto-mapped to .NET `PascalCase`
- **Context managers**: `with Annotator(...) as a:` ensures the document handle is released
- **Build then add**: construct an annotation object, set its properties, then `add(it)` — or `add([...])` for several
- **Colors are ARGB ints**: always pass `Color.<name>.to_argb()` (e.g. `annotation.background_color = Color.yellow.to_argb()`), never a `Color` object
- **Geometry**: `Rectangle(x, y, width, height)`, `Point(x, y)`; text markup uses a `points` quad
- **Pages**: annotation `page_number` is **0-based**; `SaveOptions.first_page` / `last_page` are **1-based**
- **Replies**: attach a `list[Reply]` to any annotation's `replies` for review comments
- **Streams**: pass `open("file", "rb")` or `io.BytesIO(data)` where .NET expects a Stream; `BytesIO` is updated after `save(stream)`
- **Enums**: case-insensitive, lazy-loaded (e.g., `AnnotationType.AREA`, `Role.EDITOR`)

## Platform Requirements

| Platform | Requirements |
|---|---|
| Windows | None |
| Linux | `apt install libgdiplus libfontconfig1 ttf-mscorefonts-installer` |
| macOS | `brew install mono-libgdiplus` |

## Troubleshooting

**Evaluation watermark on output** -- no license. Apply one with `License().set_license(...)` or set `GROUPDOCS_LIC_PATH`; a free 30-day license is at https://purchase.groupdocs.com/temporary-license

**Password-protected source** -- the input is encrypted. Open it with `Annotator(path, LoadOptions(password="..."))`.

**Unsupported or damaged file** -- the format isn't supported or the file is corrupted. Check it against the supported-formats list.

**`System.Drawing.Common is not supported`** -- install libgdiplus: `sudo apt install libgdiplus` (Linux) / `brew install mono-libgdiplus` (macOS)

**`Gdip` type initializer exception** -- outdated libgdiplus: `brew reinstall mono-libgdiplus` (macOS)

**Garbled text / missing fonts** -- install fonts: `sudo apt install ttf-mscorefonts-installer fontconfig && sudo fc-cache -f`

**`DllNotFoundException: libSkiaSharp`** -- stale system copy conflicts with bundled version. Rename it: `sudo mv /usr/local/lib/libSkiaSharp.dylib /usr/local/lib/libSkiaSharp.dylib.bak`

**`DOTNET_SYSTEM_GLOBALIZATION_INVARIANT` errors** -- do NOT set this. Install ICU: `sudo apt install libicu-dev`

**`TypeLoadException`** -- reinstall: `pip install --force-reinstall groupdocs-annotation-net`

**Still stuck?** Post your question at https://forum.groupdocs.com/c/annotation/ -- the development team responds directly.
````
</content>

### Comments and replies
Path: https://reference.groupdocs.com/annotation/python-net/guides/comments-and-replies.md

Every annotation can carry a discussion thread. You build the thread as a list of [`Reply`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/reply/) objects and assign it to the annotation's `replies` property. Each reply has a `comment` and a [`User`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.models/user/), and each user has a `name` and a `Role` (`Role.EDITOR` or `Role.VIEWER`).

#### Add replies to an annotation

The example below creates an area annotation and attaches a two-message conversation between two users before saving the document.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, Reply, User, Role
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def add_replies_to_annotation():
    with Annotator("./sample.pdf") as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Please review this section"

        # Attach a threaded discussion to the annotation
        first_reply = Reply()
        first_reply.comment = "Good catch, I'll take a look."
        first_reply.user = User(name="Tom", role=Role.EDITOR)

        second_reply = Reply()
        second_reply.comment = "Agreed, looks resolved now."
        second_reply.user = User(name="Jack", role=Role.VIEWER)

        area.replies = [first_reply, second_reply]

        annotator.add(area)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    add_replies_to_annotation()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/comments-and-replies/sample.pdf) to download it.

```text
Binary file (PDF, 91 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/comments-and-replies/add_replies_to_annotation/output.pdf)

### Features Overview
Path: https://reference.groupdocs.com/annotation/python-net/guides/features-overview.md

GroupDocs.Annotation for Python via .NET adds annotations, markup, and review comments across a wide range of [supported document formats](https://docs.groupdocs.com/annotation/python-net/supported-document-formats/). Every annotation follows the same workflow: open a document with `Annotator`, add one or more annotations with `add()`, then `save()` the result — back to the original format or to another supported format. The capabilities below can be combined freely in a single pass.

#### Text markup

Mark up the text of a document with highlight, underline, strikeout, and squiggly-underline annotations, or replace and redact text. Text-markup annotations are positioned with a list of `Point` objects that describe the region they cover, and you can set colors such as `font_color`, `underline_color`, and `squiggly_color` (all passed as packed ARGB integers). See [Add Annotations](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/add-annotations/).

#### Graphic (shape) annotations

Draw geometric shapes over a page — area (rectangle), ellipse, point, arrow, distance, and polyline. Box-style shapes use a `Rectangle` (`box`) for position and size, while line-based shapes use `Point` coordinates. You can configure fill and pen colors (as ARGB integers) and the pen style. See [Add Annotations](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/add-annotations/).

#### Watermarks, text fields, links, and image stamps

Add a `WatermarkAnnotation` over a page, an editable `TextFieldAnnotation`, a clickable `LinkAnnotation`, or stamp an `ImageAnnotation` onto the document. These rich annotations let you label, brand, or augment a document without altering its underlying content. See [Add Annotations](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/add-annotations/).

#### Comments and replies

Attach an author and threaded review comments to any annotation. Each annotation carries a `user` (`User` with a `Role` of viewer or editor) and a list of `replies` (`Reply` objects with a comment, an author, and a timestamp), so you can model a full review conversation. See [Comments and Replies](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/comments-and-replies/).

#### Managing annotations

Add, update, get, and remove annotations. Retrieve all annotations, or filter by type with `get(type=AnnotationType.X)`; remove a single annotation by id or instance, or clear them all. See [Get Annotations](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/get-annotations/) and [Remove Annotations](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/remove-annotations/).

#### Document information

Inspect a document before annotating it — read the page count, file type, page dimensions, and size through `get_document_info()`, and list every format the API supports with `FileType.get_supported_file_types()`. See [Get Document Info](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/get-document-info/) and [Supported File Formats](https://docs.groupdocs.com/annotation/python-net/developer-guide/basic-usage/get-supported-file-formats/).

#### Loading and saving

Load documents from a local path or from a stream, including password-protected files, by passing `LoadOptions`. When saving, write back to the original format, save to a different path, restrict the output to specific pages with `SaveOptions.first_page`/`last_page` (1-based), or save only certain annotation types. See [Loading Documents](https://docs.groupdocs.com/annotation/python-net/developer-guide/advanced-usage/loading-documents/) and [Saving Documents](https://docs.groupdocs.com/annotation/python-net/developer-guide/advanced-usage/saving-documents/).

#### On-premise

GroupDocs.Annotation for Python via .NET runs entirely on your own infrastructure — your documents never leave your environment. The package is a self-contained wheel that bundles everything it needs, so no Microsoft Office, OpenOffice, Adobe Acrobat, or separate runtime has to be installed. See [System Requirements](https://docs.groupdocs.com/annotation/python-net/system-requirements/) for the supported platforms and native dependencies.
</content>
</invoke>

### Generate document preview
Path: https://reference.groupdocs.com/annotation/python-net/guides/generate-document-preview.md

Use [`Document.generate_preview`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/document/) to render document pages to image files (PNG, JPEG, or BMP). You configure the render with [`PreviewOptions`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/previewoptions/) and supply two callbacks: one that returns a writable stream for each page, and one that releases it after the page is written.

#### Render pages to PNG images

Pass the two callables directly to `PreviewOptions(create_page_stream, release_page_stream)` — the library invokes `create_page_stream(page_number)` to obtain a stream for each page and `release_page_stream(page_number, page_stream)` once the page has been written. Set `preview_format` and, optionally, `page_numbers` to limit which pages are rendered.

```python
import os
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import PreviewOptions, PreviewFormats

def generate_document_preview():
    output_dir = "./preview"
    os.makedirs(output_dir, exist_ok=True)

    # Track the open streams so each page's file can be closed after it is written
    open_streams = {}

    def create_page_stream(page_number):
        stream = open(os.path.join(output_dir, f"page_{page_number}.png"), "wb")
        open_streams[page_number] = stream
        return stream

    def release_page_stream(page_number, page_stream):
        stream = open_streams.pop(page_number, None)
        if stream:
            stream.close()

    with Annotator("./sample.pdf") as annotator:
        preview_options = PreviewOptions(create_page_stream, release_page_stream)
        preview_options.preview_format = PreviewFormats.PNG
        preview_options.page_numbers = [1]
        annotator.document.generate_preview(preview_options)

    print(f"Generated page preview image(s) in {output_dir}.")

if __name__ == "__main__":
    generate_document_preview()
```

`PreviewFormats` supports `PNG`, `JPEG`, and `BMP`. Other useful `PreviewOptions` properties include `width`/`height`, `resolution`, `render_comments`, and `render_annotations`.

### Hello, World!
Path: https://reference.groupdocs.com/annotation/python-net/guides/hello-world.md

#### Introduction
A "Hello, World!" example is often the first step when exploring GroupDocs.Annotation for Python via .NET. It serves as a simple test to confirm that your development environment is correctly set up and that the library is functioning as expected.

#### Overview
GroupDocs.Annotation for Python via .NET lets you add annotations, markup, and review comments to a wide range of document and image formats. A wide range of [supported formats](https://docs.groupdocs.com/annotation/python-net/supported-document-formats/) makes it versatile for different use cases.

#### How to annotate a document
The following steps demonstrate how to add an annotation to a document using GroupDocs.Annotation for Python via .NET:

1. Import the `groupdocs.annotation` classes you need.
2. Create an annotation and configure it (here, an area annotation with a yellow fill).
3. Open the document with an `Annotator`, pointing it at the sample file.
4. Add the annotation.
5. Save the result.

#### Complete example
The example below adds a yellow area (rectangle) annotation to the first page of a PDF and saves the annotated document:

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def hello_world():
    # Describe a yellow area (rectangle) annotation on the first page
    area = AreaAnnotation()
    area.box = Rectangle(100, 100, 100, 100)          # x, y, width, height
    area.background_color = Color.yellow.to_argb()     # packed ARGB int, not a Color object
    area.page_number = 0                               # page numbers are 0-based
    area.message = "Welcome to GroupDocs.Annotation!"

    # Open the document, add the annotation, and save the result
    with Annotator("./sample.pdf") as annotator:
        annotator.add(area)
        annotator.save("./output.pdf")

    print("Annotation added successfully. Output saved to ./output.pdf.")

if __name__ == "__main__":
    hello_world()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/getting-started/hello-world/sample.pdf) to download it.

```text
Binary file (PDF)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/getting-started/hello-world/hello_world/output.pdf)

This example writes the annotated document to `output.pdf`. Colors are passed as packed ARGB integers (for example `Color.yellow.to_argb()`), not as `Color` objects, and page numbers are 0-based, so `page_number = 0` targets the first page. To annotate a different format, simply open a file with another extension — the same code works across every [supported format](https://docs.groupdocs.com/annotation/python-net/supported-document-formats/).

#### Additional resources
This demo references the GroupDocs.Annotation for Python via .NET [code samples](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Python-via-.NET/).
</content>
</invoke>

### How to Run Examples
Path: https://reference.groupdocs.com/annotation/python-net/guides/how-to-run-examples.md

Before running an example make sure that GroupDocs.Annotation for Python via .NET has been installed successfully.

The complete examples project for **GroupDocs.Annotation for Python via .NET** is hosted on [GitHub](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Python-via-.NET). It contains standalone, runnable scripts together with the sample documents they use, so the examples work out of the box.

#### Prerequisites

- [Python](https://www.python.org/) 3.5 – 3.14 installed and on your `PATH`.
- [git](https://git-scm.com/) to clone the repository (or download the ZIP).
- On Linux and macOS, the native libraries listed in the [System Requirements](https://docs.groupdocs.com/annotation/python-net/system-requirements/) (`libgdiplus`, `libfontconfig1`, `libicu-dev`, and fonts).
- Optionally, a GroupDocs.Annotation license to remove the [evaluation watermark](https://docs.groupdocs.com/annotation/python-net/licensing-and-subscription/).

#### Get the code

Clone the repository with your favourite git client, or download the ZIP from GitHub:

```bash
git clone https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Python-via-.NET.git
cd GroupDocs.Annotation-for-Python-via-.NET
```

#### Project Structure

The examples live under the `Examples/` folder, organized by topic. Directory names are kebab-case and each script is standalone:

```text
GroupDocs.Annotation-for-Python-via-.NET/
├── Dockerfile
└── Examples/
    ├── requirements.txt
    ├── run_all_examples.py
    ├── licensing/
    │   ├── set_license_from_file.py
    │   ├── set_license_from_stream.py
    │   └── set_metered_license.py
    ├── getting-started/
    │   └── hello-world/
    │       └── hello_world.py
    └── developer-guide/
        ├── basic-usage/
        │   ├── add-annotations/
        │   ├── comments-and-replies/
        │   ├── get-annotations/
        │   ├── get-document-info/
        │   ├── get-supported-file-formats/
        │   └── remove-annotations/
        └── advanced-usage/
            ├── loading-documents/
            └── saving-documents/
```

#### Setup

Create and activate a virtual environment, then install the dependencies listed in `Examples/requirements.txt`:

```ps
py -m venv .venv
.venv\Scripts\activate
py -m pip install -r Examples/requirements.txt
```

```bash
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r Examples/requirements.txt
```

```bash
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r Examples/requirements.txt
```

To run the examples without the evaluation watermark, point the `GROUPDOCS_LIC_PATH` environment variable at your license file. The example scripts read this variable and apply the license automatically:

```ps
$env:GROUPDOCS_LIC_PATH = "C:\path\to\GroupDocs.Annotation.lic"
```

```bash
export GROUPDOCS_LIC_PATH="/path/to/GroupDocs.Annotation.lic"
```

```bash
export GROUPDOCS_LIC_PATH="/path/to/GroupDocs.Annotation.lic"
```

See [Licensing and Evaluation](https://docs.groupdocs.com/annotation/python-net/licensing-and-subscription/) for details on obtaining and applying a license.

#### Run

Run every example at once with the runner script:

```bash
python Examples/run_all_examples.py
```

Or run a single example by passing its path directly:

```bash
python Examples/developer-guide/basic-usage/add-annotations/add_area_annotation.py
```

The repository ships with all the sample documents and resources used by the examples, so the scripts run out of the box.

Without a license the examples run in evaluation mode, which adds a watermark to each output document. There is no document-open limit, so every example completes successfully whether or not a license is applied. The `run_all_examples.py` runner launches each example in its own process and keeps the working directory set to the example's folder, so each script finds its input and output files.

#### Run with Docker

The repository includes a `Dockerfile` that installs the native dependencies and Python packages so you can run the examples in a clean, reproducible container. From the repository root:

```bash
docker build -t groupdocs-annotation-examples .
docker run --rm groupdocs-annotation-examples
```

To use a license inside the container, mount it and pass `GROUPDOCS_LIC_PATH`:

```bash
docker run --rm \
  -v /path/to/GroupDocs.Annotation.lic:/app/GroupDocs.Annotation.lic:ro \
  -e GROUPDOCS_LIC_PATH=/app/GroupDocs.Annotation.lic \
  groupdocs-annotation-examples
```

#### Continuous integration

Because the examples run headlessly and exit with a non-zero status on failure, they fit naturally into a CI pipeline. Install `Examples/requirements.txt`, supply the license through the `GROUPDOCS_LIC_PATH` environment variable (store the license as a protected secret), make sure the Linux native dependencies are present on the runner, and invoke `python Examples/run_all_examples.py` as a build step. The provided `Dockerfile` is a convenient base image for such jobs.

#### Troubleshooting

- **Evaluation watermark on the output** — you are running unlicensed in evaluation mode. Set `GROUPDOCS_LIC_PATH` to a valid license to produce output without the watermark. See [Licensing and Evaluation](https://docs.groupdocs.com/annotation/python-net/licensing-and-subscription/).
- **Missing or substituted fonts** — install fonts so annotated output matches the original: `apt install libfontconfig1 ttf-mscorefonts-installer`.
- **ICU / globalization errors on Linux** — install ICU: `apt install libicu-dev`.
- **`ModuleNotFoundError: No module named 'groupdocs'`** — the package is not installed in the active environment. Activate your virtual environment and re-run `pip install -r Examples/requirements.txt`.

#### Contribute

If you would like to add or improve an example, we encourage you to contribute to the project. All examples in this repository are open source and can be freely used in your own applications. To contribute, fork the repository, edit the code, and create a pull request. We will review the changes and include them if found helpful.
</content>
</invoke>

### Import and export annotations
Path: https://reference.groupdocs.com/annotation/python-net/guides/import-export-annotations.md

GroupDocs.Annotation can serialize a document's annotations to a standalone XML file and load them back into any document. This is useful for transferring a review between copies of a document, storing annotations separately from the source file, or applying the same set of annotations to multiple documents.

- [`export_annotations_to_xml_file(output_path)`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/) — write the open document's annotations to an XML file.
- [`import_annotations_from_xml_file(file_path)`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/) — read annotations from an XML file into the open document.

#### Export annotations to XML

Open an annotated document and write its annotations to an XML file.

```python
from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")

    print("Exported annotations to ./exported_annotations.xml.")

if __name__ == "__main__":
    export_annotations_to_xml()
```

#### Import annotations from XML

Load annotations from an XML file into a document, then save the result.

```python
from groupdocs.annotation import Annotator

def import_annotations_from_xml():
    with Annotator("./sample.pdf") as annotator:
        annotator.import_annotations_from_xml_file(file_path="./annotations.xml")
        annotator.save("./output.pdf")

    print("Imported annotations from ./annotations.xml. Output saved to ./output.pdf.")

if __name__ == "__main__":
    import_annotations_from_xml()
```

### Install GroupDocs.Annotation for Python via .NET
Path: https://reference.groupdocs.com/annotation/python-net/guides/installation.md

GroupDocs.Annotation for Python via .NET is distributed as a pre-built wheel on [PyPI](https://pypi.org/project/groupdocs-annotation-net/). The PyPI index hosts a separate wheel for each supported platform, and `pip` picks the correct one automatically. Each wheel is self-contained: it bundles the embedded runtime and every managed dependency, so no Microsoft Office, OpenOffice, Adobe Acrobat, or separate runtime install is required.

Before installing, confirm your environment matches the supported platforms and Python versions listed in the [System Requirements](https://docs.groupdocs.com/annotation/python-net/system-requirements/) topic.

#### Install Package from PyPI

Open a terminal and run the install command for your platform:

```ps
py -m pip install groupdocs-annotation-net
```

```bash
python3 -m pip install groupdocs-annotation-net
```

```bash
python3 -m pip install groupdocs-annotation-net
```

After running the command you should see output similar to:

```bash
Collecting groupdocs-annotation-net
  Downloading groupdocs_annotation_net-26.6.0-py3-none-win_amd64.whl.metadata (3.0 kB)
  Downloading groupdocs_annotation_net-26.6.0-py3-none-win_amd64.whl (40.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.0/40.0 MB 2.8 MB/s eta 0:00:00
Installing collected packages: groupdocs-annotation-net
Successfully installed groupdocs-annotation-net-26.6.0
```

The wheel file name will include a platform suffix that matches your operating system — for example `manylinux1_x86_64` on Ubuntu/Debian, `macosx_11_0_arm64` on Apple Silicon, or `win_amd64` on 64-bit Windows.

#### Add the Package to `requirements.txt`

For reproducible environments, pin the package version in your `requirements.txt`:

```txt
groupdocs-annotation-net==26.6.0
```

Then install all dependencies in one step:

```bash
pip install -r requirements.txt
```

#### Install from a Pre-Downloaded Wheel

If your build environment cannot reach PyPI, download the appropriate wheel from the [GroupDocs Releases website](https://releases.groupdocs.com/annotation/python-net/) and install it locally. Wheels are published for the following four platforms:

- **Windows 64-bit**: file name ends with `win_amd64.whl`
- **Linux x64 (glibc)**: file name ends with `manylinux1_x86_64.whl`
- **macOS Intel**: file name ends with `macosx_10_14_x86_64.whl`
- **macOS Apple Silicon**: file name ends with `macosx_11_0_arm64.whl`

Place the downloaded wheel into your project folder, then install it:

```ps
py -m pip install ./groupdocs_annotation_net-26.6.0-py3-none-win_amd64.whl
```

```bash
python3 -m pip install ./groupdocs_annotation_net-26.6.0-py3-none-manylinux1_x86_64.whl
```

```bash
python3 -m pip install ./groupdocs_annotation_net-26.6.0-py3-none-macosx_10_14_x86_64.whl
```

```bash
python3 -m pip install ./groupdocs_annotation_net-26.6.0-py3-none-macosx_11_0_arm64.whl
```

Expected output:

```bash
Processing ./groupdocs_annotation_net-26.6.0-py3-none-*.whl
Installing collected packages: groupdocs-annotation-net
Successfully installed groupdocs-annotation-net-26.6.0
```

#### Platform Prerequisites

On Windows no extra steps are required. On Linux and macOS, install the native libraries the rendering engine depends on:

```bash
apt install libgdiplus libfontconfig1 libicu-dev ttf-mscorefonts-installer
```

```bash
brew install mono-libgdiplus
```

The package runs on Windows, Linux, and macOS. On Linux and macOS the native libraries above provide graphics, fonts, and globalization support for the bundled engine; installing fonts (for example `ttf-mscorefonts-installer`) helps annotated output match the original document. See [System Requirements](https://docs.groupdocs.com/annotation/python-net/system-requirements/) for the full list.

#### Verify the Installation

Confirm the package imported correctly:

```bash
python -c "import groupdocs.annotation; print('GroupDocs.Annotation is ready')"
```

You can also list the installed package with `pip show groupdocs-annotation-net` to confirm the version and location.

#### Next Steps

- Follow the [Hello, World!](https://docs.groupdocs.com/annotation/python-net/hello-world/) guide to add your first annotation.
- Read the [Features Overview](https://docs.groupdocs.com/annotation/python-net/features-overview/) to see everything you can annotate.
- Clone the [examples repository](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Python-via-.NET) and read [How to Run Examples](https://docs.groupdocs.com/annotation/python-net/how-to-run-examples/) to try every documented scenario locally.
</content>
</invoke>

### Licensing and evaluation
Path: https://reference.groupdocs.com/annotation/python-net/guides/licensing-and-subscription.md

To explore the system effectively, you may want immediate access to the API. GroupDocs.Annotation simplifies this by offering various purchase plans, along with an evaluation mode and a 30-day Temporary License for evaluation.

To learn more about licensing options, purchasing, and evaluation policies, refer to the [Purchase Policies and FAQ](https://purchase.groupdocs.com/policies) section.

#### Purchased License

After purchasing GroupDocs.Annotation for Python via .NET, you will receive a license file that unlocks the full functionality of the API. A few rules apply:

- Apply the license **only once** per process, in your start-up code.
- Apply it **before** constructing any `Annotator` or other GroupDocs.Annotation object.
- A license can be applied from a file path, from a binary stream (handy when the license is an embedded resource), or as a [Metered License](https://purchase.groupdocs.com/faqs/licensing/metered/) that bills by usage.

Use the [set_license](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/license/set_license/) method to license the component. Calling it more than once is harmless — it simply wastes a little processor time.

##### Set a license from a file

The example below applies a license from a file path. It reads the path from the `GROUPDOCS_LIC_PATH` environment variable and falls back to a local `GroupDocs.Annotation.lic` file:

```python
import os
from groupdocs.annotation import License

def set_license_from_file():
    # Resolve the license path from the environment, with a local fallback
    license_path = os.environ.get("GROUPDOCS_LIC_PATH", "./GroupDocs.Annotation.lic")

    # Apply the license before using any annotation features
    if os.path.exists(license_path):
        License().set_license(license_path=license_path)
        print("License set successfully.")
    else:
        print("License file not found. Running in evaluation mode.")

if __name__ == "__main__":
    set_license_from_file()
```

##### Set a license from a stream

You can also apply a license from any readable binary stream — useful when the license ships as an embedded resource:

```python
import os
from groupdocs.annotation import License

def set_license_from_stream():
    # Resolve the license path from the environment, with a local fallback
    license_path = os.environ.get("GROUPDOCS_LIC_PATH", "./GroupDocs.Annotation.lic")

    # Apply the license from an open binary stream
    if os.path.exists(license_path):
        with open(license_path, "rb") as license_stream:
            License().set_license(license_stream=license_stream)
        print("License set successfully from stream.")
    else:
        print("License file not found. Running in evaluation mode.")

if __name__ == "__main__":
    set_license_from_stream()
```

##### Set a metered license

A Metered License lets you pay for what you use. Set the public and private keys with [set_metered_key](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/metered/set_metered_key/) before using the API, then query consumption at any time:

```python
import os
from groupdocs.annotation import Metered

def set_metered_license():
    # Read the metered public and private keys from the environment
    public_key = os.environ.get("GROUPDOCS_METERED_PUBLIC_KEY", "")
    private_key = os.environ.get("GROUPDOCS_METERED_PRIVATE_KEY", "")

    # Apply the metered keys before using any annotation features
    if public_key and private_key:
        metered = Metered()
        metered.set_metered_key(public_key=public_key, private_key=private_key)
        print("Metered license set successfully.")

        # Query the current metered consumption
        print(f"Consumption quantity: {Metered.get_consumption_quantity()}")
        print(f"Consumption credit: {Metered.get_consumption_credit()}")
    else:
        print("Metered keys not provided. Running in evaluation mode.")

if __name__ == "__main__":
    set_metered_license()
```

##### Changing the license file name

You are not required to keep the license file name as `GroupDocs.Annotation.lic`. You can rename it to any preferred name and use that name when applying the license in your application.

##### "Cannot find license filename" exception

When you download the license from the GroupDocs website it is saved as `GroupDocs.Annotation.lic`. However, some web browsers may automatically append `.xml`, resulting in `GroupDocs.Annotation.lic.xml`.

If your Windows settings are configured to hide file extensions (the default), the file may still appear as `GroupDocs.Annotation.lic` in File Explorer even though the actual name is `GroupDocs.Annotation.lic.xml`. This discrepancy can cause `set_license` to throw an exception. To fix it, manually rename the file to remove the `.xml` extension, or disable "Hide extensions for known file types" in Windows.

#### How to evaluate GroupDocs.Annotation

You can evaluate GroupDocs.Annotation for Python via .NET without purchasing a license. The evaluation version is identical to the purchased one; it becomes fully licensed once you set a license.

##### Evaluation mode

Without a license, GroupDocs.Annotation runs in evaluation mode:

- The API is **fully functional** — you can open documents, add, get, update, and remove annotations, and save the result. Every operation completes successfully and no exception is thrown.
- There is **no limit** on the number of documents you can open in a process and **no cap** on the number of annotations you can add. You can run as many `Annotator` operations as you like, one after another, in the same process.
- An **evaluation watermark** is added to the output document, so the saved file is slightly larger than a licensed one.

To remove the evaluation watermark, apply a purchased or temporary license as shown above.

##### Temporary License

To produce output without the evaluation watermark while you assess the full features of GroupDocs.Annotation, you can request a 30-day ["Temporary License"](https://purchase.groupdocs.com/temporary-license).
</content>
</invoke>

### Loading documents
Path: https://reference.groupdocs.com/annotation/python-net/guides/loading-documents.md

The [`Annotator`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/) class can open a document from a file path or any readable binary stream, including password-protected files. The examples below show each loading scenario.

#### Load from local disk

When the document is on the local disk, pass its path to the `Annotator` constructor.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def load_from_local_disk():
    # Load a document directly from a local file path
    with Annotator("./sample.pdf") as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Loaded from local disk"
        annotator.add(area)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    load_from_local_disk()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/advanced-usage/loading-documents/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/advanced-usage/loading-documents/load_from_local_disk/output.pdf)

#### Load from stream

As an alternative to a local file, pass an open binary stream to the `document` parameter of the `Annotator` constructor.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def load_from_stream():
    # Load a document from an open binary stream
    with open("./sample.pdf", "rb") as stream:
        with Annotator(document=stream) as annotator:
            area = AreaAnnotation()
            area.box = Rectangle(100, 100, 100, 100)
            area.background_color = Color.yellow.to_argb()
            area.page_number = 0
            area.message = "Loaded from stream"
            annotator.add(area)
            annotator.save("./output.pdf")

if __name__ == "__main__":
    load_from_stream()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/advanced-usage/loading-documents/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/advanced-usage/loading-documents/load_from_stream/output.pdf)

#### Load a password-protected file

To open an encrypted document, set the `password` property of [`LoadOptions`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/loadoptions/) and pass it to the `Annotator` through the `load_options` parameter.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import LoadOptions
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def load_password_protected_document():
    # Provide the password through LoadOptions
    load_options = LoadOptions()
    load_options.password = "secret"

    with Annotator("./protected.docx", load_options=load_options) as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Annotated a password-protected document"
        annotator.add(area)
        annotator.save("./output.docx")

if __name__ == "__main__":
    load_password_protected_document()
```

`protected.docx` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/advanced-usage/loading-documents/protected.docx) to download it.

```text
Binary file (DOCX, 10 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/advanced-usage/loading-documents/load_password_protected_document/output.docx)

### Manage annotations
Path: https://reference.groupdocs.com/annotation/python-net/guides/manage-annotations.md

Once a document contains annotations you can read them, remove a single one by its id, or remove them all. The [`Annotator`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation/annotator/) class exposes `get()` to list annotations and `remove(...)` to delete them.

#### Get all annotations

Call `get()` to return the list of annotations stored in the document. Each item exposes common properties such as `id`, `message`, `page_number`, and `replies`.

```python
from groupdocs.annotation import Annotator

def get_all_annotations():
    # Open a document that already contains annotations and list them
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        print(f"Found {len(annotations)} annotation(s):")
        for annotation in annotations:
            print(f"  [{annotation.id}] {type(annotation).__name__}: {annotation.message}")

if __name__ == "__main__":
    get_all_annotations()
```

`annotated.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/manage-annotations/annotated.pdf) to download it.

#### Remove an annotation by id

Pass the `annotation_id` of the annotation you want to delete to `remove(...)`, then save the document.

```python
from groupdocs.annotation import Annotator

def remove_annotation_by_id():
    # Open an annotated document and remove a single annotation by its id
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        if annotations:
            annotator.remove(annotation_id=annotations[0].id)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    remove_annotation_by_id()
```

`annotated.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/manage-annotations/annotated.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/manage-annotations/remove_annotation_by_id/output.pdf)

#### Remove all annotations

To clear every annotation, read the list with `get()` and pass it to `remove(...)` through the `annotations_to_delete` parameter.

```python
from groupdocs.annotation import Annotator

def remove_all_annotations():
    # Open an annotated document and remove every annotation
    with Annotator("./annotated.pdf") as annotator:
        annotations = annotator.get()
        if annotations:
            annotator.remove(annotations_to_delete=annotations)
        annotator.save("./output.pdf")

if __name__ == "__main__":
    remove_all_annotations()
```

`annotated.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/basic-usage/manage-annotations/annotated.pdf) to download it.

```text
Binary file (PDF, 88 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/basic-usage/manage-annotations/remove_all_annotations/output.pdf)

### GroupDocs.Annotation for Python via .NET Overview
Path: https://reference.groupdocs.com/annotation/python-net/guides/product-overview.md

#### What is GroupDocs.Annotation?

GroupDocs.Annotation for Python via .NET is a native Python library that **adds, edits, and removes annotations and markup** on documents — across PDF, Microsoft Word, Excel, PowerPoint, images, CAD, Visio, and email formats — through a single, format-independent API. It runs entirely on-premise, requires no Microsoft Office or Adobe Acrobat installation, and ships as a pre-built wheel on Windows, Linux, and macOS.

Typical uses include:

- **Document review & collaboration** — add area, shape, and text-markup annotations and attach threaded reviewer comments so teams can discuss a document in place.
- **Legal & contract markup** — highlight clauses, strike out obsolete text, and flag regions that need attention before a document is signed or shared.
- **Engineering & design review** — annotate CAD drawings and Visio diagrams with area, arrow, and distance markups.
- **Content & e-learning feedback** — mark up images and scanned pages with points, watermarks, and image stamps.
- **Automated annotation pipelines** — stamp watermarks, links, and notes across many documents and save only the annotation types or page ranges you need.

#### Key Capabilities

| Capability | Description |
|---|---|
| **Shape Annotations** | Draw area, ellipse, arrow, point, distance, and polyline annotations with configurable color and opacity. |
| **Text Markup** | Highlight, underline, strikeout, and squiggly-mark text, plus replacement, text-redaction, and resources-redaction annotations. |
| **Content Annotations** | Stamp watermarks, image annotations, hyperlinks, and editable text fields onto a document. |
| **Comments & Replies** | Attach threaded review comments — with user and timestamp — to any annotation. |
| **Manage Annotations** | List, update, and remove annotations, all of them or filtered by annotation type. |
| **Save Filters** | Render only selected annotation types, or a specific page range, when saving the result. |
| **Document Inspection** | Read file type, page count, and size without modifying the document. |

Every capability is covered with runnable, copy-paste examples in the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/).

#### Quick Example

Add an annotation and save the result with just a few lines of code. The example draws a yellow area annotation on the first page of `sample.pdf` and writes the result to `annotated.pdf`:

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color

def annotate_area():
    # Open the document
    with Annotator("./sample.pdf") as annotator:
        # Build an area annotation on the first page
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 200, 80)        # x, y, width, height
        area.page_number = 0                            # 0-based page index
        area.background_color = Color.yellow.to_argb()  # ARGB int, not a Color object
        area.message = "Review this section"
        annotator.add(area)
        # Save the annotated document
        annotator.save("./annotated.pdf")

if __name__ == "__main__":
    annotate_area()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/product-overview/sample.pdf) to download it.

```text
Binary file (PDF, 1.0 MB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/product-overview/annotate_area/annotated.pdf)

For richer review workflows, add several annotations, attach a comment thread, and save only the area annotations with a page-range filter using `SaveOptions`:

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, Point, Reply
from groupdocs.annotation.models.annotation_models import AreaAnnotation, HighlightAnnotation
from groupdocs.annotation.options import SaveOptions, AnnotationType
from groupdocs.pydrawing import Color

def annotate_with_options():
    with Annotator("./sample.pdf") as annotator:
        # An area annotation carrying a threaded review comment
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 200, 80)
        area.page_number = 0
        area.background_color = Color.yellow.to_argb()
        area.message = "Please review"
        reply = Reply()
        reply.comment = "Confirmed, looks good"
        area.replies = [reply]

        # A text highlight described by a quad of points
        highlight = HighlightAnnotation()
        highlight.page_number = 0
        highlight.font_color = Color.lime.to_argb()
        highlight.points = [Point(80, 730), Point(240, 730), Point(240, 750), Point(80, 750)]

        annotator.add([area, highlight])

        # Render only area annotations, and only the first page
        options = SaveOptions()
        options.annotation_types = AnnotationType.AREA
        options.first_page = 1      # SaveOptions pages are 1-based
        options.last_page = 1
        annotator.save("./annotated.pdf", save_options=options)

if __name__ == "__main__":
    annotate_with_options()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/product-overview/sample.pdf) to download it.

```text
Binary file (PDF, 1.0 MB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/product-overview/annotate_with_options/annotated.pdf)

#### Where to next

1. **Install the package** — [Installation](https://docs.groupdocs.com/annotation/python-net/getting-started/installation/) walks through PyPI and offline wheel installation for Windows, Linux, and macOS.
2. **Run your first annotation** — [Hello, World!](https://docs.groupdocs.com/annotation/python-net/getting-started/hello-world/) annotates a document in under five minutes.
3. **Explore runnable examples** — [How to Run Examples](https://docs.groupdocs.com/annotation/python-net/getting-started/how-to-run-examples/) clones the GitHub repository and runs every documented scenario locally or in Docker.
4. **Use it in depth** — the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/) covers every API surface with runnable, copy-paste code examples.
5. **Plug it into AI pipelines** — [AI Agents & LLM Integration]() explains the bundled `AGENTS.md`, the MCP server, and machine-readable docs.
</content>

### Saving documents
Path: https://reference.groupdocs.com/annotation/python-net/guides/saving-documents.md

By default `save()` writes every annotation back into the document. With [`SaveOptions`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/saveoptions/) you can persist only certain annotation types or limit the output to a range of pages. Pass the configured `SaveOptions` to `save()` through the `save_options` parameter.

#### Save specific annotation types

Set `annotation_types` to an [`AnnotationType`](https://reference.groupdocs.com/annotation/python-net/groupdocs.annotation.options/annotationtype/) value to write only annotations of that type, even if the document contains others.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation, EllipseAnnotation
from groupdocs.annotation.options import SaveOptions, AnnotationType
from groupdocs.pydrawing import Color

def save_specific_annotation_types():
    with Annotator("./sample.pdf") as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Area"

        ellipse = EllipseAnnotation()
        ellipse.box = Rectangle(100, 250, 150, 80)
        ellipse.background_color = Color.from_argb(255, 144, 238, 144).to_argb()
        ellipse.page_number = 0
        ellipse.message = "Ellipse"

        annotator.add(area)
        annotator.add(ellipse)

        # Persist only the area annotations
        save_options = SaveOptions()
        save_options.annotation_types = AnnotationType.AREA
        annotator.save("./output.pdf", save_options=save_options)

if __name__ == "__main__":
    save_specific_annotation_types()
```

`sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/advanced-usage/saving-documents/sample.pdf) to download it.

```text
Binary file (PDF, 90 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/advanced-usage/saving-documents/save_specific_annotation_types/output.pdf)

#### Save a page range

Set `first_page` and `last_page` to write only a range of pages. These values are **1-based** — page `1` is the first page.

```python
from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.annotation.options import SaveOptions
from groupdocs.pydrawing import Color

def save_specific_pages():
    with Annotator("./multipage_sample.pdf") as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Page 1 annotation"
        annotator.add(area)

        # first_page / last_page are 1-based for SaveOptions
        save_options = SaveOptions()
        save_options.first_page = 1
        save_options.last_page = 2
        annotator.save("./output.pdf", save_options=save_options)

if __name__ == "__main__":
    save_specific_pages()
```

`multipage_sample.pdf` is the sample file used in this example. Click [here](https://docs.groupdocs.com/annotation/python-net/_sample_files/developer-guide/advanced-usage/saving-documents/multipage_sample.pdf) to download it.

```text
Binary file (PDF, 92 KB)
```
[Download full output](https://docs.groupdocs.com/annotation/python-net/_output_files/developer-guide/advanced-usage/saving-documents/save_specific_pages/output.pdf)

### Showcases
Path: https://reference.groupdocs.com/annotation/python-net/guides/showcases.md

Want to try GroupDocs.Annotation for Python via .NET by yourself? Explore the Python code examples, the real-world use cases below, and the free online demonstration to learn more about the document annotation features.

#### GitHub Examples

To get started with GroupDocs.Annotation for Python via .NET, explore the runnable code examples on GitHub. The repository provides standalone scripts that showcase every documented capability — shape annotations, text markup, watermarks, image and link stamps, comments and replies, as well as loading documents, listing and removing annotations, and saving with page-range and annotation-type filters.

[GroupDocs.Annotation for Python via .NET GitHub Repository](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Python-via-.NET)

See [How to Run Examples](https://docs.groupdocs.com/annotation/python-net/getting-started/how-to-run-examples/) to set up the project and run everything locally, and the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/) for step-by-step explanations.

#### Use cases

GroupDocs.Annotation fits a wide range of document-review and markup scenarios:

- **Document review & collaboration** — add area, ellipse, arrow, and text-markup annotations, then attach threaded reviewer comments so teams can discuss a document in place before it is finalized. See the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/).

- **Legal & contract markup** — highlight key clauses, strike out obsolete language, and flag regions that need attention with area annotations and notes, keeping the original document format intact. See the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/).

- **Engineering, CAD & Visio review** — annotate technical drawings and diagrams with area, arrow, and distance markups, and stamp watermarks or image annotations onto pages for sign-off. See the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/).

- **Automated annotation pipelines** — programmatically stamp watermarks, hyperlinks, and notes across many documents in an automated workflow, then save only the annotation types or page ranges you need. See the [Developer Guide](https://docs.groupdocs.com/annotation/python-net/developer-guide/).

#### Online Demo

To experience GroupDocs.Annotation without any installation, try the free online annotation app. It lets you upload a document, add annotations, and download the annotated result right in your browser:

[Free Online Document Annotation App](https://products.groupdocs.app/annotation)

The online demo is a convenient way to evaluate the library's capabilities in a real-world environment and decide whether it fits your document-review and markup needs.
</content>

### Supported Document Formats
Path: https://reference.groupdocs.com/annotation/python-net/guides/supported-document-formats.md

#### Supported File Formats

The following tables list the file formats that GroupDocs.Annotation for Python via .NET can open, annotate, and save. You can add annotations, markup, and review comments to any of the formats below.

##### Word Processing

| Format | Description |
| --- | --- |
| [DOC](https://docs.fileformat.com/word-processing/doc/) | Microsoft Word 97-2007 Document |
| [DOCX](https://docs.fileformat.com/word-processing/docx/) | Office Open XML WordprocessingML Document (macro-free) |
| [DOCM](https://docs.fileformat.com/word-processing/docm/) | Office Open XML WordprocessingML Macro-Enabled Document |
| [DOT](https://docs.fileformat.com/word-processing/dot/) | Microsoft Word 97-2007 Template |
| [DOTX](https://docs.fileformat.com/word-processing/dotx/) | Office Open XML WordprocessingML Template (macro-free) |
| [DOTM](https://docs.fileformat.com/word-processing/dotm/) | Office Open XML WordprocessingML Macro-Enabled Template |
| [RTF](https://docs.fileformat.com/word-processing/rtf/) | Rich Text Format |
| [ODT](https://docs.fileformat.com/word-processing/odt/) | OpenDocument Text Document |

##### Spreadsheets

| Format | Description |
| --- | --- |
| [XLS](https://docs.fileformat.com/spreadsheet/xls/) | Excel Workbook 97-2003 |
| [XLSX](https://docs.fileformat.com/spreadsheet/xlsx/) | Office Open XML Workbook (2007 and later) |
| [XLSM](https://docs.fileformat.com/spreadsheet/xlsm/) | Office Open XML Macro-Enabled Workbook |
| [XLSB](https://docs.fileformat.com/spreadsheet/xlsb/) | Excel Binary Workbook |
| [ODS](https://docs.fileformat.com/spreadsheet/ods/) | OpenDocument Spreadsheet |

##### Presentations

| Format | Description |
| --- | --- |
| [PPT](https://docs.fileformat.com/presentation/ppt/) | PowerPoint Presentation 97-2003 |
| [PPTX](https://docs.fileformat.com/presentation/pptx/) | Office Open XML Presentation |
| [PPS](https://docs.fileformat.com/presentation/pps/) | PowerPoint Slide Show 97-2003 |
| [PPSX](https://docs.fileformat.com/presentation/ppsx/) | Office Open XML Slide Show |
| [ODP](https://docs.fileformat.com/presentation/odp/) | OpenDocument Presentation |

##### Portable Documents

| Format | Description |
| --- | --- |
| [PDF](https://docs.fileformat.com/pdf/) | Adobe Portable Document Format |

##### Images

| Format | Description |
| --- | --- |
| [TIF/TIFF](https://docs.fileformat.com/image/tiff/) | Tagged Image File Format |
| [JPG/JPEG](https://docs.fileformat.com/image/jpeg/) | Joint Photographic Experts Group image |
| [PNG](https://docs.fileformat.com/image/png/) | Portable Network Graphics image |
| [BMP](https://docs.fileformat.com/image/bmp/) | Bitmap image file |

##### CAD

| Format | Description |
| --- | --- |
| [DWG](https://docs.fileformat.com/cad/dwg/) | AutoCAD Drawing Database file |
| [DXF](https://docs.fileformat.com/cad/dxf/) | AutoCAD Drawing Exchange Format |

##### Diagrams

| Format | Description |
| --- | --- |
| [VSD](https://docs.fileformat.com/visio/vsd/) | Microsoft Visio Drawing |
| [VSDX](https://docs.fileformat.com/visio/vsdx/) | Microsoft Visio 2013 Drawing |
| [VSDM](https://docs.fileformat.com/visio/vsdm/) | Visio Macro-Enabled Drawing |
| [VSS](https://docs.fileformat.com/visio/vss/) | Visio Stencil |
| [VSX](https://docs.fileformat.com/visio/vsx/) | Visio Stencil XML |
| [VSSX](https://docs.fileformat.com/visio/vssx/) | Visio 2013 Stencil |
| [VST](https://docs.fileformat.com/visio/vst/) | Visio Drawing Template |
| [VSTM](https://docs.fileformat.com/visio/vstm/) | Visio Macro-Enabled Drawing Template |

##### Email

| Format | Description |
| --- | --- |
| [EML](https://docs.fileformat.com/email/eml/) | E-mail message file |
| [EMLX](https://docs.fileformat.com/email/emlx/) | Apple Mail message file |

##### Web

| Format | Description |
| --- | --- |
| [HTM/HTML](https://docs.fileformat.com/web/html/) | HyperText Markup Language document |

**Can't find your file format?**

We're here to help! Please post a request on our [Free Support Forum](https://forum.groupdocs.com/c/annotation/), and our team will assist you.

</content>
</invoke>

### System Requirements
Path: https://reference.groupdocs.com/annotation/python-net/guides/system-requirements.md

GroupDocs.Annotation for Python via .NET operates independently of external software like Microsoft Word, Excel, PowerPoint, or Adobe Acrobat. To install it, simply follow one of the methods described in the [Installation](https://docs.groupdocs.com/annotation/python-net/installation/) section.

#### Overview

GroupDocs.Annotation for Python via .NET does not require Microsoft Office, OpenOffice, Adobe Acrobat, or any other external software to be installed. The package is a self-contained wheel that bundles everything it needs, so the only prerequisites are a supported version of Python and the operating-system packages listed below.

#### Supported Python Versions

GroupDocs.Annotation for Python via .NET supports the following Python versions:

* Python 3.5
* Python 3.6
* Python 3.7
* Python 3.8
* Python 3.9
* Python 3.10
* Python 3.11
* Python 3.12
* Python 3.13
* Python 3.14

#### Supported Operating Systems

The package is distributed as a self-contained wheel that runs on the following platforms:

##### Windows

* Windows x64

No additional dependencies are required on Windows.

##### Linux

* Linux x64

On Linux you need to install a few system packages for graphics, fonts, and globalization:

```bash
apt install libgdiplus libfontconfig1 libicu-dev ttf-mscorefonts-installer
```

##### macOS

* macOS x64 (Intel)
* macOS ARM64 (Apple Silicon)

On macOS install the graphics library via Homebrew:

```bash
brew install mono-libgdiplus
```

#### No Third-Party Software Required

Unlike many document-processing tools, GroupDocs.Annotation for Python via .NET does not depend on Microsoft Office, OpenOffice, Adobe Acrobat, or any other application being installed on the machine. All loading, annotating, and saving of Word Processing documents, Spreadsheets, Presentations, PDFs, images, and the other [supported formats](https://docs.groupdocs.com/annotation/python-net/supported-document-formats/) is performed entirely by the bundled engine.
</content>
</invoke>

### Technical Support
Path: https://reference.groupdocs.com/annotation/python-net/guides/technical-support.md

GroupDocs provides unlimited free technical support for all of its products. Support is available to all users, including evaluation. The support is provided at the [Free Support Forum](https://forum.groupdocs.com/) and the [Paid Support Helpdesk](https://helpdesk.groupdocs.com/).

Please note that GroupDocs does not provide technical support over the phone. Phone support is only available for sales and purchase questions.

#### GroupDocs Free Support Forum

If you need help with GroupDocs.Annotation, consider the following:

* Make sure you are using the latest GroupDocs.Annotation version before reporting an issue. See [PyPI](https://pypi.org/project/groupdocs-annotation-net) to find out about the latest version.
* Have a look through the forums, this documentation, and the [API Reference](https://reference.groupdocs.com/annotation/python-net/) before reporting an issue – perhaps your question has already been answered.
* Post your question at the [GroupDocs.Annotation Free Support Forum](https://forum.groupdocs.com/c/annotation), and we'll assist you. Questions are answered directly by the GroupDocs.Annotation development team.
* When expecting a reply on the forums, please allow for time zone differences.

#### Paid Support Helpdesk

Paid support issues have higher priority compared to free support requests.

* Post your question at the [Paid Support Helpdesk](https://helpdesk.groupdocs.com/) to set a higher priority for the issue.

#### Report an Issue or Feature Request

When posting your issue, question, or feature request with GroupDocs.Annotation, follow these simple steps to make sure it is resolved in the most efficient way:

* Include the original document and, if possible, the code snippet that is causing the problem. If you need to attach a few files, zip them into one. It is safe to attach your documents to the GroupDocs forums because only you and the GroupDocs developers will have access to the attached files.
* Add information about the environment you are facing the issue in — operating system, Python version, and GroupDocs.Annotation version.
* Try to report one issue per thread. If you have another issue, question, or feature request, please report it in a separate thread.
</content>


# GroupDocs.Assembly

> Generate documents and reports from templates and data using LINQ syntax.

## Java

### GroupDocs.Assembly for Java
Path: https://reference.groupdocs.com/assembly/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.assembly | Provides classes for generating documents in popular office file formats based upon template documents and data obtained from various sources including databases, XML, JSON, OData, objects of custom Java types, and more. |
| com.groupdocs.assembly.system | Provides types mimicking .NET types of the `System` namespace in Java. |
| com.groupdocs.assembly.system.data | Provides types mimicking .NET types of the `System.Data` namespace in Java. |
| com.groupdocs.assembly.system.data.common | Provides types mimicking .NET types of the `System.Data.Common` namespace in Java. |
| com.groupdocs.assembly.system.drawing | Provides types mimicking .NET types of the `System.Drawing` namespace in Java. |

### com.groupdocs.assembly.system.data.common
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data.common.md

Provides types mimicking .NET types of the `System.Data.Common` namespace in Java.

#### Classes

| Class | Description |
| --- | --- |
| DbDataReader |  |

### DbDataReader
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data.common/dbdatareader.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.assembly.system.data.IDataReader, com.groupdocs.assembly.system.data.IDataRecord, java.lang.Iterable
```
public abstract class DbDataReader implements IDataReader, IDataRecord, Iterable
```
#### Constructors

| Constructor | Description |
| --- | --- |
| DbDataReader() |  |
#### Methods

| Method | Description |
| --- | --- |
| get(String columnName) |  |
##### DbDataReader()
```
public DbDataReader()
```

##### get(String columnName)
```
public abstract Object get(String columnName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String |  |

**Returns:**
java.lang.Object

### com.groupdocs.assembly.system.data
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data.md

Provides types mimicking .NET types of the `System.Data` namespace in Java.

#### Classes

| Class | Description |
| --- | --- |
| Constraint | Represents a constraint that can be enforced on one or more DataColumn objects. |
| ConstraintCollection | Represents a collection of constraints for a DataTable. |
| ConstraintException | Represents the exception that is thrown when attempting an action that violates a constraint. |
| DBNull |  |
| DataColumn | Represents the schema of a column in a DataTable. |
| DataColumnCollection | Represents a collection of DataColumn objects for a DataTable. |
| DataException | Represents the exception that is thrown when errors are generated using ADO.NET components. |
| DataKey |  |
| DataRelation | Represents a parent/child relationship between two DataTable objects. |
| DataRelationCollection | Represents the collection of DataRelation objects for this DataSet. |
| DataRow | Represents a row of data in a DataTable. |
| DataRowCollection | Represents a collection of rows for a DataTable. |
| DataRowState | Specifies the state of a DataRow object. |
| DataRowView | Represents a customized view of a DataRow. |
| DataSet | Represents an in-memory cache of data. |
| DataTable | Represents one table of in-memory data. |
| DataTableCollection | Represents the collection of tables for the DataSet. |
| DataTableReader | The DataTableReader obtains the contents of one or more DataTable objects in the form of one or more read-only, forward-only result sets. |
| DataView | Represents a databindable, customized view of a DataTable for sorting, filtering, searching, editing, and navigation. |
| ForeignKeyConstraint | Represents an action restriction enforced on a set of columns in a primary key/foreign key relationship when a value or row is either deleted or updated. |
| InvalidConstraintException | Represents the exception that is thrown when incorrectly trying to create or access a relation. |
| MappingType | A utility class providing constants. |
| UniqueConstraint | Represents a restriction on a set of columns in which all values must be unique. |

#### Interfaces

| Interface | Description |
| --- | --- |
| DataTableEventListener |  |
| IDataReader | Provides a means of reading one or more forward-only streams of result sets obtained by executing a command at a data source, and is implemented by .NET Framework data providers that access relational databases. |
| IDataRecord | Provides access to the column values within each row for a DataReader, and is implemented by .NET Framework data providers that access relational databases. |

#### Enumerations

| Enum | Description |
| --- | --- |
| Rule | A utility class providing constants. |
| XmlReadMode | A utility class providing constants. |

### Constraint
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/constraint.md

**Inheritance:**
java.lang.Object
```
public abstract class Constraint
```

Represents a constraint that can be enforced on one or more DataColumn objects.
#### Constructors

| Constructor | Description |
| --- | --- |
| Constraint() |  |
#### Methods

| Method | Description |
| --- | --- |
| getConstraintName() | The name of a constraint in the ConstraintCollection. |
| setConstraintName(String value) | The name of a constraint in the ConstraintCollection. |
##### Constraint()
```
public Constraint()
```

##### getConstraintName()
```
public String getConstraintName()
```

The name of a constraint in the ConstraintCollection.

**Returns:**
java.lang.String - The name of the Constraint.
##### setConstraintName(String value)
```
public void setConstraintName(String value)
```

The name of a constraint in the ConstraintCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the Constraint. |

### ConstraintCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/constraintcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public final class ConstraintCollection implements Iterable
```

Represents a collection of constraints for a DataTable.
#### Methods

| Method | Description |
| --- | --- |
| get(String name) | Gets the Constraint from the collection with the specified name. |
| get(int index) | Gets the Constraint from the collection at the specified index. |
| add(Constraint constraint) | Adds the specified Constraint object to the collection. |
| remove(Constraint constraint) | Removes the specified Constraint from the collection. |
| contains(Constraint cc) | Indicates whether the Constraint object specified by name exists in the collection. |
| getCount() | Gets the total number of elements in a collection. |
| iterator() |  |
##### get(String name)
```
public final Constraint get(String name)
```

Gets the Constraint from the collection with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The Constraint.getConstraintName() / Constraint.setConstraintName(java.lang.String) of the constraint to return. |

**Returns:**
Constraint - The Constraint with the specified name; otherwise a null value if the Constraint does not exist.
##### get(int index)
```
public final Constraint get(int index)
```

Gets the Constraint from the collection at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of the constraint to return. |

**Returns:**
Constraint - The Constraint at the specified index.
##### add(Constraint constraint)
```
public final void add(Constraint constraint)
```

Adds the specified Constraint object to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| constraint | Constraint | The Constraint to add. |

##### remove(Constraint constraint)
```
public final void remove(Constraint constraint)
```

Removes the specified Constraint from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| constraint | Constraint | The Constraint to remove. |

##### contains(Constraint cc)
```
public final boolean contains(Constraint cc)
```

Indicates whether the Constraint object specified by name exists in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cc | Constraint | The Constraint to remove. |

**Returns:**
boolean - true if the collection contains the specified constraint; otherwise, false.
##### getCount()
```
public final int getCount()
```

Gets the total number of elements in a collection.

**Returns:**
int - The total number of elements in a collection.
##### iterator()
```
public final Iterator iterator()
```

**Returns:**
java.util.Iterator

### ConstraintException
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/constraintexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, java.lang.IllegalStateException
```
public final class ConstraintException extends IllegalStateException
```

Represents the exception that is thrown when attempting an action that violates a constraint.
#### Constructors

| Constructor | Description |
| --- | --- |
| ConstraintException(String s) | Initializes a new instance of the ConstraintException class with the specified string. |
##### ConstraintException(String s)
```
public ConstraintException(String s)
```

Initializes a new instance of the ConstraintException class with the specified string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| s | java.lang.String | The string to display when the exception is thrown. |

### DataColumn
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datacolumn.md

**Inheritance:**
java.lang.Object
```
public final class DataColumn
```

Represents the schema of a column in a DataTable.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataColumn() | Initializes a new instance of a DataColumn class as type string. |
| DataColumn(String columnName) | Inititalizes a new instance of the DataColumn class, as type string, using the specified column name. |
| DataColumn(String name, DataTable table) | Initializes a new instance of the @\{link DataColumn\} class using the specified column name and table it belongs to. |
| DataColumn(String columnName, Class dataType) | Inititalizes a new instance of the DataColumn class using the specified column name and data type. |
| DataColumn(String name, Class type, DataTable table) | Initializes a new instance of the DataColumn class using the specified column name, data type and data table it belongs to. |
#### Methods

| Method | Description |
| --- | --- |
| getColumnName() | Gets the name of the column in the DataColumnCollection. |
| setColumnName(String value) | Sets the name of the column in the DataColumnCollection. |
| getAllowDBNull() | Gets a value that indicates whether null values are allowed in this column for rows that belong to the table. |
| setAllowDBNull(boolean value) | Sets a value that indicates whether null values are allowed in this column for rows that belong to the table. |
| getDataType() | Gets the type of data stored in the column. |
| setDataType(Class value) | Sets the type of data stored in the column. |
| setDefaultValue(Object value) | Sets the default value for the column when you are creating new rows. |
| getDefaultValue() | Gets the default value for the column when you are creating new rows. |
| getOrdinal() | Gets the position of the column in the DataColumnCollection collection. |
| setOrdinal(int ordinal) | Changes the ordinal or position of the DataColumn to the specified ordinal or position. |
| getColumnMapping() | Gets the MappingType of the column. |
| setColumnMapping(int value) | Sets the MappingType of the column. |
| getNamespace() | Gets the namespace of the DataColumn. |
| setNamespace(String value) | Sets the namespace of the DataColumn. |
| getPrefix() | Gets an XML prefix that aliases the namespace of the DataTable. |
| setPrefix(String value) | Sets an XML prefix that aliases the namespace of the DataTable. |
| getTable() | Gets the DataTable to which the column belongs to. |
| getAutoIncrement() | Gets a value that indicates whether the column automatically increments the value of the column for new rows added to the table. |
| setAutoIncrement(boolean value) | Sets a value that indicates whether the column automatically increments the value of the column for new rows added to the table. |
| setMaxLength(int value) | Sets the maximum length of a text column. |
| getMaxLength() | Gets the maximum length of a text column. |
| getCaption() | Gets the caption for the column. |
| setCaption(String value) | Sets the caption for the column. |
| getAutoIncrementSeed() | Gets the starting value for a column that has its getAutoIncrement() / setAutoIncrement(boolean) property set to true. |
| setAutoIncrementSeed(long value) | Sets the starting value for a column that has its getAutoIncrement() / setAutoIncrement(boolean) property set to true. |
| getAutoIncrementStep() | Gets the increment used by a column with its getAutoIncrement() / setAutoIncrement(boolean) property set to true. |
| setAutoIncrementStep(long value) | Sets the increment used by a column with its getAutoIncrement() / setAutoIncrement(boolean) property set to true. |
| setReadOnly(boolean value) | Sets a value that indicates whether the column allows for changes as soon as a row has been added to the table. |
| isReadOnly() |  |
| getReadOnly() | Gets a value that indicates whether the column allows for changes as soon as a row has been added to the table. |
| getUnique() | Gets a value that indicates whether the values in each row of the column must be unique. |
| isUnique() |  |
| setUnique(boolean value) | Sets a value that indicates whether the values in each row of the column must be unique. |
| getExpression() | Gets the expression used to filter rows, calculate the values in a column, or create an aggregate column. |
| areColumnSetsTheSame(DataColumn[] columnSet, DataColumn[] compareSet) |  |
| toString() | Gets the getExpression() of the column, if one exists. |
##### DataColumn()
```
public DataColumn()
```

Initializes a new instance of a DataColumn class as type string.

##### DataColumn(String columnName)
```
public DataColumn(String columnName)
```

Inititalizes a new instance of the DataColumn class, as type string, using the specified column name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | A string that represents the name of the column to be created. If set to null or an empty string (""), a default name will be specified when added to the columns collection. |

##### DataColumn(String name, DataTable table)
```
public DataColumn(String name, DataTable table)
```

Initializes a new instance of the @\{link DataColumn\} class using the specified column name and table it belongs to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | name of the DataColumn |
| table | DataTable | the table this column belongs to |

##### DataColumn(String columnName, Class dataType)
```
public DataColumn(String columnName, Class dataType)
```

Inititalizes a new instance of the DataColumn class using the specified column name and data type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | A string that represents the name of the column to be created. If set to null or an empty string (""), a default name will be specified when added to the columns collection. |
| dataType | java.lang.Class | A supported getDataType() / setDataType(java.lang.Class). |

##### DataColumn(String name, Class type, DataTable table)
```
public DataColumn(String name, Class type, DataTable table)
```

Initializes a new instance of the DataColumn class using the specified column name, data type and data table it belongs to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | name of the DataColumn |
| type | java.lang.Class | data type |
| table | DataTable | the table this column belongs to |

##### getColumnName()
```
public final String getColumnName()
```

Gets the name of the column in the DataColumnCollection.

**Returns:**
java.lang.String - The name of the column.
##### setColumnName(String value)
```
public final void setColumnName(String value)
```

Sets the name of the column in the DataColumnCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the column. |

##### getAllowDBNull()
```
public final boolean getAllowDBNull()
```

Gets a value that indicates whether null values are allowed in this column for rows that belong to the table.

**Returns:**
boolean - true if null values values are allowed; otherwise, false. The default is true.
##### setAllowDBNull(boolean value)
```
public final void setAllowDBNull(boolean value)
```

Sets a value that indicates whether null values are allowed in this column for rows that belong to the table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if null values values are allowed; otherwise, false. The default is true. |

##### getDataType()
```
public final Class getDataType()
```

Gets the type of data stored in the column.

**Returns:**
java.lang.Class - A java.lang.Class object that represents the column data type.
##### setDataType(Class value)
```
public final void setDataType(Class value)
```

Sets the type of data stored in the column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Class | A java.lang.Class object that represents the column data type. |

##### setDefaultValue(Object value)
```
public final void setDefaultValue(Object value)
```

Sets the default value for the column when you are creating new rows.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | A value appropriate to the column's getDataType() / setDataType(java.lang.Class). |

##### getDefaultValue()
```
public final Object getDefaultValue()
```

Gets the default value for the column when you are creating new rows.

**Returns:**
java.lang.Object - A value appropriate to the column's getDataType() / setDataType(java.lang.Class).
##### getOrdinal()
```
public final int getOrdinal()
```

Gets the position of the column in the DataColumnCollection collection.

**Returns:**
int - The position of the column. Gets -1 if the column is not a member of a collection.
##### setOrdinal(int ordinal)
```
public final void setOrdinal(int ordinal)
```

Changes the ordinal or position of the DataColumn to the specified ordinal or position.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ordinal | int | The specified ordinal. |

##### getColumnMapping()
```
public final int getColumnMapping()
```

Gets the MappingType of the column.

**Returns:**
int - One of the MappingType values. The returned value is one of MappingType constants.
##### setColumnMapping(int value)
```
public final void setColumnMapping(int value)
```

Sets the MappingType of the column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | One of the MappingType values. The value must be one of MappingType constants. |

##### getNamespace()
```
public final String getNamespace()
```

Gets the namespace of the DataColumn.

**Returns:**
java.lang.String - The namespace of the DataColumn.
##### setNamespace(String value)
```
public final void setNamespace(String value)
```

Sets the namespace of the DataColumn.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The namespace of the DataColumn. |

##### getPrefix()
```
public final String getPrefix()
```

Gets an XML prefix that aliases the namespace of the DataTable.

**Returns:**
java.lang.String - The XML prefix for the DataTable namespace.
##### setPrefix(String value)
```
public final void setPrefix(String value)
```

Sets an XML prefix that aliases the namespace of the DataTable.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The XML prefix for the DataTable namespace. |

##### getTable()
```
public final DataTable getTable()
```

Gets the DataTable to which the column belongs to.

**Returns:**
DataTable - The DataTable that the DataColumn belongs to.
##### getAutoIncrement()
```
public final boolean getAutoIncrement()
```

Gets a value that indicates whether the column automatically increments the value of the column for new rows added to the table.

**Returns:**
boolean - true if the value of the column increments automatically; otherwise, false. The default is false.
##### setAutoIncrement(boolean value)
```
public final void setAutoIncrement(boolean value)
```

Sets a value that indicates whether the column automatically increments the value of the column for new rows added to the table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the value of the column increments automatically; otherwise, false. The default is false. |

##### setMaxLength(int value)
```
public final void setMaxLength(int value)
```

Sets the maximum length of a text column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum length of the column in characters. If the column has no maximum length, the value is -1 (default). |

##### getMaxLength()
```
public final int getMaxLength()
```

Gets the maximum length of a text column.

**Returns:**
int - The maximum length of the column in characters. If the column has no maximum length, the value is -1 (default).
##### getCaption()
```
public final String getCaption()
```

Gets the caption for the column.

**Returns:**
java.lang.String - The caption of the column. If not set, returns the getColumnName() / setColumnName(java.lang.String) value.
##### setCaption(String value)
```
public final void setCaption(String value)
```

Sets the caption for the column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The caption of the column. If not set, returns the getColumnName() / setColumnName(java.lang.String) value. |

##### getAutoIncrementSeed()
```
public final long getAutoIncrementSeed()
```

Gets the starting value for a column that has its getAutoIncrement() / setAutoIncrement(boolean) property set to true.

**Returns:**
long - The starting value for the getAutoIncrement() / setAutoIncrement(boolean) feature.
##### setAutoIncrementSeed(long value)
```
public final void setAutoIncrementSeed(long value)
```

Sets the starting value for a column that has its getAutoIncrement() / setAutoIncrement(boolean) property set to true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The starting value for the getAutoIncrement() / setAutoIncrement(boolean) feature. |

##### getAutoIncrementStep()
```
public final long getAutoIncrementStep()
```

Gets the increment used by a column with its getAutoIncrement() / setAutoIncrement(boolean) property set to true.

**Returns:**
long - The number by which the value of the column is automatically incremented. The default is 1.
##### setAutoIncrementStep(long value)
```
public final void setAutoIncrementStep(long value)
```

Sets the increment used by a column with its getAutoIncrement() / setAutoIncrement(boolean) property set to true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The number by which the value of the column is automatically incremented. The default is 1. |

##### setReadOnly(boolean value)
```
public final void setReadOnly(boolean value)
```

Sets a value that indicates whether the column allows for changes as soon as a row has been added to the table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the column is read only; otherwise, false. The default is false. |

##### isReadOnly()
```
public final boolean isReadOnly()
```

**Returns:**
boolean
##### getReadOnly()
```
public final boolean getReadOnly()
```

Gets a value that indicates whether the column allows for changes as soon as a row has been added to the table.

**Returns:**
boolean - true if the column is read only; otherwise, false. The default is false.
##### getUnique()
```
public final boolean getUnique()
```

Gets a value that indicates whether the values in each row of the column must be unique.

**Returns:**
boolean - true if the value must be unique; otherwise, false. The default is false.
##### isUnique()
```
public final boolean isUnique()
```

**Returns:**
boolean
##### setUnique(boolean value)
```
public final void setUnique(boolean value)
```

Sets a value that indicates whether the values in each row of the column must be unique.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the value must be unique; otherwise, false. The default is false. |

##### getExpression()
```
public final String getExpression()
```

Gets the expression used to filter rows, calculate the values in a column, or create an aggregate column.

**Returns:**
java.lang.String - An expression to calculate the value of a column, or create an aggregate column. The return type of an expression is determined by the getDataType() / setDataType(java.lang.Class) of the column.
##### areColumnSetsTheSame(DataColumn[] columnSet, DataColumn[] compareSet)
```
public static boolean areColumnSetsTheSame(DataColumn[] columnSet, DataColumn[] compareSet)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnSet | DataColumn\[\] |  |
| compareSet | DataColumn\[\] |  |

**Returns:**
boolean
##### toString()
```
public final String toString()
```

Gets the getExpression() of the column, if one exists.

**Returns:**
java.lang.String - The getExpression() value, if the property is set; otherwise, the getColumnName() / setColumnName(java.lang.String) property.

### DataColumnCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datacolumncollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public final class DataColumnCollection implements Iterable
```

Represents a collection of DataColumn objects for a DataTable.
#### Methods

| Method | Description |
| --- | --- |
| add(DataColumn column) | Creates and adds the specified DataColumn object to the DataColumnCollection. |
| add(String columnName) | Creates and adds a DataColumn object that has the specified name to the DataColumnCollection. |
| add(String columnName, Class type) | Creates and adds a DataColumn object that has the specified name and type to the DataColumnCollection. |
| add(String columnName, Class type, int columnMapping, boolean allowAutoIncrement, boolean allowDBNull) | Creates and adds a DataColumn with the specified name, type and specific values to the columns collection. |
| indexOf(String columnName) | Gets the index of the column with the specific name (the name is not case sensitive). |
| indexOf(DataColumn column) | Gets the index of a column specified by name. |
| get(int index) | Gets the DataColumn from the collection at the specified index. |
| get(String name) | Gets the DataColumn from the collection with the specified name. |
| contains(String name) | Checks whether the collection contains a column with the specified name. |
| remove(String name) | Removes the DataColumn object that has the specified name from the collection. |
| remove(DataColumn column) | Removes the specified DataColumn object from the collection. |
| getCount() |  |
| iterator() |  |
| clear() | Clears the collection of any columns. |
##### add(DataColumn column)
```
public final void add(DataColumn column)
```

Creates and adds the specified DataColumn object to the DataColumnCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn | The DataColumn to add. |

##### add(String columnName)
```
public final void add(String columnName)
```

Creates and adds a DataColumn object that has the specified name to the DataColumnCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | The name of the column. |

##### add(String columnName, Class type)
```
public final DataColumn add(String columnName, Class type)
```

Creates and adds a DataColumn object that has the specified name and type to the DataColumnCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | The DataColumn.getColumnName() / DataColumn.setColumnName(java.lang.String) to use when you create the column. |
| type | java.lang.Class | The DataColumn.getDataType() / DataColumn.setDataType(java.lang.Class) of the new column. |

**Returns:**
DataColumn - The newly created DataColumn.
##### add(String columnName, Class type, int columnMapping, boolean allowAutoIncrement, boolean allowDBNull)
```
public final DataColumn add(String columnName, Class type, int columnMapping, boolean allowAutoIncrement, boolean allowDBNull)
```

Creates and adds a DataColumn with the specified name, type and specific values to the columns collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | name |
| type | java.lang.Class | data type |
| columnMapping | int | column mapping type |
| allowAutoIncrement | boolean | is auto increment allowed |
| allowDBNull | boolean | is DBNull value allowed |

**Returns:**
DataColumn - created a DataColumn instance.
##### indexOf(String columnName)
```
public final int indexOf(String columnName)
```

Gets the index of the column with the specific name (the name is not case sensitive).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | The name of the column to find. |

**Returns:**
int - The zero-based index of the column with the specified name, or -1 if the column does not exist in the collection.
##### indexOf(DataColumn column)
```
public final int indexOf(DataColumn column)
```

Gets the index of a column specified by name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn | The name of the column to return. |

**Returns:**
int - The index of the column specified by  column  if it is found; otherwise, -1.
##### get(int index)
```
public final DataColumn get(int index)
```

Gets the DataColumn from the collection at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the column to return. |

**Returns:**
DataColumn - The DataColumn at the specified index.
##### get(String name)
```
public final DataColumn get(String name)
```

Gets the DataColumn from the collection with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The DataColumn.getColumnName() / DataColumn.setColumnName(java.lang.String) of the column to return. |

**Returns:**
DataColumn - The DataColumn in the collection with the specified DataColumn.getColumnName() / DataColumn.setColumnName(java.lang.String); otherwise a null value if the DataColumn does not exist.
##### contains(String name)
```
public final boolean contains(String name)
```

Checks whether the collection contains a column with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The DataColumn.getColumnName() / DataColumn.setColumnName(java.lang.String) of the column to look for. |

**Returns:**
boolean - true if a column exists with this name; otherwise, false.
##### remove(String name)
```
public final void remove(String name)
```

Removes the DataColumn object that has the specified name from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the column to remove. |

##### remove(DataColumn column)
```
public final void remove(DataColumn column)
```

Removes the specified DataColumn object from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn | The DataColumn to remove. |

##### getCount()
```
public final int getCount()
```

**Returns:**
int - the total number of elements in a collection.
##### iterator()
```
public final Iterator iterator()
```

**Returns:**
java.util.Iterator
##### clear()
```
public final void clear()
```

Clears the collection of any columns.

### DataException
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/dataexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, java.lang.IllegalStateException
```
public final class DataException extends IllegalStateException
```

Represents the exception that is thrown when errors are generated using ADO.NET components.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataException(String s) | Initializes a new instance of the DataException class with the specified string. |
| DataException(Exception ex) | Initializes a new instance of this class. |
##### DataException(String s)
```
public DataException(String s)
```

Initializes a new instance of the DataException class with the specified string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| s | java.lang.String | The string to display when the exception is thrown. |

##### DataException(Exception ex)
```
public DataException(Exception ex)
```

Initializes a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ex | java.lang.Exception |  |

### DataKey
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datakey.md

**Inheritance:**
java.lang.Object
```
public final class DataKey
```
#### Methods

| Method | Description |
| --- | --- |
| getKeyValues(DataRow dataRow) |  |
| getTable() |  |
##### getKeyValues(DataRow dataRow)
```
public final Object[] getKeyValues(DataRow dataRow)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataRow | DataRow |  |

**Returns:**
java.lang.Object[]
##### getTable()
```
public final DataTable getTable()
```

**Returns:**
DataTable

### DataRelation
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datarelation.md

**Inheritance:**
java.lang.Object
```
public final class DataRelation
```

Represents a parent/child relationship between two DataTable objects.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataRelation(String relationName, DataTable parentTable, DataTable childTable, String[] parentColumnNames, String[] childColumnNames) | Initializes a new instance of the DataRelation class using the specified name, parent and child tables, matched arrays of parent and child columns. |
| DataRelation(String relationName, DataColumn[] parentColumns, DataColumn[] childColumns, boolean createConstraints) | Initializes a new instance of the DataRelation class using the specified name, matched arrays of parent and child DataColumn objects, and value that indicates whether to create constraints. |
| DataRelation(String relationName, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints) | Initializes a new instance of the DataRelation class using the specified name, parent and child DataColumn objects, and a value that indicates whether to create constraints. |
| DataRelation(String relationName, DataColumn parentColumn, DataColumn childColumn) | Initializes a new instance of the DataRelation class using the specified DataRelation name, and parent and child DataColumn objects. |
#### Methods

| Method | Description |
| --- | --- |
| getRelationName() | Gets the name used to retrieve a DataRelation from the DataRelationCollection. |
| getParentTableName() |  |
| getChildTableName() |  |
| getParentTable() | Gets the parent DataTable of this DataRelation. |
| getChildTable() | Gets the child table of this relation. |
| getParentColumnNames() |  |
| getChildColumnNames() |  |
| getParentColumns() | Gets an array of DataColumn objects that are the parent columns of this DataRelation. |
| getChildColumns() | Gets the child DataColumn objects of this relation. |
| setNested(boolean value) | Sets a value that indicates whether DataRelation objects are nested. |
| getParentKeyConstraint() | Gets the UniqueConstraint that guarantees that values in the parent column of a DataRelation are unique. |
| setParentKeyConstraint(UniqueConstraint parentKeyConstraint) |  |
| getChildKeyConstraint() | Gets the ForeignKeyConstraint for the relation. |
| setChildKeyConstraint(ForeignKeyConstraint childKeyConstraint) |  |
| getChildKey() |  |
| getParentKey() |  |
| getDataSet() | Gets the DataSet to which the DataRelation belongs. |
| hashCode() |  |
| equals(Object obj) |  |
##### DataRelation(String relationName, DataTable parentTable, DataTable childTable, String[] parentColumnNames, String[] childColumnNames)
```
public DataRelation(String relationName, DataTable parentTable, DataTable childTable, String[] parentColumnNames, String[] childColumnNames)
```

Initializes a new instance of the DataRelation class using the specified name, parent and child tables, matched arrays of parent and child columns.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relationName | java.lang.String | The name of the DataRelation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection. |
| parentTable | DataTable | The parent table in the relationship. |
| childTable | DataTable | The child table in the relationship. |
| parentColumnNames | java.lang.String[] | The parent DataColumn's name in the relationship. |
| childColumnNames | java.lang.String[] | The child DataColumn;s in the relationship. |

##### DataRelation(String relationName, DataColumn[] parentColumns, DataColumn[] childColumns, boolean createConstraints)
```
public DataRelation(String relationName, DataColumn[] parentColumns, DataColumn[] childColumns, boolean createConstraints)
```

Initializes a new instance of the DataRelation class using the specified name, matched arrays of parent and child DataColumn objects, and value that indicates whether to create constraints.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relationName | java.lang.String | The name of the relation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection. |
| parentColumns | DataColumn\[\] | An array of parent DataColumn objects. |
| childColumns | DataColumn\[\] | An array of child DataColumn objects. |
| createConstraints | boolean | A value that indicates whether to create constraints. true, if constraints are created. Otherwise, false. |

##### DataRelation(String relationName, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints)
```
public DataRelation(String relationName, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints)
```

Initializes a new instance of the DataRelation class using the specified name, parent and child DataColumn objects, and a value that indicates whether to create constraints.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relationName | java.lang.String | The name of the relation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection. |
| parentColumn | DataColumn | The parent DataColumn in the relation. |
| childColumn | DataColumn | The child DataColumn in the relation. |
| createConstraints | boolean | A value that indicates whether constraints are created. true, if constraints are created. Otherwise, false. |

##### DataRelation(String relationName, DataColumn parentColumn, DataColumn childColumn)
```
public DataRelation(String relationName, DataColumn parentColumn, DataColumn childColumn)
```

Initializes a new instance of the DataRelation class using the specified DataRelation name, and parent and child DataColumn objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relationName | java.lang.String | The name of the DataRelation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection. |
| parentColumn | DataColumn | The parent DataColumn in the relationship. |
| childColumn | DataColumn | The child DataColumn in the relationship. |

##### getRelationName()
```
public final String getRelationName()
```

Gets the name used to retrieve a DataRelation from the DataRelationCollection.

**Returns:**
java.lang.String - The name of the a DataRelation.
##### getParentTableName()
```
public final String getParentTableName()
```

**Returns:**
java.lang.String - the parent DataTable's name of this DataRelation.
##### getChildTableName()
```
public final String getChildTableName()
```

**Returns:**
java.lang.String - the child DataTable's name of this DataRelation.
##### getParentTable()
```
public final DataTable getParentTable()
```

Gets the parent DataTable of this DataRelation.

**Returns:**
DataTable - A DataTable that is the parent table of this relation.
##### getChildTable()
```
public final DataTable getChildTable()
```

Gets the child table of this relation.

**Returns:**
DataTable - A DataTable that is the child table of the relation.
##### getParentColumnNames()
```
public final String[] getParentColumnNames()
```

**Returns:**
java.lang.String[] - the parent DataColumn names of this relation.
##### getChildColumnNames()
```
public final String[] getChildColumnNames()
```

**Returns:**
java.lang.String[] - the child DataColumn names of this relation.
##### getParentColumns()
```
public final DataColumn[] getParentColumns()
```

Gets an array of DataColumn objects that are the parent columns of this DataRelation.

**Returns:**
com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects that are the parent columns of this DataRelation.
##### getChildColumns()
```
public final DataColumn[] getChildColumns()
```

Gets the child DataColumn objects of this relation.

**Returns:**
com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects.
##### setNested(boolean value)
```
public final void setNested(boolean value)
```

Sets a value that indicates whether DataRelation objects are nested.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true, if DataRelation objects are nested; otherwise, false. |

##### getParentKeyConstraint()
```
public final UniqueConstraint getParentKeyConstraint()
```

Gets the UniqueConstraint that guarantees that values in the parent column of a DataRelation are unique.

**Returns:**
UniqueConstraint - A UniqueConstraint that makes sure that values in a parent column are unique.
##### setParentKeyConstraint(UniqueConstraint parentKeyConstraint)
```
public final void setParentKeyConstraint(UniqueConstraint parentKeyConstraint)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentKeyConstraint | UniqueConstraint |  |

##### getChildKeyConstraint()
```
public final ForeignKeyConstraint getChildKeyConstraint()
```

Gets the ForeignKeyConstraint for the relation.

**Returns:**
ForeignKeyConstraint - A ForeignKeyConstraint.
##### setChildKeyConstraint(ForeignKeyConstraint childKeyConstraint)
```
public final void setChildKeyConstraint(ForeignKeyConstraint childKeyConstraint)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| childKeyConstraint | ForeignKeyConstraint |  |

##### getChildKey()
```
public final DataKey getChildKey()
```

**Returns:**
DataKey
##### getParentKey()
```
public final DataKey getParentKey()
```

**Returns:**
DataKey
##### getDataSet()
```
public final DataSet getDataSet()
```

Gets the DataSet to which the DataRelation belongs.

**Returns:**
DataSet - A DataSet to which the DataRelation belongs.
##### hashCode()
```
public final int hashCode()
```

**Returns:**
int
##### equals(Object obj)
```
public final boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean

### DataRelationCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datarelationcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public final class DataRelationCollection implements Iterable
```

Represents the collection of DataRelation objects for this DataSet.
#### Methods

| Method | Description |
| --- | --- |
| add(DataRelation relation) | Adds a DataRelation to the DataRelationCollection. |
| add(DataTable parentTable, DataTable childTable, String parentColumnName, String childColumnName) | Adds a relation to the collection. |
| add(DataTable parentTable, DataTable childTable, String[] parentColumnNames, String[] childColumnNames) | Adds a relation to the collection. |
| add(String name, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints) | Creates a DataRelation with the specified name, parent and child columns, with optional constraints according to the value of the  createConstraints  parameter, and adds it to the collection. |
| add(DataColumn parentColumn, DataColumn childColumn) | Creates a DataRelation with a specified parent and child column, and adds it to the collection. |
| add(String name, DataColumn parentColumn, DataColumn childColumn) | Creates a DataRelation with the specified name, and parent and child columns, and adds it to the collection. |
| iterator() |  |
| getCount() |  |
| contains(DataRelation relation) | Verifies whether a DataRelation with the specific name (case insensitive) exists in the collection. |
| indexOf(DataRelation relation) | Gets the index of the specified DataRelation object. |
| get(String name) | Gets the DataRelation object specified by name. |
| get(int index) | Gets the DataRelation object at the specified index. |
| removeAt(int index) | Removes the relation at the specified index from the collection. |
| clear() | Clears the collection of any relations. |
##### add(DataRelation relation)
```
public final void add(DataRelation relation)
```

Adds a DataRelation to the DataRelationCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DataRelation | The DataRelation to add to the collection. |

##### add(DataTable parentTable, DataTable childTable, String parentColumnName, String childColumnName)
```
public final void add(DataTable parentTable, DataTable childTable, String parentColumnName, String childColumnName)
```

Adds a relation to the collection. Performs no checks on the duplication etc.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentTable | DataTable | The parent table of the relation. |
| childTable | DataTable | The child table of the relation. |
| parentColumnName | java.lang.String | The parent column's name of the relation. |
| childColumnName | java.lang.String | The child column's name of the relation. |

##### add(DataTable parentTable, DataTable childTable, String[] parentColumnNames, String[] childColumnNames)
```
public final void add(DataTable parentTable, DataTable childTable, String[] parentColumnNames, String[] childColumnNames)
```

Adds a relation to the collection. Performs no checks on the duplication etc.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentTable | DataTable | The parent table of the relation. |
| childTable | DataTable | The child table of the relation. |
| parentColumnNames | java.lang.String[] | The array of parent column's name of the relation. |
| childColumnNames | java.lang.String[] | The array of child column's name of the relation. |

##### add(String name, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints)
```
public final void add(String name, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints)
```

Creates a DataRelation with the specified name, parent and child columns, with optional constraints according to the value of the  createConstraints  parameter, and adds it to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the relation. |
| parentColumn | DataColumn | The parent column of the relation. |
| childColumn | DataColumn | The child column of the relation. |
| createConstraints | boolean | true to create constraints; otherwise false. (The default is true). |

##### add(DataColumn parentColumn, DataColumn childColumn)
```
public final void add(DataColumn parentColumn, DataColumn childColumn)
```

Creates a DataRelation with a specified parent and child column, and adds it to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentColumn | DataColumn | The parent column of the relation. |
| childColumn | DataColumn | The child column of the relation. |

##### add(String name, DataColumn parentColumn, DataColumn childColumn)
```
public final void add(String name, DataColumn parentColumn, DataColumn childColumn)
```

Creates a DataRelation with the specified name, and parent and child columns, and adds it to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the relation. |
| parentColumn | DataColumn | The parent column of the relation. |
| childColumn | DataColumn | The child column of the relation. |

##### iterator()
```
public final Iterator iterator()
```

**Returns:**
java.util.Iterator
##### getCount()
```
public final int getCount()
```

**Returns:**
int - the total number of elements in a collection
##### contains(DataRelation relation)
```
public final boolean contains(DataRelation relation)
```

Verifies whether a DataRelation with the specific name (case insensitive) exists in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DataRelation | The name of the relation to find. |

**Returns:**
boolean - true, if a relation with the specified name exists; otherwise false.
##### indexOf(DataRelation relation)
```
public final int indexOf(DataRelation relation)
```

Gets the index of the specified DataRelation object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DataRelation | The relation to search for. |

**Returns:**
int - The 0-based index of the relation, or -1 if the relation is not found in the collection.
##### get(String name)
```
public final DataRelation get(String name)
```

Gets the DataRelation object specified by name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the relation to find. |

**Returns:**
DataRelation - The named DataRelation, or a null value if the specified DataRelation does not exist.
##### get(int index)
```
public final DataRelation get(int index)
```

Gets the DataRelation object at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index to find. |

**Returns:**
DataRelation - The DataRelation, or a null value if the specified DataRelation does not exist.
##### removeAt(int index)
```
public final void removeAt(int index)
```

Removes the relation at the specified index from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of the relation to remove. |

##### clear()
```
public final void clear()
```

Clears the collection of any relations.

### DataRow
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datarow.md

**Inheritance:**
java.lang.Object
```
public class DataRow
```

Represents a row of data in a DataTable.
#### Methods

| Method | Description |
| --- | --- |
| readFrom(ResultSet resultSet) | Reads values from the java.sql.ResultSet |
| get(int columnIndex) | Gets the data stored in the column specified by index. |
| get(String columnName) | Gets the data stored in the column specified by name. |
| get(DataColumn column) | Gets the data stored in the specified DataColumn. |
| getTable() | Gets the DataTable for which this row has a schema. |
| getChildRows(DataRelation relation) | Gets the child rows of this DataRow using the specified DataRelation. |
| getParentRow(DataRelation relation) | Gets the parent row of a DataRow using the specified DataRelation. |
| getParentRows(DataRelation relation) | Gets the parent rows of a DataRow using the specified DataRelation. |
| set(int value, Object columnIndex) | Sets the data stored in the column specified by index. |
| set(String value, Object columnName) | Sets the data stored in the column specified by name. |
| set(DataColumn value, Object column) | Sets the data stored in the specified DataColumn. |
| getRowState() | Gets the current state of the row with regard to its relationship to the DataRowCollection. |
| setRowState(int state) |  |
| delete() | Deletes the DataRow. |
| setOriginalValue(String columnName, Object data) |  |
| getOriginalValue(String columnName) |  |
| getItemArray() | Gets all the values for this row through an array. |
| setItemArray(Object[] value) | Sets all the values for this row through an array. |
| getKeyValues(DataKey childKey) |  |
| remove(int index) |  |
| toString() |  |
##### readFrom(ResultSet resultSet)
```
public boolean readFrom(ResultSet resultSet)
```

Reads values from the java.sql.ResultSet

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resultSet | java.sql.ResultSet | storage to read from |

**Returns:**
boolean - true if no read errors occurred
##### get(int columnIndex)
```
public Object get(int columnIndex)
```

Gets the data stored in the column specified by index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnIndex | int | The zero-based index of the column. |

**Returns:**
java.lang.Object - An java.lang.Object that contains the data.
##### get(String columnName)
```
public Object get(String columnName)
```

Gets the data stored in the column specified by name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | The name of the column. |

**Returns:**
java.lang.Object - An java.lang.Object that contains the data.
##### get(DataColumn column)
```
public Object get(DataColumn column)
```

Gets the data stored in the specified DataColumn.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn | A DataColumn that contains the data. |

**Returns:**
java.lang.Object - An java.lang.Object that contains the data.
##### getTable()
```
public DataTable getTable()
```

Gets the DataTable for which this row has a schema.

**Returns:**
DataTable - The DataTable to which this row belongs.
##### getChildRows(DataRelation relation)
```
public DataRow[] getChildRows(DataRelation relation)
```

Gets the child rows of this DataRow using the specified DataRelation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DataRelation | The DataRelation to use. |

**Returns:**
com.groupdocs.assembly.system.data.DataRow[] - An array of DataRow objects or an array of length zero.
##### getParentRow(DataRelation relation)
```
public DataRow getParentRow(DataRelation relation)
```

Gets the parent row of a DataRow using the specified DataRelation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DataRelation | The DataRelation to use. |

**Returns:**
DataRow - The parent DataRow of the current row.
##### getParentRows(DataRelation relation)
```
public DataRow[] getParentRows(DataRelation relation)
```

Gets the parent rows of a DataRow using the specified DataRelation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DataRelation | The DataRelation to use. |

**Returns:**
com.groupdocs.assembly.system.data.DataRow[] - An array of DataRow objects or an array of length zero.
##### set(int value, Object columnIndex)
```
public void set(int value, Object columnIndex)
```

Sets the data stored in the column specified by index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | An java.lang.Object that contains the data. |
| columnIndex | java.lang.Object | The zero-based index of the column. |

##### set(String value, Object columnName)
```
public void set(String value, Object columnName)
```

Sets the data stored in the column specified by name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An java.lang.Object that contains the data. |
| columnName | java.lang.Object | The name of the column. |

##### set(DataColumn value, Object column)
```
public void set(DataColumn value, Object column)
```

Sets the data stored in the specified DataColumn.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DataColumn | An java.lang.Object that contains the data. |
| column | java.lang.Object | A DataColumn that contains the data. |

##### getRowState()
```
public int getRowState()
```

Gets the current state of the row with regard to its relationship to the DataRowCollection.

**Returns:**
int - One of the DataRowState values. The returned value is a bitwise combination of DataRowState constants.
##### setRowState(int state)
```
public void setRowState(int state)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| state | int |  |

##### delete()
```
public void delete()
```

Deletes the DataRow.

##### setOriginalValue(String columnName, Object data)
```
public void setOriginalValue(String columnName, Object data)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String |  |
| data | java.lang.Object |  |

##### getOriginalValue(String columnName)
```
public Object getOriginalValue(String columnName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String |  |

**Returns:**
java.lang.Object
##### getItemArray()
```
public Object[] getItemArray()
```

Gets all the values for this row through an array.

**Returns:**
java.lang.Object[] - An array of type java.lang.Object.
##### setItemArray(Object[] value)
```
public void setItemArray(Object[] value)
```

Sets all the values for this row through an array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object[] | An array of type java.lang.Object. |

##### getKeyValues(DataKey childKey)
```
public Object[] getKeyValues(DataKey childKey)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| childKey | DataKey |  |

**Returns:**
java.lang.Object[]
##### remove(int index)
```
public void remove(int index)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### DataRowCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datarowcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class DataRowCollection implements Iterable
```

Represents a collection of rows for a DataTable.
#### Methods

| Method | Description |
| --- | --- |
| add(DataRow row) | Adds the specified DataRow to the DataRowCollection object. |
| add(Object[] values) | Creates a row using specified values and adds it to the DataRowCollection. |
| get(int index) | Gets the row at the specified index. |
| getCount() | Gets the total number of DataRow objects in this collection. |
| iterator() | Gets an java.util.Iterator for this collection. |
| clear() | Clears the collection of all rows. |
| insertAt(DataRow row, int pos) | Inserts a new row into the collection at the specified location. |
| removeAt(int index) | Removes the row at the specified index from the collection. |
| find(String primaryKeyValue) | Gets the row specified by the primary key value. |
| find(Object[] keys) | Gets the row that contains the specified primary key values. |
| get(Object[] values) | Gets the row that contains the specified values. |
##### add(DataRow row)
```
public void add(DataRow row)
```

Adds the specified DataRow to the DataRowCollection object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | DataRow | The DataRow to add. |

##### add(Object[] values)
```
public void add(Object[] values)
```

Creates a row using specified values and adds it to the DataRowCollection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | java.lang.Object[] | The array of values that are used to create the new row. |

##### get(int index)
```
public DataRow get(int index)
```

Gets the row at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the row to return. |

**Returns:**
DataRow - The specified DataRow.
##### getCount()
```
public int getCount()
```

Gets the total number of DataRow objects in this collection.

**Returns:**
int - The total number of DataRow objects in this collection.
##### iterator()
```
public Iterator iterator()
```

Gets an java.util.Iterator for this collection.

**Returns:**
java.util.Iterator - An java.util.Iterator for this collection.
##### clear()
```
public void clear()
```

Clears the collection of all rows.

##### insertAt(DataRow row, int pos)
```
public void insertAt(DataRow row, int pos)
```

Inserts a new row into the collection at the specified location.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | DataRow | The DataRow to add. |
| pos | int | The (zero-based) location in the collection where you want to add the DataRow. |

##### removeAt(int index)
```
public void removeAt(int index)
```

Removes the row at the specified index from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of the row to remove. |

##### find(String primaryKeyValue)
```
public DataRow find(String primaryKeyValue)
```

Gets the row specified by the primary key value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| primaryKeyValue | java.lang.String | The primary key value of the DataRow to find. |

**Returns:**
DataRow - A DataRow that contains the primary key value specified; otherwise a null value if the primary key value does not exist in the DataRowCollection.
##### find(Object[] keys)
```
public DataRow find(Object[] keys)
```

Gets the row that contains the specified primary key values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keys | java.lang.Object[] | An array of primary key values to find. The type of the array is Object. |

**Returns:**
DataRow - A DataRow object that contains the primary key values specified; otherwise a null value if the primary key value does not exist in the DataRowCollection.
##### get(Object[] values)
```
public DataRow get(Object[] values)
```

Gets the row that contains the specified values. If there is primary key's column(s) present then the index will be used. If there is no index then simple linear scan is used. Be carefully with that because it could take a significant amount of time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | java.lang.Object[] | row's data |

**Returns:**
DataRow - found row or `null`

### DataRowState
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datarowstate.md

**Inheritance:**
java.lang.Object
```
public final class DataRowState
```

Specifies the state of a DataRow object.
#### Fields

| Field | Description |
| --- | --- |
| DETACHED | Specifies that the row has been created but is not part of any DataRowCollection. |
| UNCHANGED | Specifies that the row has not changed. |
| ADDED | Specifies that the row has been added to a DataRowCollection. |
| DELETED | Specifies that the row was deleted using the DataRow.delete() method of the DataRow. |
| MODIFIED | Specifies that the row has been modified. |
##### DETACHED
```
public static final int DETACHED
```

Specifies that the row has been created but is not part of any DataRowCollection. A DataRow is in this state immediately after it has been created and before it is added to a collection, or if it has been removed from a collection.

##### UNCHANGED
```
public static final int UNCHANGED
```

Specifies that the row has not changed.

##### ADDED
```
public static final int ADDED
```

Specifies that the row has been added to a DataRowCollection.

##### DELETED
```
public static final int DELETED
```

Specifies that the row was deleted using the DataRow.delete() method of the DataRow.

##### MODIFIED
```
public static final int MODIFIED
```

Specifies that the row has been modified.

### DataRowView
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datarowview.md

**Inheritance:**
java.lang.Object
```
public class DataRowView
```

Represents a customized view of a DataRow.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataRowView(DataView view, DataRow row) | Initializes a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| getRow() | Gets the DataRow being viewed. |
##### DataRowView(DataView view, DataRow row)
```
public DataRowView(DataView view, DataRow row)
```

Initializes a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| view | DataView |  |
| row | DataRow |  |

##### getRow()
```
public DataRow getRow()
```

Gets the DataRow being viewed.

**Returns:**
DataRow - The DataRow being viewed by the DataRowView.

### DataSet
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/dataset.md

**Inheritance:**
java.lang.Object
```
public class DataSet
```

Represents an in-memory cache of data.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataSet() | Initializes a new instance of the DataSet class. |
| DataSet(Connection connection) | Initializes a new instance of the DataSet class with data taken from Connection. |
| DataSet(Connection connection, String schemaName) | Initializes a new instance of the DataSet class with data taken from Connection. |
| DataSet(String dataSetName) | Initializes a new instance of a DataSet class with the given name. |
#### Methods

| Method | Description |
| --- | --- |
| getDataSetName() | Gets the name of the current DataSet. |
| setDataSetName(String value) | Sets the name of the current DataSet. |
| getNamespace() | Gets the namespace of the DataSet. |
| getTables() | Gets the collection of tables contained in the DataSet. |
| getRelations() | Get the collection of relations that link tables and allow navigation from parent tables to child tables. |
| close() |  |
| clear() | Clears the DataSet of any data by removing all rows in all tables. |
| reset() | Resets the DataSet to its original state. |
| readXml(InputStream xmlStream, XmlReadMode mode) | Reads XML schema and data into the DataSet using the specified java.io.InputStream and XmlReadMode. |
| readXml(InputStream xmlStream) | Reads XML schema and data into the DataSet using the specified java.io.InputStream. |
| readXml(String fileName) | Reads XML schema and data into the DataSet using the specified file. |
| readXml(String xmlPath, XmlReadMode readMode) | Reads XML schema and data into the DataSet using the specified file and XmlReadMode. |
| readXmlSchema(InputStream xmlStream) | Reads the XML schema from the specified Stream into the DataSet. |
| readXmlSchema(String fileName) | Reads the XML schema from the specified file into the DataSet. |
| setLocale(Locale locale) | Sets the locale information used to compare strings within the table. |
| isLocaleSpecified() |  |
| getEnforceConstraints() | Gets a value indicating whether constraint rules are followed when attempting any update operation. |
| setEnforceConstraints(boolean value) | Sets a value indicating whether constraint rules are followed when attempting any update operation. |
##### DataSet()
```
public DataSet()
```

Initializes a new instance of the DataSet class.

##### DataSet(Connection connection)
```
public DataSet(Connection connection)
```

Initializes a new instance of the DataSet class with data taken from Connection. Tables, Relations, Constraints and Indexes will be copied into DataSet.

By default no schema name will be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| connection | java.sql.Connection | which contains DB data. |

##### DataSet(Connection connection, String schemaName)
```
public DataSet(Connection connection, String schemaName)
```

Initializes a new instance of the DataSet class with data taken from Connection. Tables, Relations, Constraints and Indexes will be copied into DataSet.

`DataSet dataSet = new DataSet(conn, "PUBLIC"); // HSQLDB`

or

`DataSet dataSet = new DataSet(conn); // MYSQL's default schema name.`

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| connection | java.sql.Connection | which contains DB data. |
| schemaName | java.lang.String | which contains the tables to be imported. |

##### DataSet(String dataSetName)
```
public DataSet(String dataSetName)
```

Initializes a new instance of a DataSet class with the given name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetName | java.lang.String | The name of the DataSet. |

##### getDataSetName()
```
public String getDataSetName()
```

Gets the name of the current DataSet.

**Returns:**
java.lang.String - The name of the DataSet.
##### setDataSetName(String value)
```
public void setDataSetName(String value)
```

Sets the name of the current DataSet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the DataSet. |

##### getNamespace()
```
public String getNamespace()
```

Gets the namespace of the DataSet.

**Returns:**
java.lang.String - The namespace of the DataSet.
##### getTables()
```
public DataTableCollection getTables()
```

Gets the collection of tables contained in the DataSet.

**Returns:**
DataTableCollection - The DataTableCollection contained by this DataSet. An empty collection is returned if no DataTable objects exist.
##### getRelations()
```
public DataRelationCollection getRelations()
```

Get the collection of relations that link tables and allow navigation from parent tables to child tables.

**Returns:**
DataRelationCollection - A DataRelationCollection that contains a collection of DataRelation objects. An empty collection is returned if no DataRelation objects exist.
##### close()
```
public void close()
```

##### clear()
```
public void clear()
```

Clears the DataSet of any data by removing all rows in all tables.

##### reset()
```
public void reset()
```

Resets the DataSet to its original state. Subclasses should override reset() to restore a DataSet to its original state.

##### readXml(InputStream xmlStream, XmlReadMode mode)
```
public XmlReadMode readXml(InputStream xmlStream, XmlReadMode mode)
```

Reads XML schema and data into the DataSet using the specified java.io.InputStream and XmlReadMode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream | The Stream from which to read. |
| mode | XmlReadMode | One of the XmlReadMode values. |

**Returns:**
XmlReadMode - The XmlReadMode used to read the data.
##### readXml(InputStream xmlStream)
```
public XmlReadMode readXml(InputStream xmlStream)
```

Reads XML schema and data into the DataSet using the specified java.io.InputStream. The \#readXml(InputStream, XmlReadMode).readXml(InputStream, XmlReadMode) method provides a way to read either data only, or both data and schema into a DataSet from an XML document, whereas the \#readXmlSchema(InputStream).readXmlSchema(InputStream) method reads only the schema. To read both data and schema, use one of the `readXML` overloads that includes the mode parameter, and set its value to ReadSchema. If an in-line schema is specified, the in-line schema is used to extend the existing relational structure prior to loading the data. If there are any conflicts (for example, the same column in the same table defined with different data types) an exception is raised.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream | data stream |

**Returns:**
XmlReadMode - mode which was used while reading
##### readXml(String fileName)
```
public XmlReadMode readXml(String fileName)
```

Reads XML schema and data into the DataSet using the specified file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The filename (including the path) from which to read. |

**Returns:**
XmlReadMode - The XmlReadMode used to read the data. The returned value is one of XmlReadMode constants.
##### readXml(String xmlPath, XmlReadMode readMode)
```
public XmlReadMode readXml(String xmlPath, XmlReadMode readMode)
```

Reads XML schema and data into the DataSet using the specified file and XmlReadMode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | java.lang.String | the specified file |
| readMode | XmlReadMode | XmlReadMode |

**Returns:**
XmlReadMode - mode which was used while reading
##### readXmlSchema(InputStream xmlStream)
```
public void readXmlSchema(InputStream xmlStream)
```

Reads the XML schema from the specified Stream into the DataSet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream | won't be closed after the schema has been read. |

##### readXmlSchema(String fileName)
```
public void readXmlSchema(String fileName)
```

Reads the XML schema from the specified file into the DataSet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The file name (including the path) from which to read. |

##### setLocale(Locale locale)
```
public void setLocale(Locale locale)
```

Sets the locale information used to compare strings within the table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| locale | java.util.Locale | of this data set |

##### isLocaleSpecified()
```
public boolean isLocaleSpecified()
```

**Returns:**
boolean - true if locale was set
##### getEnforceConstraints()
```
public boolean getEnforceConstraints()
```

Gets a value indicating whether constraint rules are followed when attempting any update operation.

**Returns:**
boolean - true if rules are enforced; otherwise false. The default is true.
##### setEnforceConstraints(boolean value)
```
public void setEnforceConstraints(boolean value)
```

Sets a value indicating whether constraint rules are followed when attempting any update operation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if rules are enforced; otherwise false. The default is true. |

### DataTable
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datatable.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.assembly.system.data.DataTableEventListener
```
public class DataTable implements DataTableEventListener
```

Represents one table of in-memory data.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataTable() | Initializes a new instance of the DataTable class with no arguments. |
| DataTable(String tableName) | Initializes a new instance of the DataTable class with the specified table name. |
| DataTable(ResultSet resultSet) | Creates an object by wrapping the specified ResultSet. |
| DataTable(ResultSet resultSet, String tableName) | Creates an object by wrapping the specified ResultSet. |
#### Methods

| Method | Description |
| --- | --- |
| close() |  |
| getTableName() | Gets the name of the DataTable. |
| setTableName(String value) | Sets the name of the DataTable. |
| containsColumn(String columnName) | Check whether the given column exists or not |
| getColumnsCount() |  |
| getColumnName(int index) | Analog for .Net DataTable.Columns[i].ColumnName |
| getResultSet() | Returns the underlying Java ResultSet object. |
| getDataSet() | Gets the DataSet to which this table belongs. |
| getChildRelations() | Gets the collection of child relations for this DataTable. |
| getParentRelations() | Gets the collection of parent relations for this DataTable. |
| getRows() | Gets the collection of rows that belong to this table. |
| getColumns() | Gets the collection of columns that belong to this table. |
| newRow() | Creates a new DataRow with the same schema as the table. |
| getConstraints() | Gets the collection of constraints maintained by this table. |
| getPrimaryKey() | Gets an array of columns that function as primary keys for the data table. |
| setPrimaryKey(DataColumn[] value) | Sets an array of columns that function as primary keys for the data table. |
| getNamespace() | Gets the namespace for the XML representation of the data stored in the DataTable. |
| setNamespace(String value) | Sets the namespace for the XML representation of the data stored in the DataTable. |
| getEnforceConstraints() |  |
| setEnforceConstraints(boolean enforceConstraints) |  |
| refresh() | Reloads all the data from ResultSet if it is present. |
| acceptChanges() | Commits all the changes made to this table since the last time acceptChanges() was called. |
| addEventListener(DataTableEventListener listener) |  |
| clearEventListneers() |  |
| onDataRowChanged(DataRow row) |  |
| onDataRowInserted(DataRow row) |  |
| onDataRowDeleted(DataRow row) |  |
| onDataColumnInserted(DataColumn column) |  |
| onDataColumnDeleted(DataColumn column) |  |
##### DataTable()
```
public DataTable()
```

Initializes a new instance of the DataTable class with no arguments.

##### DataTable(String tableName)
```
public DataTable(String tableName)
```

Initializes a new instance of the DataTable class with the specified table name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tableName | java.lang.String | The name to give the table. If  tableName  is null or an empty string, a default name is given when added to the DataTableCollection. |

##### DataTable(ResultSet resultSet)
```
public DataTable(ResultSet resultSet)
```

Creates an object by wrapping the specified ResultSet. Attempts to retrieve the table name from the metadata of the first column of the ResultSet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resultSet | java.sql.ResultSet | data set |

##### DataTable(ResultSet resultSet, String tableName)
```
public DataTable(ResultSet resultSet, String tableName)
```

Creates an object by wrapping the specified ResultSet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resultSet | java.sql.ResultSet | data set |
| tableName | java.lang.String | name of the table |

##### close()
```
public void close()
```

##### getTableName()
```
public String getTableName()
```

Gets the name of the DataTable.

**Returns:**
java.lang.String - The name of the DataTable.
##### setTableName(String value)
```
public void setTableName(String value)
```

Sets the name of the DataTable.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the DataTable. |

##### containsColumn(String columnName)
```
public boolean containsColumn(String columnName)
```

Check whether the given column exists or not

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnName | java.lang.String | name of the column |

**Returns:**
boolean - `true` is column can be found by the given `columnName`
##### getColumnsCount()
```
public int getColumnsCount()
```

**Returns:**
int - columns count
##### getColumnName(int index)
```
public String getColumnName(int index)
```

Analog for .Net DataTable.Columns[i].ColumnName

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | \- column's index |

**Returns:**
java.lang.String - column's name by its index.
##### getResultSet()
```
public ResultSet getResultSet()
```

Returns the underlying Java ResultSet object. Ideally we would like to work with DataTable in .Net manner. But some users and even some ours sample code are using this property.

**Returns:**
java.sql.ResultSet - the underlying java.sql.ResultSet
##### getDataSet()
```
public DataSet getDataSet()
```

Gets the DataSet to which this table belongs.

**Returns:**
DataSet - The DataSet to which this table belongs.
##### getChildRelations()
```
public DataRelationCollection getChildRelations()
```

Gets the collection of child relations for this DataTable.

**Returns:**
DataRelationCollection - A DataRelationCollection that contains the child relations for the table. An empty collection is returned if no DataRelation objects exist.
##### getParentRelations()
```
public DataRelationCollection getParentRelations()
```

Gets the collection of parent relations for this DataTable.

**Returns:**
DataRelationCollection - A DataRelationCollection that contains the parent relations for the table. An empty collection is returned if no DataRelation objects exist.
##### getRows()
```
public DataRowCollection getRows()
```

Gets the collection of rows that belong to this table.

**Returns:**
DataRowCollection - A DataRowCollection that contains DataRow objects; otherwise a null value if no DataRow objects exist.
##### getColumns()
```
public DataColumnCollection getColumns()
```

Gets the collection of columns that belong to this table.

**Returns:**
DataColumnCollection - A DataColumnCollection that contains the collection of DataColumn objects for the table. An empty collection is returned if no DataColumn objects exist.
##### newRow()
```
public DataRow newRow()
```

Creates a new DataRow with the same schema as the table.

**Returns:**
DataRow - A DataRow with the same schema as the DataTable.
##### getConstraints()
```
public ConstraintCollection getConstraints()
```

Gets the collection of constraints maintained by this table.

**Returns:**
ConstraintCollection - A ConstraintCollection that contains the collection of Constraint objects for the table. An empty collection is returned if no Constraint objects exist.
##### getPrimaryKey()
```
public DataColumn[] getPrimaryKey()
```

Gets an array of columns that function as primary keys for the data table.

**Returns:**
com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects.
##### setPrimaryKey(DataColumn[] value)
```
public void setPrimaryKey(DataColumn[] value)
```

Sets an array of columns that function as primary keys for the data table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DataColumn\[\] | An array of DataColumn objects. |

##### getNamespace()
```
public String getNamespace()
```

Gets the namespace for the XML representation of the data stored in the DataTable.

**Returns:**
java.lang.String - The namespace of the DataTable.
##### setNamespace(String value)
```
public void setNamespace(String value)
```

Sets the namespace for the XML representation of the data stored in the DataTable.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The namespace of the DataTable. |

##### getEnforceConstraints()
```
public boolean getEnforceConstraints()
```

**Returns:**
boolean - flag which indicates whether check constraint violation or not
##### setEnforceConstraints(boolean enforceConstraints)
```
public void setEnforceConstraints(boolean enforceConstraints)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enforceConstraints | boolean | is the flag which indicates whether check constraint violation or not |

##### refresh()
```
public void refresh()
```

Reloads all the data from ResultSet if it is present.

##### acceptChanges()
```
public void acceptChanges()
```

Commits all the changes made to this table since the last time acceptChanges() was called.

##### addEventListener(DataTableEventListener listener)
```
public synchronized void addEventListener(DataTableEventListener listener)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| listener | DataTableEventListener |  |

##### clearEventListneers()
```
public synchronized void clearEventListneers()
```

##### onDataRowChanged(DataRow row)
```
public void onDataRowChanged(DataRow row)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | DataRow |  |

##### onDataRowInserted(DataRow row)
```
public void onDataRowInserted(DataRow row)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | DataRow |  |

##### onDataRowDeleted(DataRow row)
```
public void onDataRowDeleted(DataRow row)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | DataRow |  |

##### onDataColumnInserted(DataColumn column)
```
public void onDataColumnInserted(DataColumn column)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn |  |

##### onDataColumnDeleted(DataColumn column)
```
public void onDataColumnDeleted(DataColumn column)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn |  |

### DataTableCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datatablecollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public final class DataTableCollection implements Iterable
```

Represents the collection of tables for the DataSet.
#### Methods

| Method | Description |
| --- | --- |
| iterator() |  |
| get(String name) | Gets the DataTable object with the specified name. |
| get(String name, String tableNamespace) | Gets the DataTable object with the specified name in the specified namespace. |
| add(DataTable table) | Adds the specified DataTable to the collection. |
| add(String name) | Creates a DataTable object by using the specified name and adds it to the collection. |
| get(int index) | Gets the DataTable object at the specified index. |
| getCount() |  |
| contains(String name) | Gets a value that indicates whether a DataTable object with the specified name exists in the collection. |
##### iterator()
```
public final Iterator iterator()
```

**Returns:**
java.util.Iterator
##### get(String name)
```
public final DataTable get(String name)
```

Gets the DataTable object with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the DataTable to find. |

**Returns:**
DataTable - A DataTable with the specified name; otherwise null if the DataTable does not exist.
##### get(String name, String tableNamespace)
```
public final DataTable get(String name, String tableNamespace)
```

Gets the DataTable object with the specified name in the specified namespace.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the DataTable to find. |
| tableNamespace | java.lang.String | The name of the DataTable namespace to look in. |

**Returns:**
DataTable - A DataTable with the specified name; otherwise null if the DataTable does not exist.
##### add(DataTable table)
```
public final void add(DataTable table)
```

Adds the specified DataTable to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| table | DataTable | The DataTable object to add. |

##### add(String name)
```
public final DataTable add(String name)
```

Creates a DataTable object by using the specified name and adds it to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name to give the created DataTable. |

**Returns:**
DataTable - The newly created DataTable.
##### get(int index)
```
public final DataTable get(int index)
```

Gets the DataTable object at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the DataTable to find. |

**Returns:**
DataTable - A DataTable.
##### getCount()
```
public final int getCount()
```

**Returns:**
int - total number of items in this collection.
##### contains(String name)
```
public final boolean contains(String name)
```

Gets a value that indicates whether a DataTable object with the specified name exists in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the DataTable to find. |

**Returns:**
boolean - true if the specified table exists; otherwise false.

### DataTableEventListener
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datatableeventlistener.md

### DataTableReader
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/datatablereader.md

**Inheritance:**
java.lang.Object, com.groupdocs.assembly.system.data.common.DbDataReader
```
public final class DataTableReader extends DbDataReader
```

The DataTableReader obtains the contents of one or more DataTable objects in the form of one or more read-only, forward-only result sets.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataTableReader(DataTable dataTable) | Initializes a new instance of the DataTableReader class by using data from the supplied DataTable. |
| DataTableReader(DataTable[] dataTables) | Initializes a new instance of the DataTableReader class using the supplied array of DataTable objects. |
#### Methods

| Method | Description |
| --- | --- |
| getFieldCount() | Returns the number of columns in the current row. |
| isClosed() | Gets a value that indicates whether the DataTableReader is closed. |
| get(int ordinal) | Gets the value of the specified column in its native format given the column ordinal. |
| getName(int ordinal) | Gets the value of the specified column as a java.lang.String. |
| getFieldType(int ordinal) | Gets the java.lang.Class that is the data type of the object. |
| getValue(int ordinal) | Gets the value of the specified column in its native format. |
| read() | Advances the DataTableReader to the next record. |
| getDepth() | The depth of nesting for the current row of the DataTableReader. |
| getRecordsAffected() | Gets the number of rows inserted, changed, or deleted by execution of the SQL statement. |
| close() | Closes the current DataTableReader. |
| getSchemaTable() | Returns a DataTable that describes the column metadata of the DataTableReader. |
| nextResult() | Advances the DataTableReader to the next result set, if any. |
| hasRows() | Gets a value that indicates whether the DataTableReader contains one or more rows. |
| iterator() | Returns an enumerator that can be used to iterate through the item collection. |
| get(String name) | Gets the value of the specified column in its native format given the column name. |
##### DataTableReader(DataTable dataTable)
```
public DataTableReader(DataTable dataTable)
```

Initializes a new instance of the DataTableReader class by using data from the supplied DataTable.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataTable | DataTable | The DataTable from which the new DataTableReader obtains its result set. |

##### DataTableReader(DataTable[] dataTables)
```
public DataTableReader(DataTable[] dataTables)
```

Initializes a new instance of the DataTableReader class using the supplied array of DataTable objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataTables | DataTable\[\] | The array of DataTable objects that supplies the results for the new DataTableReader object. |

##### getFieldCount()
```
public final int getFieldCount()
```

Returns the number of columns in the current row.

**Returns:**
int - When not positioned in a valid result set, 0; otherwise the number of columns in the current row.
##### isClosed()
```
public final boolean isClosed()
```

Gets a value that indicates whether the DataTableReader is closed.

**Returns:**
boolean - Returns true if the DataTableReader is closed; otherwise, false.
##### get(int ordinal)
```
public final Object get(int ordinal)
```

Gets the value of the specified column in its native format given the column ordinal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ordinal | int | The zero-based column ordinal. |

**Returns:**
java.lang.Object - The value of the specified column in its native format.
##### getName(int ordinal)
```
public final String getName(int ordinal)
```

Gets the value of the specified column as a java.lang.String.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ordinal | int | The zero-based column ordinal |

**Returns:**
java.lang.String - The name of the specified column.
##### getFieldType(int ordinal)
```
public final Class getFieldType(int ordinal)
```

Gets the java.lang.Class that is the data type of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ordinal | int | The zero-based column ordinal. |

**Returns:**
java.lang.Class - The java.lang.Class that is the data type of the object.
##### getValue(int ordinal)
```
public final Object getValue(int ordinal)
```

Gets the value of the specified column in its native format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ordinal | int | The zero-based column ordinal |

**Returns:**
java.lang.Object - The value of the specified column. This method returns DBNull for null columns.
##### read()
```
public final boolean read()
```

Advances the DataTableReader to the next record.

**Returns:**
boolean - true if there was another row to read; otherwise false.
##### getDepth()
```
public final int getDepth()
```

The depth of nesting for the current row of the DataTableReader.

**Returns:**
int - The depth of nesting for the current row; always zero.
##### getRecordsAffected()
```
public final int getRecordsAffected()
```

Gets the number of rows inserted, changed, or deleted by execution of the SQL statement.

**Returns:**
int - The DataTableReader does not support this property and always returns 0.
##### close()
```
public final void close()
```

Closes the current DataTableReader.

##### getSchemaTable()
```
public final DataTable getSchemaTable()
```

Returns a DataTable that describes the column metadata of the DataTableReader.

**Returns:**
DataTable - A DataTable that describes the column metadata.
##### nextResult()
```
public final boolean nextResult()
```

Advances the DataTableReader to the next result set, if any.

**Returns:**
boolean - true if there was another result set; otherwise false.
##### hasRows()
```
public final boolean hasRows()
```

Gets a value that indicates whether the DataTableReader contains one or more rows.

**Returns:**
boolean - true if the DataTableReader contains one or more rows; otherwise false.
##### iterator()
```
public final Iterator iterator()
```

Returns an enumerator that can be used to iterate through the item collection.

**Returns:**
java.util.Iterator - An java.util.Iterator object that represents the item collection.
##### get(String name)
```
public final Object get(String name)
```

Gets the value of the specified column in its native format given the column name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the column. |

**Returns:**
java.lang.Object - The value of the specified column in its native format.

### DataView
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/dataview.md

**Inheritance:**
java.lang.Object
```
public class DataView
```

Represents a databindable, customized view of a DataTable for sorting, filtering, searching, editing, and navigation.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataView(DataTable table) | Initializes a new instance of the DataView class with the specified DataTable. |
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of records in the DataView. |
| getTable() | Gets the source DataTable. |
| get(int recordIndex) | Gets a row of data from a specified table. |
| close() | Closes the DataView. |
##### DataView(DataTable table)
```
public DataView(DataTable table)
```

Initializes a new instance of the DataView class with the specified DataTable.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| table | DataTable | A DataTable to add to the DataView. |

##### getCount()
```
public int getCount()
```

Gets the number of records in the DataView.

**Returns:**
int - The number of records in the DataView.
##### getTable()
```
public DataTable getTable()
```

Gets the source DataTable.

**Returns:**
DataTable - A DataTable that provides the data for this view.
##### get(int recordIndex)
```
public DataRowView get(int recordIndex)
```

Gets a row of data from a specified table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordIndex | int | The index of a record in the DataTable. |

**Returns:**
DataRowView - A DataRowView of the row that you want.
##### close()
```
public void close()
```

Closes the DataView.

### DBNull
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/dbnull.md

**Inheritance:**
java.lang.Object
```
public final class DBNull
```
#### Fields

| Field | Description |
| --- | --- |
| Value |  |
#### Methods

| Method | Description |
| --- | --- |
| toString() |  |
##### Value
```
public static final DBNull Value
```

##### toString()
```
public final String toString()
```

**Returns:**
java.lang.String

### ForeignKeyConstraint
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/foreignkeyconstraint.md

**Inheritance:**
java.lang.Object, com.groupdocs.assembly.system.data.Constraint
```
public class ForeignKeyConstraint extends Constraint
```

Represents an action restriction enforced on a set of columns in a primary key/foreign key relationship when a value or row is either deleted or updated.
#### Constructors

| Constructor | Description |
| --- | --- |
| ForeignKeyConstraint(String constraintName, DataColumn[] parentColumns, DataColumn[] childColumns) | Initializes a new instance of the ForeignKeyConstraint class with the specified name, and arrays of parent and child DataColumn objects. |
| ForeignKeyConstraint(DataColumn parentColumn, DataColumn childColumn) | Initializes a new instance of the ForeignKeyConstraint class with the specified parent and child DataColumn objects. |
| ForeignKeyConstraint(String constraintName, DataColumn parentColumn, DataColumn childColumn) | Initializes a new instance of the ForeignKeyConstraint class with the specified name, parent and child DataColumn objects. |
#### Methods

| Method | Description |
| --- | --- |
| getDeleteRule() | Gets the action that occurs across this constraint when a row is deleted. |
| getUpdateRule() | Gets the action that occurs across this constraint on when a row is updated. |
| hashCode() |  |
| equals(Object key) | Gets a value indicating whether the current ForeignKeyConstraint is identical to the specified object. |
| getColumns() | Gets the child columns of this constraint. |
| getRelatedColumns() | The parent columns of this constraint. |
| getTable() | Gets the child table of this constraint. |
| getRelatedTable() | Gets the parent table of this constraint. |
##### ForeignKeyConstraint(String constraintName, DataColumn[] parentColumns, DataColumn[] childColumns)
```
public ForeignKeyConstraint(String constraintName, DataColumn[] parentColumns, DataColumn[] childColumns)
```

Initializes a new instance of the ForeignKeyConstraint class with the specified name, and arrays of parent and child DataColumn objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| constraintName | java.lang.String | The name of the ForeignKeyConstraint. If null or empty string, a default name will be given when added to the constraints collection. |
| parentColumns | DataColumn\[\] | An array of parent DataColumn in the constraint. |
| childColumns | DataColumn\[\] | An array of child DataColumn in the constraint. |

##### ForeignKeyConstraint(DataColumn parentColumn, DataColumn childColumn)
```
public ForeignKeyConstraint(DataColumn parentColumn, DataColumn childColumn)
```

Initializes a new instance of the ForeignKeyConstraint class with the specified parent and child DataColumn objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentColumn | DataColumn | The parent DataColumn in the constraint. |
| childColumn | DataColumn | The child DataColumn in the constraint. |

##### ForeignKeyConstraint(String constraintName, DataColumn parentColumn, DataColumn childColumn)
```
public ForeignKeyConstraint(String constraintName, DataColumn parentColumn, DataColumn childColumn)
```

Initializes a new instance of the ForeignKeyConstraint class with the specified name, parent and child DataColumn objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| constraintName | java.lang.String | The name of the constraint. |
| parentColumn | DataColumn | The parent DataColumn in the constraint. |
| childColumn | DataColumn | The child DataColumn in the constraint. |

##### getDeleteRule()
```
public Rule getDeleteRule()
```

Gets the action that occurs across this constraint when a row is deleted.

**Returns:**
Rule - One of the Rule values. The default is Cascade. The returned value is one of Rule constants.
##### getUpdateRule()
```
public Rule getUpdateRule()
```

Gets the action that occurs across this constraint on when a row is updated.

**Returns:**
Rule - One of the Rule values. The default is Cascade. The returned value is one of Rule constants.
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### equals(Object key)
```
public boolean equals(Object key)
```

Gets a value indicating whether the current ForeignKeyConstraint is identical to the specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.Object | The object to which this ForeignKeyConstraint is compared. Two ForeignKeyConstraint are equal if they constrain the same columns. |

**Returns:**
boolean - true, if the objects are identical; otherwise, false.
##### getColumns()
```
public DataColumn[] getColumns()
```

Gets the child columns of this constraint.

**Returns:**
com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects that are the child columns of the constraint.
##### getRelatedColumns()
```
public DataColumn[] getRelatedColumns()
```

The parent columns of this constraint.

**Returns:**
com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects that are the parent columns of the constraint.
##### getTable()
```
public DataTable getTable()
```

Gets the child table of this constraint.

**Returns:**
DataTable - A DataTable that is the child table in the constraint.
##### getRelatedTable()
```
public DataTable getRelatedTable()
```

Gets the parent table of this constraint.

**Returns:**
DataTable - The parent DataTable of this constraint.

### IDataReader
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/idatareader.md

**All Implemented Interfaces:**
com.groupdocs.assembly.system.data.IDataRecord
```
public interface IDataReader extends IDataRecord
```

Provides a means of reading one or more forward-only streams of result sets obtained by executing a command at a data source, and is implemented by .NET Framework data providers that access relational databases.
#### Methods

| Method | Description |
| --- | --- |
| read() | Advances the IDataReader to the next record. |
| getDepth() | Gets a value indicating the depth of nesting for the current row. |
| isClosed() | Gets a value indicating whether the data reader is closed. |
| getRecordsAffected() | Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. |
| close() | Closes the IDataReader Object. |
| getSchemaTable() | Returns a DataTable that describes the column metadata of the IDataReader. |
| nextResult() | Advances the data reader to the next result, when reading the results of batch SQL statements. |
##### read()
```
public abstract boolean read()
```

Advances the IDataReader to the next record.

**Returns:**
boolean - true if there are more rows; otherwise, false.
##### getDepth()
```
public abstract int getDepth()
```

Gets a value indicating the depth of nesting for the current row.

**Returns:**
int - The level of nesting.
##### isClosed()
```
public abstract boolean isClosed()
```

Gets a value indicating whether the data reader is closed.

**Returns:**
boolean - true if the data reader is closed; otherwise, false.
##### getRecordsAffected()
```
public abstract int getRecordsAffected()
```

Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.

**Returns:**
int - The number of rows changed, inserted, or deleted; 0 if no rows were affected or the statement failed; and -1 for SELECT statements.
##### close()
```
public abstract void close()
```

Closes the IDataReader Object.

##### getSchemaTable()
```
public abstract DataTable getSchemaTable()
```

Returns a DataTable that describes the column metadata of the IDataReader.

**Returns:**
DataTable - A DataTable that describes the column metadata.
##### nextResult()
```
public abstract boolean nextResult()
```

Advances the data reader to the next result, when reading the results of batch SQL statements.

**Returns:**
boolean - true if there are more rows; otherwise, false.

### IDataRecord
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/idatarecord.md

### InvalidConstraintException
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/invalidconstraintexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, java.lang.IllegalStateException
```
public final class InvalidConstraintException extends IllegalStateException
```

Represents the exception that is thrown when incorrectly trying to create or access a relation.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidConstraintException(String s) | Initializes a new instance of the InvalidConstraintException class with the specified string. |
##### InvalidConstraintException(String s)
```
public InvalidConstraintException(String s)
```

Initializes a new instance of the InvalidConstraintException class with the specified string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| s | java.lang.String | The string to display when the exception is thrown. |

### MappingType
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/mappingtype.md

**Inheritance:**
java.lang.Object
```
public class MappingType
```

A utility class providing constants. Specifies how a DataColumn is mapped.
#### Fields

| Field | Description |
| --- | --- |
| ELEMENT | The column is mapped to an XML element. |
| ATTRIBUTE | The column is mapped to an XML attribute. |
| SIMPLE_CONTENT | The column is mapped to a text node. |
| HIDDEN | The column is mapped to an internal structure. |
##### ELEMENT
```
public static final int ELEMENT
```

The column is mapped to an XML element.

##### ATTRIBUTE
```
public static final int ATTRIBUTE
```

The column is mapped to an XML attribute.

##### SIMPLE_CONTENT
```
public static final int SIMPLE_CONTENT
```

The column is mapped to a text node.

##### HIDDEN
```
public static final int HIDDEN
```

The column is mapped to an internal structure.

### Rule
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/rule.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Rule extends Enum<Rule>
```

A utility class providing constants. Indicates the action that occurs when a ForeignKeyConstraint is enforced.
#### Fields

| Field | Description |
| --- | --- |
| NONE | No action taken on related rows. |
| CASCADE | Delete or update related rows. |
| SET_NULL | Set values in related rows to DBNull. |
| SET_DEFAULT | Set values in related rows to the value contained in the DataColumn.getDefaultValue() / DataColumn.setDefaultValue(java.lang.Object) property. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### NONE
```
public static final Rule NONE
```

No action taken on related rows.

##### CASCADE
```
public static final Rule CASCADE
```

Delete or update related rows. This is the default.

##### SET_NULL
```
public static final Rule SET_NULL
```

Set values in related rows to DBNull.

##### SET_DEFAULT
```
public static final Rule SET_DEFAULT
```

Set values in related rows to the value contained in the DataColumn.getDefaultValue() / DataColumn.setDefaultValue(java.lang.Object) property.

##### values()
```
public static Rule[] values()
```

**Returns:**
com.groupdocs.assembly.system.data.Rule[]
##### valueOf(String name)
```
public static Rule valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Rule

### UniqueConstraint
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/uniqueconstraint.md

**Inheritance:**
java.lang.Object, com.groupdocs.assembly.system.data.Constraint
```
public class UniqueConstraint extends Constraint
```

Represents a restriction on a set of columns in which all values must be unique.
#### Constructors

| Constructor | Description |
| --- | --- |
| UniqueConstraint(String name, DataColumn[] columns, boolean isPrimaryKey) | Initializes a new instance of the UniqueConstraint class with the specified name, an array of DataColumn objects to constrain, and a value specifying whether the constraint is a primary key. |
| UniqueConstraint(DataColumn[] columns, boolean isPrimaryKey) | Initializes a new instance of the UniqueConstraint class with an array of DataColumn objects to constrain, and a value specifying whether the constraint is a primary key. |
| UniqueConstraint(DataColumn[] columns) | Initializes a new instance of the UniqueConstraint class with the given array of DataColumn objects. |
| UniqueConstraint(DataColumn column) | Initializes a new instance of the UniqueConstraint class with the specified DataColumn. |
#### Methods

| Method | Description |
| --- | --- |
| hashCode() |  |
| equals(Object key2) | Compares this constraint to a second to determine if both are identical. |
| getColumns() | Gets the array of columns that this constraint affects. |
| isPrimaryKey() | Gets a value indicating whether or not the constraint is on a primary key. |
| getTable() | Gets the table to which this constraint belongs. |
##### UniqueConstraint(String name, DataColumn[] columns, boolean isPrimaryKey)
```
public UniqueConstraint(String name, DataColumn[] columns, boolean isPrimaryKey)
```

Initializes a new instance of the UniqueConstraint class with the specified name, an array of DataColumn objects to constrain, and a value specifying whether the constraint is a primary key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the constraint. |
| columns | DataColumn\[\] | An array of DataColumn objects to constrain. |
| isPrimaryKey | boolean | true to indicate that the constraint is a primary key; otherwise, false. |

##### UniqueConstraint(DataColumn[] columns, boolean isPrimaryKey)
```
public UniqueConstraint(DataColumn[] columns, boolean isPrimaryKey)
```

Initializes a new instance of the UniqueConstraint class with an array of DataColumn objects to constrain, and a value specifying whether the constraint is a primary key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columns | DataColumn\[\] | An array of DataColumn objects to constrain. |
| isPrimaryKey | boolean | true to indicate that the constraint is a primary key; otherwise, false. |

##### UniqueConstraint(DataColumn[] columns)
```
public UniqueConstraint(DataColumn[] columns)
```

Initializes a new instance of the UniqueConstraint class with the given array of DataColumn objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columns | DataColumn\[\] | The array of DataColumn objects to constrain. |

##### UniqueConstraint(DataColumn column)
```
public UniqueConstraint(DataColumn column)
```

Initializes a new instance of the UniqueConstraint class with the specified DataColumn.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DataColumn | The DataColumn to constrain. |

##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### equals(Object key2)
```
public boolean equals(Object key2)
```

Compares this constraint to a second to determine if both are identical.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key2 | java.lang.Object | The object to which this UniqueConstraint is compared. |

**Returns:**
boolean - true, if the contraints are equal; otherwise, false.
##### getColumns()
```
public DataColumn[] getColumns()
```

Gets the array of columns that this constraint affects.

**Returns:**
com.groupdocs.assembly.system.data.DataColumn[] - An array of DataColumn objects.
##### isPrimaryKey()
```
public boolean isPrimaryKey()
```

Gets a value indicating whether or not the constraint is on a primary key.

**Returns:**
boolean - true, if the constraint is on a primary key; otherwise, false.
##### getTable()
```
public DataTable getTable()
```

Gets the table to which this constraint belongs.

**Returns:**
DataTable - The DataTable to which the constraint belongs.

### XmlReadMode
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.data/xmlreadmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum XmlReadMode extends Enum<XmlReadMode>
```

A utility class providing constants. Specifies how to read XML data and a relational schema into a DataSet.
#### Fields

| Field | Description |
| --- | --- |
| AUTO | Default. |
| READ_SCHEMA | Reads any inline schema and loads the data. |
| IGNORE_SCHEMA | Ignores any inline schema and reads data into the existing DataSet schema. |
| INFER_SCHEMA | Ignores any inline schema, infers schema from the data and loads the data. |
| DIFF_GRAM | Reads a DiffGram, applying changes from the DiffGram to the DataSet and preserving DataRow.getRowState() values. |
| FRAGMENT | Reads XML fragments, such as those generated by executing FOR XML queries, against an instance of SQL Server. |
| INFER_TYPED_SCHEMA | Ignores any inline schema, infers a strongly typed schema from the data, and loads the data. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### AUTO
```
public static final XmlReadMode AUTO
```

Default.

##### READ_SCHEMA
```
public static final XmlReadMode READ_SCHEMA
```

Reads any inline schema and loads the data. If the DataSet already contains schema, new tables may be added to the schema, but an exception is thrown if any tables in the inline schema already exist in the DataSet.

##### IGNORE_SCHEMA
```
public static final XmlReadMode IGNORE_SCHEMA
```

Ignores any inline schema and reads data into the existing DataSet schema. If any data does not match the existing schema, it is discarded (including data from differing namespaces defined for the DataSet). If the data is a DiffGram, IgnoreSchema has the same functionality as DiffGram.

##### INFER_SCHEMA
```
public static final XmlReadMode INFER_SCHEMA
```

Ignores any inline schema, infers schema from the data and loads the data. If the DataSet already contains a schema, the current schema is extended by adding new tables or adding columns to existing tables. An exception is thrown if the inferred table already exists but with a different namespace, or if any of the inferred columns conflict with existing columns.

##### DIFF_GRAM
```
public static final XmlReadMode DIFF_GRAM
```

Reads a DiffGram, applying changes from the DiffGram to the DataSet and preserving DataRow.getRowState() values.

##### FRAGMENT
```
public static final XmlReadMode FRAGMENT
```

Reads XML fragments, such as those generated by executing FOR XML queries, against an instance of SQL Server. When XmlReadMode is set to Fragment, the default namespace is read as the inline schema.

##### INFER_TYPED_SCHEMA
```
public static final XmlReadMode INFER_TYPED_SCHEMA
```

Ignores any inline schema, infers a strongly typed schema from the data, and loads the data. If the type cannot be inferred from the data, it is interpreted as string data. If the DataSet already contains a schema, the current schema is extended, either by adding new tables or by adding columns to existing tables. An exception is thrown if the inferred table already exists but with a different namespace, or if any of the inferred columns conflict with existing columns.

##### values()
```
public static XmlReadMode[] values()
```

**Returns:**
com.groupdocs.assembly.system.data.XmlReadMode[]
##### valueOf(String name)
```
public static XmlReadMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmlReadMode

### com.groupdocs.assembly.system.drawing
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.drawing.md

Provides types mimicking .NET types of the `System.Drawing` namespace in Java.

#### Classes

| Class | Description |
| --- | --- |
| GraphicsUnit | Specifies the unit of measure for the given data. |

### GraphicsUnit
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.drawing/graphicsunit.md

**Inheritance:**
java.lang.Object
```
public final class GraphicsUnit
```

Specifies the unit of measure for the given data.
#### Fields

| Field | Description |
| --- | --- |
| WORLD | Specifies the world coordinate system unit as the unit of measure. |
| DISPLAY | Specifies the unit of measure of the display device. |
| PIXEL | Specifies a device pixel as the unit of measure. |
| POINT | Specifies a printer's point (1/72 inch) as the unit of measure. |
| INCH | Specifies the inch as the unit of measure. |
| DOCUMENT | Specifies the document unit (1/300 inch) as the unit of measure. |
| MILLIMETER | Specifies the millimeter as the unit of measure. |
##### WORLD
```
public static final int WORLD
```

Specifies the world coordinate system unit as the unit of measure.

##### DISPLAY
```
public static final int DISPLAY
```

Specifies the unit of measure of the display device. Typically pixels for video displays, and 1/100 inch for printers.

##### PIXEL
```
public static final int PIXEL
```

Specifies a device pixel as the unit of measure.

##### POINT
```
public static final int POINT
```

Specifies a printer's point (1/72 inch) as the unit of measure.

##### INCH
```
public static final int INCH
```

Specifies the inch as the unit of measure.

##### DOCUMENT
```
public static final int DOCUMENT
```

Specifies the document unit (1/300 inch) as the unit of measure.

##### MILLIMETER
```
public static final int MILLIMETER
```

Specifies the millimeter as the unit of measure.

### com.groupdocs.assembly.system
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system.md

Provides types mimicking .NET types of the `System` namespace in Java.

#### Classes

| Class | Description |
| --- | --- |
| OverflowException | The exception that is thrown when an arithmetic, casting, or conversion operation in a checked context results in an overflow. |

### OverflowException
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.system/overflowexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, java.lang.ArithmeticException
```
public final class OverflowException extends ArithmeticException
```

The exception that is thrown when an arithmetic, casting, or conversion operation in a checked context results in an overflow.
#### Constructors

| Constructor | Description |
| --- | --- |
| OverflowException() | Initializes a new instance of the OverflowException class. |
| OverflowException(String message) | Initializes a new instance of the OverflowException class with a specified error message. |
| OverflowException(String message, Throwable cause) | Initializes a new instance of this class. |
##### OverflowException()
```
public OverflowException()
```

Initializes a new instance of the OverflowException class.

##### OverflowException(String message)
```
public OverflowException(String message)
```

Initializes a new instance of the OverflowException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### OverflowException(String message, Throwable cause)
```
public OverflowException(String message, Throwable cause)
```

Initializes a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| cause | java.lang.Throwable |  |

### com.groupdocs.assembly
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly.md

Provides classes for generating documents in popular office file formats based upon template documents and data obtained from various sources including databases, XML, JSON, OData, objects of custom Java types, and more.

The central class of this package is DocumentAssembler. This class incorporates a set of settings to control document generation and performs document generation through its  assembleDocument  overloads.

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSettings | Represents a set of settings controlling barcode generation while assembling a document. |
| CsvDataLoadOptions | Represents options for parsing CSV data. |
| CsvDataSource | Provides access to data of a CSV file or stream to be used while assembling a document. |
| DataSourceInfo | Provides information on a single data source object to be used to assemble a document from a template. |
| DocumentAssembler | Provides routines to populate template documents with data and a set of settings to control these routines. |
| DocumentAssemblyOptions | A utility class providing constants. |
| DocumentTable | Provides access to data of a single table (or spreadsheet) located in an external document to be used while assembling a document. |
| DocumentTableCollection | Represents a read-only collection of DocumentTable objects of a particular DocumentTableSet instance. |
| DocumentTableColumn | Represents a single column of a particular DocumentTable object. |
| DocumentTableColumnCollection | Represents a read-only collection of DocumentTableColumn objects of a particular DocumentTable instance. |
| DocumentTableLoadArgs | Provides data for the IDocumentTableLoadHandler.\#handle(com.groupdocs.assembly.DocumentTableLoadArgs) method. |
| DocumentTableOptions | Provides a set of options to control extraction of data from a document table. |
| DocumentTableRelation | Represents a parent-child relationship between two DocumentTable objects. |
| DocumentTableRelationCollection | Represents the collection of DocumentTableRelation objects of a single DocumentTableSet instance. |
| DocumentTableSet | Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while assembling a document. |
| FileFormat | A utility class providing constants. |
| JsonDataLoadOptions | Represents options for parsing JSON data. |
| JsonDataSource | Provides access to data of a JSON file or stream to be used while assembling a document. |
| JsonSimpleValueParseMode | A utility class providing constants. |
| KnownTypeSet | Represents an unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates to invoke the corresponding types' static members, perform type casts, etc. |
| License | Provides methods to license the component. |
| LoadSaveOptions | Specifies additional options for loading and saving of a document to be assembled. |
| Metered | Provides methods to work with metered licensing. |
| XmlDataLoadOptions | Represents options for XML data loading. |
| XmlDataSource | Provides access to data of an XML file or stream to be used while assembling a document. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentTableLoadHandler | Overrides default loading of DocumentTable objects while creating a DocumentTableSet instance. |

### BarcodeSettings
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/barcodesettings.md

**Inheritance:**
java.lang.Object
```
public class BarcodeSettings
```

Represents a set of settings controlling barcode generation while assembling a document.
#### Methods

| Method | Description |
| --- | --- |
| getGraphicsUnit() | Gets a graphics unit used to measure getBaseXDimension() / setBaseXDimension(float) and getBaseYDimension() / setBaseYDimension(float). |
| setGraphicsUnit(int value) | Sets a graphics unit used to measure getBaseXDimension() / setBaseXDimension(float) and getBaseYDimension() / setBaseYDimension(float). |
| getBaseXDimension() | Gets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. |
| setBaseXDimension(float value) | Sets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. |
| getBaseYDimension() | Gets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules. |
| setBaseYDimension(float value) | Sets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules. |
| getResolution() | Gets the horizontal and vertical resolution of a barcode image being generated. |
| getXResolution() | Gets the horizontal resolution of a barcode image being generated. |
| getYResolution() | Gets the vertical resolution of a barcode image being generated. |
| getUseAutoCorrection() | Gets a value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. |
| setUseAutoCorrection(boolean value) | Sets a value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. |
##### getGraphicsUnit()
```
public int getGraphicsUnit()
```

Gets a graphics unit used to measure getBaseXDimension() / setBaseXDimension(float) and getBaseYDimension() / setBaseYDimension(float). The default value is GraphicsUnit.MILLIMETER.

**Returns:**
int - A graphics unit used to measure getBaseXDimension() / setBaseXDimension(float) and getBaseYDimension() / setBaseYDimension(float). The returned value is one of GraphicsUnit constants.
##### setGraphicsUnit(int value)
```
public void setGraphicsUnit(int value)
```

Sets a graphics unit used to measure getBaseXDimension() / setBaseXDimension(float) and getBaseYDimension() / setBaseYDimension(float). The default value is GraphicsUnit.MILLIMETER.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A graphics unit used to measure getBaseXDimension() / setBaseXDimension(float) and getBaseYDimension() / setBaseYDimension(float). The value must be one of GraphicsUnit constants. |

##### getBaseXDimension()
```
public float getBaseXDimension()
```

Gets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. Measured in getGraphicsUnit() / setGraphicsUnit(int). When barcode scaling is applied through a template, an actual x-dimension is calculated upon the base x-dimension and a scaling factor.

**Returns:**
float - A base x-dimension, that is, the smallest width of the unit of barcode bars and spaces.
##### setBaseXDimension(float value)
```
public void setBaseXDimension(float value)
```

Sets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. Measured in getGraphicsUnit() / setGraphicsUnit(int). When barcode scaling is applied through a template, an actual x-dimension is calculated upon the base x-dimension and a scaling factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | A base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. |

##### getBaseYDimension()
```
public float getBaseYDimension()
```

Gets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules. Measured in getGraphicsUnit() / setGraphicsUnit(int).

Barcodes of some types (such as data matrix) may ignore an y-dimension and use an x-dimension for both width and height units.

When barcode scaling is applied through a template, an actual y-dimension is calculated upon the base y-dimension and a scaling factor.

**Returns:**
float - A base y-dimension, that is, the smallest height of the unit of 2D barcode modules.
##### setBaseYDimension(float value)
```
public void setBaseYDimension(float value)
```

Sets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules. Measured in getGraphicsUnit() / setGraphicsUnit(int).

Barcodes of some types (such as data matrix) may ignore an y-dimension and use an x-dimension for both width and height units.

When barcode scaling is applied through a template, an actual y-dimension is calculated upon the base y-dimension and a scaling factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | A base y-dimension, that is, the smallest height of the unit of 2D barcode modules. |

##### getResolution()
```
public float getResolution()
```

Gets the horizontal and vertical resolution of a barcode image being generated. Measured in dots per inch. The default value is 96.

**Returns:**
float - The horizontal and vertical resolution of a barcode image being generated.
##### getXResolution()
```
public float getXResolution()
```

Gets the horizontal resolution of a barcode image being generated. Measured in dots per inch. The default value is 96.

**Returns:**
float - The horizontal resolution of a barcode image being generated.
##### getYResolution()
```
public float getYResolution()
```

Gets the vertical resolution of a barcode image being generated. Measured in dots per inch. The default value is 96.

**Returns:**
float - The vertical resolution of a barcode image being generated.
##### getUseAutoCorrection()
```
public boolean getUseAutoCorrection()
```

Gets a value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. The default value is true. The auto-correction is not possible for Databar barcodes.

**Returns:**
boolean - A value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error.
##### setUseAutoCorrection(boolean value)
```
public void setUseAutoCorrection(boolean value)
```

Sets a value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. The default value is true. The auto-correction is not possible for Databar barcodes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. |

### CsvDataLoadOptions
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/csvdataloadoptions.md

**Inheritance:**
java.lang.Object
```
public class CsvDataLoadOptions
```

Represents options for parsing CSV data. An instance of this class can be passed into constructors of CsvDataSource.
#### Constructors

| Constructor | Description |
| --- | --- |
| CsvDataLoadOptions() | Initializes a new instance of this class with default options. |
| CsvDataLoadOptions(boolean hasHeaders) | Initializes a new instance of this class with specifying whether CSV data contains column names at the first line. |
#### Methods

| Method | Description |
| --- | --- |
| hasHeaders() | Gets a value indicating whether the first line of CSV data contains column names. |
| hasHeaders(boolean value) | Sets a value indicating whether the first line of CSV data contains column names. |
| getDelimiter() | Gets the character to be used as a column delimiter. |
| setDelimiter(char value) | Sets the character to be used as a column delimiter. |
| getQuoteChar() | Gets the character that is used to quote field values. |
| setQuoteChar(char value) | Sets the character that is used to quote field values. |
| getCommentChar() | Gets the character that is used to comment lines of CSV data. |
| setCommentChar(char value) | Sets the character that is used to comment lines of CSV data. |
##### CsvDataLoadOptions()
```
public CsvDataLoadOptions()
```

Initializes a new instance of this class with default options.

##### CsvDataLoadOptions(boolean hasHeaders)
```
public CsvDataLoadOptions(boolean hasHeaders)
```

Initializes a new instance of this class with specifying whether CSV data contains column names at the first line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| hasHeaders | boolean |  |

##### hasHeaders()
```
public boolean hasHeaders()
```

Gets a value indicating whether the first line of CSV data contains column names. The default value is **false**.

**Returns:**
boolean - A value indicating whether the first line of CSV data contains column names.
##### hasHeaders(boolean value)
```
public void hasHeaders(boolean value)
```

Sets a value indicating whether the first line of CSV data contains column names. The default value is **false**.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the first line of CSV data contains column names. |

##### getDelimiter()
```
public char getDelimiter()
```

Gets the character to be used as a column delimiter. The default value is ',' (comma).

**Returns:**
char - The character to be used as a column delimiter.
##### setDelimiter(char value)
```
public void setDelimiter(char value)
```

Sets the character to be used as a column delimiter. The default value is ',' (comma).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char | The character to be used as a column delimiter. |

##### getQuoteChar()
```
public char getQuoteChar()
```

Gets the character that is used to quote field values.

The default value is '"' (quotation mark).

Double the character to place it into quoted text.

**Returns:**
char - The character that is used to quote field values.
##### setQuoteChar(char value)
```
public void setQuoteChar(char value)
```

Sets the character that is used to quote field values.

The default value is '"' (quotation mark).

Double the character to place it into quoted text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char | The character that is used to quote field values. |

##### getCommentChar()
```
public char getCommentChar()
```

Gets the character that is used to comment lines of CSV data. The default value is '\#' (number sign).

**Returns:**
char - The character that is used to comment lines of CSV data.
##### setCommentChar(char value)
```
public void setCommentChar(char value)
```

Sets the character that is used to comment lines of CSV data. The default value is '\#' (number sign).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char | The character that is used to comment lines of CSV data. |

### CsvDataSource
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/csvdatasource.md

**Inheritance:**
java.lang.Object
```
public class CsvDataSource
```

Provides access to data of a CSV file or stream to be used while assembling a document.

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. assembleDocument overloads.

In template documents, a CsvDataSource instance should be treated in the same way as if it was a DataTable instance. For more information, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

Data types of comma-separated values are determined automatically upon their string representations. So in template documents, you can work with typed values rather than just strings. The engine is capable to automatically recognize values of the following types:

 *   java.lang.Long
 *   java.lang.Double
 *   java.lang.Boolean
 *   java.util.Date
 *   java.lang.String

Note that for automatic recognition of data types to work, string representations of comma-separated values should be formed using invariant culture settings.

To override default behavior of CSV data loading, initialize and pass a CsvDataLoadOptions instance to a constructor of this class.
#### Constructors

| Constructor | Description |
| --- | --- |
| CsvDataSource(String csvPath) | Creates a new data source with data from a CSV file using default options for parsing CSV data. |
| CsvDataSource(String csvPath, CsvDataLoadOptions options) | Creates a new data source with data from a CSV file using the specified options for parsing CSV data. |
| CsvDataSource(InputStream csvStream) | Creates a new data source with data from a CSV stream using default options for parsing CSV data. |
| CsvDataSource(InputStream csvStream, CsvDataLoadOptions options) | Creates a new data source with data from a CSV stream using the specified options for parsing CSV data. |
##### CsvDataSource(String csvPath)
```
public CsvDataSource(String csvPath)
```

Creates a new data source with data from a CSV file using default options for parsing CSV data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| csvPath | java.lang.String | The path to the CSV file to be used as the data source. |

##### CsvDataSource(String csvPath, CsvDataLoadOptions options)
```
public CsvDataSource(String csvPath, CsvDataLoadOptions options)
```

Creates a new data source with data from a CSV file using the specified options for parsing CSV data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| csvPath | java.lang.String | The path to the CSV file to be used as the data source. |
| options | CsvDataLoadOptions | Options for parsing the CSV data. |

##### CsvDataSource(InputStream csvStream)
```
public CsvDataSource(InputStream csvStream)
```

Creates a new data source with data from a CSV stream using default options for parsing CSV data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| csvStream | java.io.InputStream | The stream of CSV data to be used as the data source. |

##### CsvDataSource(InputStream csvStream, CsvDataLoadOptions options)
```
public CsvDataSource(InputStream csvStream, CsvDataLoadOptions options)
```

Creates a new data source with data from a CSV stream using the specified options for parsing CSV data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| csvStream | java.io.InputStream | The stream of CSV data to be used as the data source. |
| options | CsvDataLoadOptions | Options for parsing the CSV data. |

### DataSourceInfo
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/datasourceinfo.md

**Inheritance:**
java.lang.Object
```
public class DataSourceInfo
```

Provides information on a single data source object to be used to assemble a document from a template.
#### Constructors

| Constructor | Description |
| --- | --- |
| DataSourceInfo() | Creates a new instance of this class without any properties specified. |
| DataSourceInfo(Object dataSource) | Creates a new instance of this class with the data source object specified. |
| DataSourceInfo(Object dataSource, String name) | Creates a new instance of this class with the data source object and its name specified. |
#### Methods

| Method | Description |
| --- | --- |
| getDataSource() | Gets the data source object. |
| setDataSource(Object value) | Sets the data source object. |
| getName() | Gets the name of the data source object to be used to access the data source object in a template document. |
| setName(String value) | Sets the name of the data source object to be used to access the data source object in a template document. |
##### DataSourceInfo()
```
public DataSourceInfo()
```

Creates a new instance of this class without any properties specified.

##### DataSourceInfo(Object dataSource)
```
public DataSourceInfo(Object dataSource)
```

Creates a new instance of this class with the data source object specified.

The data source object can be of one of the following types:

 *  XmlDataSource
 *  JsonDataSource
 *  CsvDataSource
 *  DocumentTableSet
 *  DocumentTable
 *  DataSet
 *  DataTable
 *  DataRow
 *  IDataReader
 *  IDataRecord
 *  DataView
 *  DataRowView
 *  Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSource | java.lang.Object | The data source object. |

##### DataSourceInfo(Object dataSource, String name)
```
public DataSourceInfo(Object dataSource, String name)
```

Creates a new instance of this class with the data source object and its name specified.

The data source object can be of one of the following types:

 *  XmlDataSource
 *  JsonDataSource
 *  CsvDataSource
 *  DocumentTableSet
 *  DocumentTable
 *  DataSet
 *  DataTable
 *  DataRow
 *  IDataReader
 *  IDataRecord
 *  DataView
 *  DataRowView
 *  Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple DataSourceInfo instances to DocumentAssembler, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSource | java.lang.Object | The data source object. |
| name | java.lang.String | The name of the data source object to be used to access the data source object in a template document. |

##### getDataSource()
```
public Object getDataSource()
```

Gets the data source object.

The data source object can be of one of the following types:

 *  XmlDataSource
 *  JsonDataSource
 *  CsvDataSource
 *  DocumentTableSet
 *  DocumentTable
 *  DataSet
 *  DataTable
 *  DataRow
 *  IDataReader
 *  IDataRecord
 *  DataView
 *  DataRowView
 *  Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

**Returns:**
java.lang.Object - The data source object.
##### setDataSource(Object value)
```
public void setDataSource(Object value)
```

Sets the data source object.

The data source object can be of one of the following types:

 *  XmlDataSource
 *  JsonDataSource
 *  CsvDataSource
 *  DocumentTableSet
 *  DocumentTable
 *  DataSet
 *  DataTable
 *  DataRow
 *  IDataReader
 *  IDataRecord
 *  DataView
 *  DataRowView
 *  Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | The data source object. |

##### getName()
```
public String getName()
```

Gets the name of the data source object to be used to access the data source object in a template document.

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple DataSourceInfo instances to DocumentAssembler, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

**Returns:**
java.lang.String - The name of the data source object to be used to access the data source object in a template document.
##### setName(String value)
```
public void setName(String value)
```

Sets the name of the data source object to be used to access the data source object in a template document.

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple DataSourceInfo instances to DocumentAssembler, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the data source object to be used to access the data source object in a template document. |

### DocumentAssembler
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documentassembler.md

**Inheritance:**
java.lang.Object
```
public class DocumentAssembler
```

Provides routines to populate template documents with data and a set of settings to control these routines.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentAssembler() | Initializes a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| assembleDocument(String sourcePath, String targetPath, DataSourceInfo[] dataSourceInfos) | Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using default LoadSaveOptions. |
| assembleDocument(String sourcePath, String targetPath, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos) | Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using the given LoadSaveOptions. |
| assembleDocument(InputStream sourceStream, OutputStream targetStream, DataSourceInfo[] dataSourceInfos) | Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using default LoadSaveOptions. |
| assembleDocument(InputStream sourceStream, OutputStream targetStream, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos) | Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using the given LoadSaveOptions. |
| getOptions() | Gets a set of flags controlling behavior of this DocumentAssembler instance while assembling a document. |
| setOptions(int value) | Sets a set of flags controlling behavior of this DocumentAssembler instance while assembling a document. |
| getBarcodeSettings() | Gets a set of settings controlling barcode generation while assembling a document. |
| getKnownTypes() | Gets an unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types' static members, perform type casts, etc. |
| getUseReflectionOptimization() | Gets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. |
| setUseReflectionOptimization(boolean value) | Sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. |
##### DocumentAssembler()
```
public DocumentAssembler()
```

Initializes a new instance of this class.

##### assembleDocument(String sourcePath, String targetPath, DataSourceInfo[] dataSourceInfos)
```
public boolean assembleDocument(String sourcePath, String targetPath, DataSourceInfo[] dataSourceInfos)
```

Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using default LoadSaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | java.lang.String | The path to a template document to be populated with data. |
| targetPath | java.lang.String | The path to a result document. |
| dataSourceInfos | DataSourceInfo\[\] | Provides information on data source objects to be used. |

**Returns:**
boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE\_ERROR\_MESSAGES option.
##### assembleDocument(String sourcePath, String targetPath, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos)
```
public boolean assembleDocument(String sourcePath, String targetPath, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos)
```

Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using the given LoadSaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | java.lang.String | The path to a template document to be populated with data. |
| targetPath | java.lang.String | The path to a result document. |
| loadSaveOptions | LoadSaveOptions | Specifies additional options for document loading and saving. |
| dataSourceInfos | DataSourceInfo\[\] | Provides information on data source objects to be used. |

**Returns:**
boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE\_ERROR\_MESSAGES option.
##### assembleDocument(InputStream sourceStream, OutputStream targetStream, DataSourceInfo[] dataSourceInfos)
```
public boolean assembleDocument(InputStream sourceStream, OutputStream targetStream, DataSourceInfo[] dataSourceInfos)
```

Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using default LoadSaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | java.io.InputStream | The stream to read a template document from. |
| targetStream | java.io.OutputStream | The stream to write a result document. |
| dataSourceInfos | DataSourceInfo\[\] | Provides information on data source objects to be used. |

**Returns:**
boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE\_ERROR\_MESSAGES option.
##### assembleDocument(InputStream sourceStream, OutputStream targetStream, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos)
```
public boolean assembleDocument(InputStream sourceStream, OutputStream targetStream, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos)
```

Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using the given LoadSaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | java.io.InputStream | The stream to read a template document from. |
| targetStream | java.io.OutputStream | The stream to write a result document. |
| loadSaveOptions | LoadSaveOptions | Specifies additional options for document loading and saving. |
| dataSourceInfos | DataSourceInfo\[\] | Provides information on data source objects to be used. |

**Returns:**
boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE\_ERROR\_MESSAGES option.
##### getOptions()
```
public int getOptions()
```

Gets a set of flags controlling behavior of this DocumentAssembler instance while assembling a document.

**Returns:**
int - A set of flags controlling behavior of this DocumentAssembler instance while assembling a document. The returned value is a bitwise combination of DocumentAssemblyOptions constants.
##### setOptions(int value)
```
public void setOptions(int value)
```

Sets a set of flags controlling behavior of this DocumentAssembler instance while assembling a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A set of flags controlling behavior of this DocumentAssembler instance while assembling a document. The value must be a bitwise combination of DocumentAssemblyOptions constants. |

##### getBarcodeSettings()
```
public BarcodeSettings getBarcodeSettings()
```

Gets a set of settings controlling barcode generation while assembling a document.

**Returns:**
BarcodeSettings - A set of settings controlling barcode generation while assembling a document.
##### getKnownTypes()
```
public KnownTypeSet getKnownTypes()
```

Gets an unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types' static members, perform type casts, etc.

**Returns:**
KnownTypeSet - An unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types' static members, perform type casts, etc.
##### getUseReflectionOptimization()
```
public static boolean getUseReflectionOptimization()
```

Gets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true. There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls.

**Returns:**
boolean - A value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not.
##### setUseReflectionOptimization(boolean value)
```
public static void setUseReflectionOptimization(boolean value)
```

Sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true. There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. |

### DocumentAssemblyOptions
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documentassemblyoptions.md

**Inheritance:**
java.lang.Object
```
public final class DocumentAssemblyOptions
```

A utility class providing constants. Specifies options controlling behavior of DocumentAssembler while assembling a document.
#### Fields

| Field | Description |
| --- | --- |
| NONE | Specifies default options. |
| ALLOW_MISSING_MEMBERS | Specifies that missing object members should be treated as null literals by the assembler. |
| UPDATE_FIELDS_AND_FORMULAS | Specifies that fields of result Word Processing documents and formulas of result Spreadsheet documents should be updated by the assembler. |
| REMOVE_EMPTY_PARAGRAPHS | Specifies that the assembler should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values. |
| INLINE_ERROR_MESSAGES | Specifies that the assembler should inline template syntax error messages into output documents. |
| USE_SPREADSHEET_DATA_TYPES | Relates to Spreadsheet documents only. |
| length |  |
#### Methods

| Method | Description |
| --- | --- |
| getName(int documentAssemblyOptions) |  |
| getNames(int documentAssemblyOptions) |  |
| toString(int documentAssemblyOptions) |  |
| fromName(String documentAssemblyOptionsName) |  |
| fromNames(Set documentAssemblyOptionsNames) |  |
| getValues() |  |
##### NONE
```
public static final int NONE
```

Specifies default options.

##### ALLOW_MISSING_MEMBERS
```
public static final int ALLOW_MISSING_MEMBERS
```

Specifies that missing object members should be treated as null literals by the assembler. This option affects only access to instance (that is, non-static) object members and extension methods. If this option is not set, the assembler throws an exception when encounters a missing object member.

##### UPDATE_FIELDS_AND_FORMULAS
```
public static final int UPDATE_FIELDS_AND_FORMULAS
```

Specifies that fields of result Word Processing documents and formulas of result Spreadsheet documents should be updated by the assembler.

##### REMOVE_EMPTY_PARAGRAPHS
```
public static final int REMOVE_EMPTY_PARAGRAPHS
```

Specifies that the assembler should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values. At the moment, this option is supported only for templates of Word Processing, Presentation, and Email file formats.

##### INLINE_ERROR_MESSAGES
```
public static final int INLINE_ERROR_MESSAGES
```

Specifies that the assembler should inline template syntax error messages into output documents. If this option is not set, the assembler throws an exception when encounters a syntax error.

##### USE_SPREADSHEET_DATA_TYPES
```
public static final int USE_SPREADSHEET_DATA_TYPES
```

Relates to Spreadsheet documents only. Specifies that evaluated expression results should be mapped to corresponding Spreadsheet data types, which also affects their default formatting within cells. If this option is not set, expression results are always written as strings by the assembler. This option has no effect when expression results are formatted using template syntax - expression results are always written as strings then as well.

##### length
```
public static final int length
```

##### getName(int documentAssemblyOptions)
```
public static String getName(int documentAssemblyOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentAssemblyOptions | int |  |

**Returns:**
java.lang.String
##### getNames(int documentAssemblyOptions)
```
public static Set getNames(int documentAssemblyOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentAssemblyOptions | int |  |

**Returns:**
java.util.Set
##### toString(int documentAssemblyOptions)
```
public static String toString(int documentAssemblyOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentAssemblyOptions | int |  |

**Returns:**
java.lang.String
##### fromName(String documentAssemblyOptionsName)
```
public static int fromName(String documentAssemblyOptionsName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentAssemblyOptionsName | java.lang.String |  |

**Returns:**
int
##### fromNames(Set documentAssemblyOptionsNames)
```
public static int fromNames(Set documentAssemblyOptionsNames)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentAssemblyOptionsNames | java.util.Set |  |

**Returns:**
int
##### getValues()
```
public static int[] getValues()
```

**Returns:**
int[]

### DocumentTable
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttable.md

**Inheritance:**
java.lang.Object
```
public class DocumentTable
```

Provides access to data of a single table (or spreadsheet) located in an external document to be used while assembling a document.

For documents of Spreadsheet file formats, a DocumentTable instance represents a single sheet. For documents of other file formats, a DocumentTable instance represents a single table.

To access data of the corresponding table while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. assembleDocument overloads.

In template documents, a DocumentTable instance should be treated in the same way as if it was a DataTable instance. See template syntax reference for more information.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentTable(String documentPath, int indexInDocument) | Creates a new instance of this class using default DocumentTableOptions. |
| DocumentTable(String documentPath, int indexInDocument, DocumentTableOptions options) | Creates a new instance of this class. |
| DocumentTable(InputStream documentStream, int indexInDocument) | Creates a new instance of this class using default DocumentTableOptions. |
| DocumentTable(InputStream documentStream, int indexInDocument, DocumentTableOptions options) | Creates a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of this table used to access the table's data in a template document passed to DocumentAssembler. |
| setName(String value) | Sets the name of this table used to access the table's data in a template document passed to DocumentAssembler. |
| getIndexInDocument() | Gets the original zero-based index of the corresponding table as per the source document. |
| getColumns() | Gets the collection of DocumentTableColumn objects representing columns of the corresponding table. |
##### DocumentTable(String documentPath, int indexInDocument)
```
public DocumentTable(String documentPath, int indexInDocument)
```

Creates a new instance of this class using default DocumentTableOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | java.lang.String | The path to a document containing the table to be accessed. |
| indexInDocument | int | The zero-based index of the table in the document. |

##### DocumentTable(String documentPath, int indexInDocument, DocumentTableOptions options)
```
public DocumentTable(String documentPath, int indexInDocument, DocumentTableOptions options)
```

Creates a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | java.lang.String | The path to a document containing the table to be accessed. |
| indexInDocument | int | The zero-based index of the table in the document. |
| options | DocumentTableOptions | A set of options controlling extraction of data from the table. If null, default options are applied. |

##### DocumentTable(InputStream documentStream, int indexInDocument)
```
public DocumentTable(InputStream documentStream, int indexInDocument)
```

Creates a new instance of this class using default DocumentTableOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | java.io.InputStream | The stream containing a document with the table to be accessed. |
| indexInDocument | int | The zero-based index of the table in the document. |

##### DocumentTable(InputStream documentStream, int indexInDocument, DocumentTableOptions options)
```
public DocumentTable(InputStream documentStream, int indexInDocument, DocumentTableOptions options)
```

Creates a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | java.io.InputStream | The stream containing a document with the table to be accessed. |
| indexInDocument | int | The zero-based index of the table in the document. |
| options | DocumentTableOptions | A set of options controlling extraction of data from the table. If null, default options are applied. |

##### getName()
```
public String getName()
```

Gets the name of this table used to access the table's data in a template document passed to DocumentAssembler.

If the table's name is read from a document, the name is automatically corrected so that it to be valid. However, if the table's name is set manually through this property and the name is invalid, an exception is thrown.

The table's name is considered to be valid, if the following conditions are met:

 *  The name is not empty.
 *  The name's first character is a letter or underscore.
 *  The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '\#', '$'.
 *  The corresponding DocumentTableSet object does not contain a DocumentTable instance with the same name.

**Returns:**
java.lang.String - The name of this table used to access the table's data in a template document passed to DocumentAssembler.
##### setName(String value)
```
public void setName(String value)
```

Sets the name of this table used to access the table's data in a template document passed to DocumentAssembler.

If the table's name is read from a document, the name is automatically corrected so that it to be valid. However, if the table's name is set manually through this property and the name is invalid, an exception is thrown.

The table's name is considered to be valid, if the following conditions are met:

 *  The name is not empty.
 *  The name's first character is a letter or underscore.
 *  The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '\#', '$'.
 *  The corresponding DocumentTableSet object does not contain a DocumentTable instance with the same name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of this table used to access the table's data in a template document passed to DocumentAssembler. |

##### getIndexInDocument()
```
public int getIndexInDocument()
```

Gets the original zero-based index of the corresponding table as per the source document. Depending on an IDocumentTableLoadHandler implementation provided, this index may differ from the index of this DocumentTable instance within the table collection of the corresponding DocumentTableSet instance, if any.

**Returns:**
int - The original zero-based index of the corresponding table as per the source document.
##### getColumns()
```
public DocumentTableColumnCollection getColumns()
```

Gets the collection of DocumentTableColumn objects representing columns of the corresponding table.

**Returns:**
DocumentTableColumnCollection - The collection of DocumentTableColumn objects representing columns of the corresponding table.

### DocumentTableCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttablecollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class DocumentTableCollection implements Iterable
```

Represents a read-only collection of DocumentTable objects of a particular DocumentTableSet instance. The collection is filled automatically while loading the corresponding tables from a document and can not be modified. However, properties of DocumentTable objects contained within the collection can be modified.
#### Methods

| Method | Description |
| --- | --- |
| iterator() | Returns an enumerator to iterate DocumentTable objects of this collection. |
| contains(String name) | Returns a value indicating whether this collection contains a table with the specified name. |
| contains(DocumentTable table) | Returns a value indicating whether this collection contains the specified table. |
| indexOf(String name) | Returns the index of a table with the specified name within this collection. |
| indexOf(DocumentTable table) | Returns the index of the specified table within this collection. |
| get(int index) | Gets a DocumentTable instance from the collection at the specified index. |
| get(String name) | Gets a DocumentTable instance with the specified name from the collection. |
| getCount() | Gets the total number of DocumentTable objects in the collection. |
##### iterator()
```
public Iterator iterator()
```

Returns an enumerator to iterate DocumentTable objects of this collection.

**Returns:**
java.util.Iterator - An enumerator to iterate DocumentTable objects of this collection.
##### contains(String name)
```
public boolean contains(String name)
```

Returns a value indicating whether this collection contains a table with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of a table to look for. |

**Returns:**
boolean - A value indicating whether this collection contains a table with the specified name.
##### contains(DocumentTable table)
```
public boolean contains(DocumentTable table)
```

Returns a value indicating whether this collection contains the specified table.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| table | DocumentTable | A table to look for. |

**Returns:**
boolean - A value indicating whether this collection contains the specified table.
##### indexOf(String name)
```
public int indexOf(String name)
```

Returns the index of a table with the specified name within this collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of a table to find. |

**Returns:**
int - The zero-based index of a table with the specified name, or -1 if the table does not exist in this collection.
##### indexOf(DocumentTable table)
```
public int indexOf(DocumentTable table)
```

Returns the index of the specified table within this collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| table | DocumentTable | A table to find. |

**Returns:**
int - The zero-based index of the specified table, or -1 if the table does not exist in this collection.
##### get(int index)
```
public DocumentTable get(int index)
```

Gets a DocumentTable instance from the collection at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the table to return. |

**Returns:**
DocumentTable - A DocumentTable instance from the collection at the specified index.
##### get(String name)
```
public DocumentTable get(String name)
```

Gets a DocumentTable instance with the specified name from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the table to return. |

**Returns:**
DocumentTable - A DocumentTable instance with the specified name from the collection or null if such an instance does not exist.
##### getCount()
```
public int getCount()
```

Gets the total number of DocumentTable objects in the collection.

**Returns:**
int - The total number of DocumentTable objects in the collection.

### DocumentTableColumn
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttablecolumn.md

**Inheritance:**
java.lang.Object
```
public class DocumentTableColumn
```

Represents a single column of a particular DocumentTable object.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of this column used to access the column's data in a template document passed to DocumentAssembler. |
| setName(String value) | Sets the name of this column used to access the column's data in a template document passed to DocumentAssembler. |
| getIndexInDocument() | Gets the original zero-based index of the corresponding table column as per the source document. |
| getType() | Gets the type of cell values in this column. |
| setType(Class value) | Sets the type of cell values in this column. |
| getAllowsNull() | Gets a value indicating whether cells in this column contain null values or not. |
##### getName()
```
public String getName()
```

Gets the name of this column used to access the column's data in a template document passed to DocumentAssembler.

If the column's name is read from a document (see DocumentTableOptions.getFirstRowContainsColumnNames() / DocumentTableOptions.setFirstRowContainsColumnNames(boolean)), the name is automatically corrected so that it to be valid. However, if the column's name is set manually through this property and the name is invalid, an exception is thrown.

The column's name is considered to be valid, if the following conditions are met:

 *  The name is not empty.
 *  The name's first character is a letter or underscore.
 *  The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '\#', '$'.
 *  The corresponding DocumentTable object does not contain a DocumentTableColumn instance with the same name.

**Returns:**
java.lang.String - The name of this column used to access the column's data in a template document passed to DocumentAssembler.
##### setName(String value)
```
public void setName(String value)
```

Sets the name of this column used to access the column's data in a template document passed to DocumentAssembler.

If the column's name is read from a document (see DocumentTableOptions.getFirstRowContainsColumnNames() / DocumentTableOptions.setFirstRowContainsColumnNames(boolean)), the name is automatically corrected so that it to be valid. However, if the column's name is set manually through this property and the name is invalid, an exception is thrown.

The column's name is considered to be valid, if the following conditions are met:

 *  The name is not empty.
 *  The name's first character is a letter or underscore.
 *  The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '\#', '$'.
 *  The corresponding DocumentTable object does not contain a DocumentTableColumn instance with the same name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of this column used to access the column's data in a template document passed to DocumentAssembler. |

##### getIndexInDocument()
```
public int getIndexInDocument()
```

Gets the original zero-based index of the corresponding table column as per the source document. Depending on DocumentTableOptions specified, this index may differ from the index of this DocumentTableColumn instance within the column collection of the corresponding DocumentTable instance.

**Returns:**
int - The original zero-based index of the corresponding table column as per the source document.
##### getType()
```
public Class getType()
```

Gets the type of cell values in this column.

For documents of non-Spreadsheet file formats, the initial type is always automatically determined as string. For documents of Spreadsheet file formats, the initial type is automatically determined depending on corresponding cell values.

If cells of a particular Spreadsheet column contain values of different types, then the column's initial type is also automatically determined as string.

**Returns:**
java.lang.Class - The type of cell values in this column.
##### setType(Class value)
```
public void setType(Class value)
```

Sets the type of cell values in this column.

For documents of non-Spreadsheet file formats, the initial type is always automatically determined as string. For documents of Spreadsheet file formats, the initial type is automatically determined depending on corresponding cell values.

If cells of a particular Spreadsheet column contain values of different types, then the column's initial type is also automatically determined as string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Class | The type of cell values in this column. |

##### getAllowsNull()
```
public boolean getAllowsNull()
```

Gets a value indicating whether cells in this column contain null values or not. Undefined and error values in cells of Spreadsheet documents are also considered to be null.

**Returns:**
boolean - A value indicating whether cells in this column contain null values or not.

### DocumentTableColumnCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttablecolumncollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class DocumentTableColumnCollection implements Iterable
```

Represents a read-only collection of DocumentTableColumn objects of a particular DocumentTable instance. The collection is filled automatically while loading the corresponding table from a document and can not be modified. However, properties of DocumentTableColumn objects contained within the collection can be modified.
#### Methods

| Method | Description |
| --- | --- |
| iterator() | Returns an enumerator to iterate DocumentTableColumn objects of this collection. |
| contains(String name) | Returns a value indicating whether this collection contains a column with the specified name. |
| contains(DocumentTableColumn column) | Returns a value indicating whether this collection contains the specified column. |
| indexOf(String name) | Returns the index of a column with the specified name within this collection. |
| indexOf(DocumentTableColumn column) | Returns the index of the specified column within this collection. |
| get(int index) | Gets a DocumentTableColumn instance from the collection at the specified index. |
| get(String name) | Gets a DocumentTableColumn instance with the specified name from the collection. |
| getCount() | Gets the total number of DocumentTableColumn objects in the collection. |
##### iterator()
```
public Iterator iterator()
```

Returns an enumerator to iterate DocumentTableColumn objects of this collection.

**Returns:**
java.util.Iterator - An enumerator to iterate DocumentTableColumn objects of this collection.
##### contains(String name)
```
public boolean contains(String name)
```

Returns a value indicating whether this collection contains a column with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of a column to look for. |

**Returns:**
boolean - A value indicating whether this collection contains a column with the specified name.
##### contains(DocumentTableColumn column)
```
public boolean contains(DocumentTableColumn column)
```

Returns a value indicating whether this collection contains the specified column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DocumentTableColumn | A column to look for. |

**Returns:**
boolean - A value indicating whether this collection contains the specified column.
##### indexOf(String name)
```
public int indexOf(String name)
```

Returns the index of a column with the specified name within this collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of a column to find. |

**Returns:**
int - The zero-based index of a column with the specified name, or -1 if the column does not exist in this collection.
##### indexOf(DocumentTableColumn column)
```
public int indexOf(DocumentTableColumn column)
```

Returns the index of the specified column within this collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | DocumentTableColumn | A column to find. |

**Returns:**
int - The zero-based index of the specified column, or -1 if the column does not exist in this collection.
##### get(int index)
```
public DocumentTableColumn get(int index)
```

Gets a DocumentTableColumn instance from the collection at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the column to return. |

**Returns:**
DocumentTableColumn - A DocumentTableColumn instance from the collection at the specified index.
##### get(String name)
```
public DocumentTableColumn get(String name)
```

Gets a DocumentTableColumn instance with the specified name from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the column to return. |

**Returns:**
DocumentTableColumn - A DocumentTableColumn instance with the specified name from the collection or null if such an instance does not exist.
##### getCount()
```
public int getCount()
```

Gets the total number of DocumentTableColumn objects in the collection.

**Returns:**
int - The total number of DocumentTableColumn objects in the collection.

### DocumentTableLoadArgs
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttableloadargs.md

**Inheritance:**
java.lang.Object
```
public class DocumentTableLoadArgs
```

Provides data for the IDocumentTableLoadHandler.handle(com.groupdocs.assembly.DocumentTableLoadArgs) method.
#### Methods

| Method | Description |
| --- | --- |
| getTableIndex() | Gets the zero-based index of the corresponding document table to be loaded. |
| isLoaded() | Gets a value indicating whether the corresponding document table is to be loaded or not. |
| isLoaded(boolean value) | Sets a value indicating whether the corresponding document table is to be loaded or not. |
| getOptions() | Gets DocumentTableOptions to be used while loading the corresponding document table. |
| setOptions(DocumentTableOptions value) | Sets DocumentTableOptions to be used while loading the corresponding document table. |
##### getTableIndex()
```
public int getTableIndex()
```

Gets the zero-based index of the corresponding document table to be loaded.

**Returns:**
int - The zero-based index of the corresponding document table to be loaded.
##### isLoaded()
```
public boolean isLoaded()
```

Gets a value indicating whether the corresponding document table is to be loaded or not. The default value is true.

**Returns:**
boolean - A value indicating whether the corresponding document table is to be loaded or not.
##### isLoaded(boolean value)
```
public void isLoaded(boolean value)
```

Sets a value indicating whether the corresponding document table is to be loaded or not. The default value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the corresponding document table is to be loaded or not. |

##### getOptions()
```
public DocumentTableOptions getOptions()
```

Gets DocumentTableOptions to be used while loading the corresponding document table. The default value is null, which means that default DocumentTableOptions are to be applied.

**Returns:**
DocumentTableOptions - DocumentTableOptions to be used while loading the corresponding document table.
##### setOptions(DocumentTableOptions value)
```
public void setOptions(DocumentTableOptions value)
```

Sets DocumentTableOptions to be used while loading the corresponding document table. The default value is null, which means that default DocumentTableOptions are to be applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DocumentTableOptions | DocumentTableOptions to be used while loading the corresponding document table. |

### DocumentTableOptions
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttableoptions.md

**Inheritance:**
java.lang.Object
```
public class DocumentTableOptions
```

Provides a set of options to control extraction of data from a document table.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentTableOptions() | Creates a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| getMinRowIndex() | Gets the smallest zero-based index of a row to be extracted from a document table. |
| setMinRowIndex(int value) | Sets the smallest zero-based index of a row to be extracted from a document table. |
| getMaxRowIndex() | Gets the largest zero-based index of a row to be extracted from a document table. |
| setMaxRowIndex(int value) | Sets the largest zero-based index of a row to be extracted from a document table. |
| getMinColumnIndex() | Gets the smallest zero-based index of a column to be extracted from a document table. |
| setMinColumnIndex(int value) | Sets the smallest zero-based index of a column to be extracted from a document table. |
| getMaxColumnIndex() | Gets the largest zero-based index of a column to be extracted from a document table. |
| setMaxColumnIndex(int value) | Sets the largest zero-based index of a column to be extracted from a document table. |
| getFirstRowContainsColumnNames() | Gets a value indicating whether column names are to be obtained from the first extracted row of a document table. |
| setFirstRowContainsColumnNames(boolean value) | Sets a value indicating whether column names are to be obtained from the first extracted row of a document table. |
##### DocumentTableOptions()
```
public DocumentTableOptions()
```

Creates a new instance of this class.

##### getMinRowIndex()
```
public int getMinRowIndex()
```

Gets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.

**Returns:**
int - The smallest zero-based index of a row to be extracted from a document table.
##### setMinRowIndex(int value)
```
public void setMinRowIndex(int value)
```

Sets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The smallest zero-based index of a row to be extracted from a document table. |

##### getMaxRowIndex()
```
public int getMaxRowIndex()
```

Gets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.

**Returns:**
int - The largest zero-based index of a row to be extracted from a document table.
##### setMaxRowIndex(int value)
```
public void setMaxRowIndex(int value)
```

Sets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The largest zero-based index of a row to be extracted from a document table. |

##### getMinColumnIndex()
```
public int getMinColumnIndex()
```

Gets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.

**Returns:**
int - The smallest zero-based index of a column to be extracted from a document table.
##### setMinColumnIndex(int value)
```
public void setMinColumnIndex(int value)
```

Sets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The smallest zero-based index of a column to be extracted from a document table. |

##### getMaxColumnIndex()
```
public int getMaxColumnIndex()
```

Gets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.

**Returns:**
int - The largest zero-based index of a column to be extracted from a document table.
##### setMaxColumnIndex(int value)
```
public void setMaxColumnIndex(int value)
```

Sets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The largest zero-based index of a column to be extracted from a document table. |

##### getFirstRowContainsColumnNames()
```
public boolean getFirstRowContainsColumnNames()
```

Gets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, ... Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.

**Returns:**
boolean - A value indicating whether column names are to be obtained from the first extracted row of a document table.
##### setFirstRowContainsColumnNames(boolean value)
```
public void setFirstRowContainsColumnNames(boolean value)
```

Sets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, ... Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether column names are to be obtained from the first extracted row of a document table. |

### DocumentTableRelation
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttablerelation.md

**Inheritance:**
java.lang.Object
```
public class DocumentTableRelation
```

Represents a parent-child relationship between two DocumentTable objects.
#### Methods

| Method | Description |
| --- | --- |
| getParentColumn() | Gets the parent column of this relation. |
| getChildColumn() | Gets the child column of this relation. |
##### getParentColumn()
```
public DocumentTableColumn getParentColumn()
```

Gets the parent column of this relation.

**Returns:**
DocumentTableColumn - The parent column of this relation.
##### getChildColumn()
```
public DocumentTableColumn getChildColumn()
```

Gets the child column of this relation.

**Returns:**
DocumentTableColumn - The child column of this relation.

### DocumentTableRelationCollection
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttablerelationcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class DocumentTableRelationCollection implements Iterable
```

Represents the collection of DocumentTableRelation objects of a single DocumentTableSet instance.
#### Methods

| Method | Description |
| --- | --- |
| add(DocumentTableColumn parentColumn, DocumentTableColumn childColumn) | Creates a DocumentTableRelation object for the specified parent and child columns, and adds it to the collection. |
| remove(DocumentTableRelation relation) | Removes the specified relation from the collection. |
| removeAt(int index) | Removes the relation at the specified index from the collection. |
| clear() | Clears the collection of any relations. |
| iterator() | Returns an enumerator to iterate DocumentTableRelation objects of this collection. |
| contains(DocumentTableRelation relation) | Returns a value indicating whether this collection contains the specified relation. |
| indexOf(DocumentTableRelation relation) | Returns the index of the specified relation within this collection. |
| get(int index) | Gets a DocumentTableRelation instance from the collection at the specified index. |
| getCount() | Gets the total number of DocumentTableRelation objects in the collection. |
##### add(DocumentTableColumn parentColumn, DocumentTableColumn childColumn)
```
public DocumentTableRelation add(DocumentTableColumn parentColumn, DocumentTableColumn childColumn)
```

Creates a DocumentTableRelation object for the specified parent and child columns, and adds it to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentColumn | DocumentTableColumn | The parent column of the relation. |
| childColumn | DocumentTableColumn | The child column of the relation. |

**Returns:**
DocumentTableRelation - The created relation.
##### remove(DocumentTableRelation relation)
```
public void remove(DocumentTableRelation relation)
```

Removes the specified relation from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DocumentTableRelation | The relation to remove. |

##### removeAt(int index)
```
public void removeAt(int index)
```

Removes the relation at the specified index from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of the relation to remove. |

##### clear()
```
public void clear()
```

Clears the collection of any relations.

##### iterator()
```
public Iterator iterator()
```

Returns an enumerator to iterate DocumentTableRelation objects of this collection.

**Returns:**
java.util.Iterator - An enumerator to iterate DocumentTableRelation objects of this collection.
##### contains(DocumentTableRelation relation)
```
public boolean contains(DocumentTableRelation relation)
```

Returns a value indicating whether this collection contains the specified relation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DocumentTableRelation | A relation to look for. |

**Returns:**
boolean - A value indicating whether this collection contains the specified relation.
##### indexOf(DocumentTableRelation relation)
```
public int indexOf(DocumentTableRelation relation)
```

Returns the index of the specified relation within this collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | DocumentTableRelation | A relation to find. |

**Returns:**
int - The zero-based index of the specified relation, or -1 if the relation does not exist in this collection.
##### get(int index)
```
public DocumentTableRelation get(int index)
```

Gets a DocumentTableRelation instance from the collection at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the relation to return. |

**Returns:**
DocumentTableRelation - A DocumentTableRelation instance from the collection at the specified index.
##### getCount()
```
public int getCount()
```

Gets the total number of DocumentTableRelation objects in the collection.

**Returns:**
int - The total number of DocumentTableRelation objects in the collection.

### DocumentTableSet
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/documenttableset.md

**Inheritance:**
java.lang.Object
```
public class DocumentTableSet
```

Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while assembling a document. Also, enables to define parent-child relations for the document tables thus simplifying access to related data within template documents.

For documents of Spreadsheet file formats, a DocumentTableSet instance represents a set of sheets. For documents of other file formats, a DocumentTableSet instance represents a set of tables.

To access data of the corresponding tables while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. assembleDocument overloads.

In template documents, a DocumentTableSet instance should be treated in the same way as if it was a DataSet instance. See template syntax reference for more information.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentTableSet(String documentPath) | Creates a new instance of this class loading all tables from a document using default DocumentTableOptions. |
| DocumentTableSet(String documentPath, IDocumentTableLoadHandler loadHandler) | Creates a new instance of this class. |
| DocumentTableSet(InputStream documentStream) | Creates a new instance of this class loading all tables from a document using default DocumentTableOptions. |
| DocumentTableSet(InputStream documentStream, IDocumentTableLoadHandler loadHandler) | Creates a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| getTables() | Gets the collection of DocumentTable objects representing tables of this set. |
| getRelations() | Gets the collection of parent-child relations defined for document tables of this set. |
##### DocumentTableSet(String documentPath)
```
public DocumentTableSet(String documentPath)
```

Creates a new instance of this class loading all tables from a document using default DocumentTableOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | java.lang.String | The path to a document containing tables to be accessed. |

##### DocumentTableSet(String documentPath, IDocumentTableLoadHandler loadHandler)
```
public DocumentTableSet(String documentPath, IDocumentTableLoadHandler loadHandler)
```

Creates a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | java.lang.String | The path to a document containing tables to be accessed. |
| loadHandler | IDocumentTableLoadHandler | An IDocumentTableLoadHandler implementation controlling how document tables are loaded. |

##### DocumentTableSet(InputStream documentStream)
```
public DocumentTableSet(InputStream documentStream)
```

Creates a new instance of this class loading all tables from a document using default DocumentTableOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | java.io.InputStream | The stream containing a document with tables to be accessed. |

##### DocumentTableSet(InputStream documentStream, IDocumentTableLoadHandler loadHandler)
```
public DocumentTableSet(InputStream documentStream, IDocumentTableLoadHandler loadHandler)
```

Creates a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | java.io.InputStream | The stream containing a document with tables to be accessed. |
| loadHandler | IDocumentTableLoadHandler | An IDocumentTableLoadHandler implementation controlling how document tables are loaded. |

##### getTables()
```
public DocumentTableCollection getTables()
```

Gets the collection of DocumentTable objects representing tables of this set.

**Returns:**
DocumentTableCollection - The collection of DocumentTable objects representing tables of this set.
##### getRelations()
```
public DocumentTableRelationCollection getRelations()
```

Gets the collection of parent-child relations defined for document tables of this set.

**Returns:**
DocumentTableRelationCollection - The collection of parent-child relations defined for document tables of this set.

### FileFormat
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/fileformat.md

**Inheritance:**
java.lang.Object
```
public final class FileFormat
```

A utility class providing constants. Specifies the format of a file.
#### Fields

| Field | Description |
| --- | --- |
| UNSPECIFIED | Specifies an unset value. |
| DOC | Specifies the Microsoft Word 97 - 2007 Binary Document format. |
| DOT | Specifies the Microsoft Word 97 - 2007 Binary Template format. |
| DOCX | Specifies the Office Open XML WordprocessingML Document (macro-free) format. |
| DOCM | Specifies the Office Open XML WordprocessingML Macro-Enabled Document format. |
| DOTX | Specifies the Office Open XML WordprocessingML Template (macro-free) format. |
| DOTM | Specifies the Office Open XML WordprocessingML Macro-Enabled Template format. |
| FLAT_OPC | Specifies the Office Open XML WordprocessingML format stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_MACRO_ENABLED | Specifies the Office Open XML WordprocessingML Macro-Enabled Document format stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_TEMPLATE | Specifies the Office Open XML WordprocessingML Template (macro-free) format stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_TEMPLATE_MACRO_ENABLED | Specifies the Office Open XML WordprocessingML Macro-Enabled Template format stored in a flat XML file instead of a ZIP package. |
| WORD_ML |  |
| ODT | Specifies the ODF Text Document format. |
| OTT | Specifies the ODF Text Document Template format. |
| XLS | Specifies the Microsoft Excel 97 - 2007 Binary Workbook format. |
| XLSX | Specifies the Office Open XML SpreadsheetML Workbook (macro-free) format. |
| XLSM | Specifies the Office Open XML SpreadsheetML Macro-Enabled Workbook format. |
| XLTX | Specifies the Office Open XML SpreadsheetML Template (macro-free) format. |
| XLTM | Specifies the Office Open XML SpreadsheetML Macro-Enabled Template format. |
| XLAM | Specifies the Office Open XML SpreadsheetML Macro-Enabled Add-in format. |
| XLSB | Specifies the Microsoft Excel 2007 Macro-Enabled Binary File format. |
| SPREADSHEET_ML |  |
| ODS | Specifies the ODF Spreadsheet format. |
| PPT | Specifies the Microsoft PowerPoint 97 - 2007 Binary Presentation format. |
| PPS | Specifies the Microsoft PowerPoint 97 - 2007 Binary Slide Show format. |
| PPTX | Specifies the Office Open XML PresentationML Presentation (macro-free) format. |
| PPTM | Specifies the Office Open XML PresentationML Macro-Enabled Presentation format. |
| PPSX | Specifies the Office Open XML PresentationML Slide Show (macro-free) format. |
| PPSM | Specifies the Office Open XML PresentationML Macro-Enabled Slide Show format. |
| POTX | Specifies the Office Open XML PresentationML Template (macro-free) format. |
| POTM | Specifies the Office Open XML PresentationML Macro-Enabled Template format. |
| ODP | Specifies the ODF Presentation format. |
| MSG_ASCII | Specifies the Microsoft Outlook Message (MSG) format using ASCII character encoding. |
| MSG_UNICODE | Specifies the Microsoft Outlook Message (MSG) format using Unicode character encoding. |
| EML | Specifies the MIME standard format. |
| EMLX | Specifies the Apple Mail.app program file format. |
| RTF | Specifies the RTF format. |
| TEXT | Specifies the plain text format. |
| XML | Specifies the XML format of a general form. |
| XAML | Specifies the Extensible Application Markup Language (XAML) format. |
| XAML_PACKAGE | Specifies the Extensible Application Markup Language (XAML) package format. |
| HTML | Specifies the HTML format. |
| MHTML | Specifies the MHTML (Web archive) format. |
| XPS | Specifies the XPS (XML Paper Specification) format. |
| OPEN_XPS | Specifies the OpenXPS (Ecma-388) format. |
| PDF | Specifies the PDF (Adobe Portable Document) format. |
| EPUB | Specifies the IDPF EPUB format. |
| PS | Specifies the PS (PostScript) format. |
| PCL | Specifies the PCL (Printer Control Language) format. |
| SVG | Specifies the SVG (Scalable Vector Graphics) format. |
| TIFF | Specifies the TIFF format. |
| MARKDOWN | Specifies the Markdown format. |
| POT | Specifies the Microsoft PowerPoint 97 - 2007 Binary Template format. |
| OTP | Specifies the ODF Presentation Template format. |
| XLT | Specifies the Microsoft Excel 97 - 2007 Binary Template format. |
| length |  |
#### Methods

| Method | Description |
| --- | --- |
| getName(int fileFormat) |  |
| toString(int fileFormat) |  |
| fromName(String fileFormatName) |  |
| getValues() |  |
##### UNSPECIFIED
```
public static final int UNSPECIFIED
```

Specifies an unset value. The default.

##### DOC
```
public static final int DOC
```

Specifies the Microsoft Word 97 - 2007 Binary Document format.

##### DOT
```
public static final int DOT
```

Specifies the Microsoft Word 97 - 2007 Binary Template format.

##### DOCX
```
public static final int DOCX
```

Specifies the Office Open XML WordprocessingML Document (macro-free) format.

##### DOCM
```
public static final int DOCM
```

Specifies the Office Open XML WordprocessingML Macro-Enabled Document format.

##### DOTX
```
public static final int DOTX
```

Specifies the Office Open XML WordprocessingML Template (macro-free) format.

##### DOTM
```
public static final int DOTM
```

Specifies the Office Open XML WordprocessingML Macro-Enabled Template format.

##### FLAT_OPC
```
public static final int FLAT_OPC
```

Specifies the Office Open XML WordprocessingML format stored in a flat XML file instead of a ZIP package.

##### FLAT_OPC_MACRO_ENABLED
```
public static final int FLAT_OPC_MACRO_ENABLED
```

Specifies the Office Open XML WordprocessingML Macro-Enabled Document format stored in a flat XML file instead of a ZIP package.

##### FLAT_OPC_TEMPLATE
```
public static final int FLAT_OPC_TEMPLATE
```

Specifies the Office Open XML WordprocessingML Template (macro-free) format stored in a flat XML file instead of a ZIP package.

##### FLAT_OPC_TEMPLATE_MACRO_ENABLED
```
public static final int FLAT_OPC_TEMPLATE_MACRO_ENABLED
```

Specifies the Office Open XML WordprocessingML Macro-Enabled Template format stored in a flat XML file instead of a ZIP package.

##### WORD_ML
```
public static final int WORD_ML
```

##### ODT
```
public static final int ODT
```

Specifies the ODF Text Document format.

##### OTT
```
public static final int OTT
```

Specifies the ODF Text Document Template format.

##### XLS
```
public static final int XLS
```

Specifies the Microsoft Excel 97 - 2007 Binary Workbook format.

##### XLSX
```
public static final int XLSX
```

Specifies the Office Open XML SpreadsheetML Workbook (macro-free) format.

##### XLSM
```
public static final int XLSM
```

Specifies the Office Open XML SpreadsheetML Macro-Enabled Workbook format.

##### XLTX
```
public static final int XLTX
```

Specifies the Office Open XML SpreadsheetML Template (macro-free) format.

##### XLTM
```
public static final int XLTM
```

Specifies the Office Open XML SpreadsheetML Macro-Enabled Template format.

##### XLAM
```
public static final int XLAM
```

Specifies the Office Open XML SpreadsheetML Macro-Enabled Add-in format.

##### XLSB
```
public static final int XLSB
```

Specifies the Microsoft Excel 2007 Macro-Enabled Binary File format.

##### SPREADSHEET_ML
```
public static final int SPREADSHEET_ML
```

##### ODS
```
public static final int ODS
```

Specifies the ODF Spreadsheet format.

##### PPT
```
public static final int PPT
```

Specifies the Microsoft PowerPoint 97 - 2007 Binary Presentation format.

##### PPS
```
public static final int PPS
```

Specifies the Microsoft PowerPoint 97 - 2007 Binary Slide Show format.

##### PPTX
```
public static final int PPTX
```

Specifies the Office Open XML PresentationML Presentation (macro-free) format.

##### PPTM
```
public static final int PPTM
```

Specifies the Office Open XML PresentationML Macro-Enabled Presentation format.

##### PPSX
```
public static final int PPSX
```

Specifies the Office Open XML PresentationML Slide Show (macro-free) format.

##### PPSM
```
public static final int PPSM
```

Specifies the Office Open XML PresentationML Macro-Enabled Slide Show format.

##### POTX
```
public static final int POTX
```

Specifies the Office Open XML PresentationML Template (macro-free) format.

##### POTM
```
public static final int POTM
```

Specifies the Office Open XML PresentationML Macro-Enabled Template format.

##### ODP
```
public static final int ODP
```

Specifies the ODF Presentation format.

##### MSG_ASCII
```
public static final int MSG_ASCII
```

Specifies the Microsoft Outlook Message (MSG) format using ASCII character encoding.

##### MSG_UNICODE
```
public static final int MSG_UNICODE
```

Specifies the Microsoft Outlook Message (MSG) format using Unicode character encoding.

##### EML
```
public static final int EML
```

Specifies the MIME standard format.

##### EMLX
```
public static final int EMLX
```

Specifies the Apple Mail.app program file format.

##### RTF
```
public static final int RTF
```

Specifies the RTF format.

##### TEXT
```
public static final int TEXT
```

Specifies the plain text format.

##### XML
```
public static final int XML
```

Specifies the XML format of a general form.

##### XAML
```
public static final int XAML
```

Specifies the Extensible Application Markup Language (XAML) format.

##### XAML_PACKAGE
```
public static final int XAML_PACKAGE
```

Specifies the Extensible Application Markup Language (XAML) package format.

##### HTML
```
public static final int HTML
```

Specifies the HTML format.

##### MHTML
```
public static final int MHTML
```

Specifies the MHTML (Web archive) format.

##### XPS
```
public static final int XPS
```

Specifies the XPS (XML Paper Specification) format.

##### OPEN_XPS
```
public static final int OPEN_XPS
```

Specifies the OpenXPS (Ecma-388) format.

##### PDF
```
public static final int PDF
```

Specifies the PDF (Adobe Portable Document) format.

##### EPUB
```
public static final int EPUB
```

Specifies the IDPF EPUB format.

##### PS
```
public static final int PS
```

Specifies the PS (PostScript) format.

##### PCL
```
public static final int PCL
```

Specifies the PCL (Printer Control Language) format.

##### SVG
```
public static final int SVG
```

Specifies the SVG (Scalable Vector Graphics) format.

##### TIFF
```
public static final int TIFF
```

Specifies the TIFF format.

##### MARKDOWN
```
public static final int MARKDOWN
```

Specifies the Markdown format.

##### POT
```
public static final int POT
```

Specifies the Microsoft PowerPoint 97 - 2007 Binary Template format.

##### OTP
```
public static final int OTP
```

Specifies the ODF Presentation Template format.

##### XLT
```
public static final int XLT
```

Specifies the Microsoft Excel 97 - 2007 Binary Template format.

##### length
```
public static final int length
```

##### getName(int fileFormat)
```
public static String getName(int fileFormat)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int |  |

**Returns:**
java.lang.String
##### toString(int fileFormat)
```
public static String toString(int fileFormat)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int |  |

**Returns:**
java.lang.String
##### fromName(String fileFormatName)
```
public static int fromName(String fileFormatName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormatName | java.lang.String |  |

**Returns:**
int
##### getValues()
```
public static int[] getValues()
```

**Returns:**
int[]

### IDocumentTableLoadHandler
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/idocumenttableloadhandler.md

### JsonDataLoadOptions
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/jsondataloadoptions.md

**Inheritance:**
java.lang.Object
```
public class JsonDataLoadOptions
```

Represents options for parsing JSON data. An instance of this class can be passed into constructors of JsonDataSource.
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonDataLoadOptions() | Initializes a new instance of this class with default options. |
#### Methods

| Method | Description |
| --- | --- |
| getSimpleValueParseMode() | Gets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. |
| setSimpleValueParseMode(int value) | Sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. |
| getExactDateTimeParseFormat() | Gets an exact format for parsing JSON date-time values while loading JSON. |
| setExactDateTimeParseFormat(String value) | Sets an exact format for parsing JSON date-time values while loading JSON. |
| getExactDateTimeParseFormats() | Gets exact formats for parsing JSON date-time values while loading JSON. |
| setExactDateTimeParseFormats(Iterable value) | Sets exact formats for parsing JSON date-time values while loading JSON. |
| getAlwaysGenerateRootObject() | Gets a flag indicating whether a generated data source will always contain an object for a JSON root element. |
| setAlwaysGenerateRootObject(boolean value) | Sets a flag indicating whether a generated data source will always contain an object for a JSON root element. |
##### JsonDataLoadOptions()
```
public JsonDataLoadOptions()
```

Initializes a new instance of this class with default options.

##### getSimpleValueParseMode()
```
public int getSimpleValueParseMode()
```

Gets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is JsonSimpleValueParseMode.LOOSE.

**Returns:**
int - A mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. The returned value is one of JsonSimpleValueParseMode constants.
##### setSimpleValueParseMode(int value)
```
public void setSimpleValueParseMode(int value)
```

Sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is JsonSimpleValueParseMode.LOOSE.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. The value must be one of JsonSimpleValueParseMode constants. |

##### getExactDateTimeParseFormat()
```
public String getExactDateTimeParseFormat()
```

Gets an exact format for parsing JSON date-time values while loading JSON. The default is **null**.

Strings encoded using Microsoft� JSON date-time format (for example, "/Date(1224043200000)/") are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

 *  When getExactDateTimeParseFormat() / setExactDateTimeParseFormat(java.lang.String) is **null**, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
 *  When getExactDateTimeParseFormat() / setExactDateTimeParseFormat(java.lang.String) is a non-empty string, it is used as a single additional date-time format utilizing the current culture.
 *  When getExactDateTimeParseFormat() / setExactDateTimeParseFormat(java.lang.String) is an empty string, no additional date-time formats are used.

**Returns:**
java.lang.String - An exact format for parsing JSON date-time values while loading JSON.
##### setExactDateTimeParseFormat(String value)
```
public void setExactDateTimeParseFormat(String value)
```

Sets an exact format for parsing JSON date-time values while loading JSON. The default is **null**.

Strings encoded using Microsoft� JSON date-time format (for example, "/Date(1224043200000)/") are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

 *  When getExactDateTimeParseFormat() / setExactDateTimeParseFormat(java.lang.String) is **null**, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
 *  When getExactDateTimeParseFormat() / setExactDateTimeParseFormat(java.lang.String) is a non-empty string, it is used as a single additional date-time format utilizing the current culture.
 *  When getExactDateTimeParseFormat() / setExactDateTimeParseFormat(java.lang.String) is an empty string, no additional date-time formats are used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An exact format for parsing JSON date-time values while loading JSON. |

##### getExactDateTimeParseFormats()
```
public Iterable getExactDateTimeParseFormats()
```

Gets exact formats for parsing JSON date-time values while loading JSON. The default is **null**.

Strings encoded using Microsoft� JSON date-time format (for example, "/Date(1224043200000)/") are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

 *  When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is **null**, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
 *  When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) contains strings, they are used as additional date-time formats utilizing the current culture.
 *  When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is empty, no additional date-time formats are used.

**Returns:**
java.lang.Iterable - Exact formats for parsing JSON date-time values while loading JSON.
##### setExactDateTimeParseFormats(Iterable value)
```
public void setExactDateTimeParseFormats(Iterable value)
```

Sets exact formats for parsing JSON date-time values while loading JSON. The default is **null**.

Strings encoded using Microsoft� JSON date-time format (for example, "/Date(1224043200000)/") are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

 *  When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is **null**, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
 *  When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) contains strings, they are used as additional date-time formats utilizing the current culture.
 *  When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is empty, no additional date-time formats are used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Iterable | Exact formats for parsing JSON date-time values while loading JSON. |

##### getAlwaysGenerateRootObject()
```
public boolean getAlwaysGenerateRootObject()
```

Gets a flag indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default. The default value is **false**.

**Returns:**
boolean - A flag indicating whether a generated data source will always contain an object for a JSON root element.
##### setAlwaysGenerateRootObject(boolean value)
```
public void setAlwaysGenerateRootObject(boolean value)
```

Sets a flag indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default. The default value is **false**.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A flag indicating whether a generated data source will always contain an object for a JSON root element. |

### JsonDataSource
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/jsondatasource.md

**Inheritance:**
java.lang.Object
```
public class JsonDataSource
```

Provides access to data of a JSON file or stream to be used while assembling a document.

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. assembleDocument overloads.

In template documents, if a top-level JSON element is an array, a JsonDataSource instance should be treated in the same way as if it was a DataTable instance. If a top-level JSON element is an object, a JsonDataSource instance should be treated in the same way as if it was a DataRow instance. For more information, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

In template documents, you can work with typed values of JSON elements. For convenience, the engine replaces the set of JSON simple types with the following one:

 *   java.lang.Long
 *   java.lang.Double
 *   java.lang.Boolean
 *   java.util.Date
 *   java.lang.String

The engine automatically recognizes values of the extra types upon their JSON representations.

To override default behavior of JSON data loading, initialize and pass a JsonDataLoadOptions instance to a constructor of this class.
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonDataSource(String jsonPath) | Creates a new data source with data from a JSON file using default options for parsing JSON data. |
| JsonDataSource(String jsonPath, JsonDataLoadOptions options) | Creates a new data source with data from a JSON file using the specified options for parsing JSON data. |
| JsonDataSource(InputStream jsonStream) | Creates a new data source with data from a JSON stream using default options for parsing JSON data. |
| JsonDataSource(InputStream jsonStream, JsonDataLoadOptions options) | Initializes a new instance of this class. |
##### JsonDataSource(String jsonPath)
```
public JsonDataSource(String jsonPath)
```

Creates a new data source with data from a JSON file using default options for parsing JSON data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonPath | java.lang.String | The path to the JSON file to be used as the data source. |

##### JsonDataSource(String jsonPath, JsonDataLoadOptions options)
```
public JsonDataSource(String jsonPath, JsonDataLoadOptions options)
```

Creates a new data source with data from a JSON file using the specified options for parsing JSON data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonPath | java.lang.String | The path to the JSON file to be used as the data source. |
| options | JsonDataLoadOptions | Options for parsing JSON data. |

##### JsonDataSource(InputStream jsonStream)
```
public JsonDataSource(InputStream jsonStream)
```

Creates a new data source with data from a JSON stream using default options for parsing JSON data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonStream | java.io.InputStream | The stream of JSON data to be used as the data source. |

##### JsonDataSource(InputStream jsonStream, JsonDataLoadOptions options)
```
public JsonDataSource(InputStream jsonStream, JsonDataLoadOptions options)
```

Initializes a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonStream | java.io.InputStream |  |
| options | JsonDataLoadOptions |  |

### JsonSimpleValueParseMode
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/jsonsimplevalueparsemode.md

**Inheritance:**
java.lang.Object
```
public final class JsonSimpleValueParseMode
```

A utility class providing constants. Specifies a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values.
#### Fields

| Field | Description |
| --- | --- |
| LOOSE | Specifies the mode where types of JSON simple values are determined upon parsing of their string representations. |
| STRICT | Specifies the mode where types of JSON simple values are determined from JSON notation itself. |
| length |  |
#### Methods

| Method | Description |
| --- | --- |
| getName(int jsonSimpleValueParseMode) |  |
| toString(int jsonSimpleValueParseMode) |  |
| fromName(String jsonSimpleValueParseModeName) |  |
| getValues() |  |
##### LOOSE
```
public static final int LOOSE
```

Specifies the mode where types of JSON simple values are determined upon parsing of their string representations. For example, the type of 'prop' from the JSON snippet '\{ prop: "123" \}' is determined as integer in this mode.

##### STRICT
```
public static final int STRICT
```

Specifies the mode where types of JSON simple values are determined from JSON notation itself. For example, the type of 'prop' from the JSON snippet '\{ prop: "123" \}' is determined as string in this mode.

##### length
```
public static final int length
```

##### getName(int jsonSimpleValueParseMode)
```
public static String getName(int jsonSimpleValueParseMode)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonSimpleValueParseMode | int |  |

**Returns:**
java.lang.String
##### toString(int jsonSimpleValueParseMode)
```
public static String toString(int jsonSimpleValueParseMode)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonSimpleValueParseMode | int |  |

**Returns:**
java.lang.String
##### fromName(String jsonSimpleValueParseModeName)
```
public static int fromName(String jsonSimpleValueParseModeName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| jsonSimpleValueParseModeName | java.lang.String |  |

**Returns:**
int
##### getValues()
```
public static int[] getValues()
```

**Returns:**
int[]

### KnownTypeSet
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/knowntypeset.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class KnownTypeSet implements Iterable
```

Represents an unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates to invoke the corresponding types' static members, perform type casts, etc.
#### Methods

| Method | Description |
| --- | --- |
| add(Class type) | Adds the specified java.lang.Class object to the set. |
| remove(Class type) | Removes the specified java.lang.Class object from the set. |
| clear() | Removes all items from the set. |
| iterator() | Returns An java.util.Iterator object to iterate over items of the set. |
| getCount() | Gets the count of items in the set. |
##### add(Class type)
```
public void add(Class type)
```

Adds the specified java.lang.Class object to the set.

Throws java.lang.IllegalArgumentException in the following cases:

\-  type  is null.

\-  type  represents a void type.

\-  type  represents an invisible type, i.e. a non-public type or a public nested type which has a non-public outer type.

\-  type  represents an array type.

\-  type  has been added to the set already.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class | A java.lang.Class object to add. |

##### remove(Class type)
```
public void remove(Class type)
```

Removes the specified java.lang.Class object from the set.

Throws java.lang.IllegalArgumentException if  type  is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class | A java.lang.Class object to remove. |

##### clear()
```
public void clear()
```

Removes all items from the set.

##### iterator()
```
public Iterator iterator()
```

Returns An java.util.Iterator object to iterate over items of the set.

**Returns:**
java.util.Iterator - An java.util.Iterator object to iterate over items of the set.
##### getCount()
```
public int getCount()
```

Gets the count of items in the set.

**Returns:**
int - The count of items in the set.

### License
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/license.md

**Inheritance:**
java.lang.Object
```
public class License
```

Provides methods to license the component.
#### Constructors

| Constructor | Description |
| --- | --- |
| License() | Initializes a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String licenseName) | Licenses the component. |
| setLicense(InputStream stream) | Licenses the component. |
| isLicensed() | Returns true if a valid license has been applied; false if the component is running in evaluation mode. |
##### License()
```
public License()
```

Initializes a new instance of this class.

##### setLicense(String licenseName)
```
public void setLicense(String licenseName)
```

Licenses the component.

Tries to find the license in the following locations:

1. Explicit path.

2. The folder that contains the GroupDocs component JAR file.

3. The folder that contains the client's calling JAR file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseName | java.lang.String | Can be a full or short file name. Use an empty string to switch to evaluation mode. |

##### setLicense(InputStream stream)
```
public void setLicense(InputStream stream)
```

Licenses the component.

Use this method to load a license from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | A stream that contains the license. |

##### isLicensed()
```
public boolean isLicensed()
```

Returns true if a valid license has been applied; false if the component is running in evaluation mode.

**Returns:**
boolean - True if a valid license has been applied; false if the component is running in evaluation mode.

### LoadSaveOptions
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/loadsaveoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadSaveOptions
```

Specifies additional options for loading and saving of a document to be assembled.
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadSaveOptions() | Creates a new instance of this class without any properties specified. |
| LoadSaveOptions(int saveFormat) | Creates a new instance of this class with the specified file format to save an assembled document to. |
#### Methods

| Method | Description |
| --- | --- |
| getSaveFormat() | Gets a file format to save an assembled document to. |
| setSaveFormat(int value) | Sets a file format to save an assembled document to. |
| getResourceLoadBaseUri() | Gets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. |
| setResourceLoadBaseUri(String value) | Sets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. |
| getResourceSaveFolder() | Gets a path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. |
| setResourceSaveFolder(String value) | Sets a path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. |
##### LoadSaveOptions()
```
public LoadSaveOptions()
```

Creates a new instance of this class without any properties specified.

##### LoadSaveOptions(int saveFormat)
```
public LoadSaveOptions(int saveFormat)
```

Creates a new instance of this class with the specified file format to save an assembled document to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveFormat | int | A file format to save an assembled document to. The value must be one of FileFormat constants. |

##### getSaveFormat()
```
public int getSaveFormat()
```

Gets a file format to save an assembled document to. FileFormat.UNSPECIFIED is the default.

When the value of this property is not specified, DocumentAssembler behaves as follows:

\- When you specify a file path to save an assembled document, the save file format is determined upon file extension from the path.

\- When you specify a stream to save an assembled document, the save file format remains the same as the file format of a loaded template document.

Beware that it is not always possible to save an assembled document to any file format using GroupDocs.Assembly. For example, it is impossible to save a document loaded from a Word Processing file format (such as DOCX) to a Spreadsheet file format (such as XLSX). For more information on possible combinations of load and save file formats supported by GroupDocs.Assembly, please check GroupDocs.Assembly online documentation.

**Returns:**
int - A file format to save an assembled document to. The returned value is one of FileFormat constants.
##### setSaveFormat(int value)
```
public void setSaveFormat(int value)
```

Sets a file format to save an assembled document to. FileFormat.UNSPECIFIED is the default.

When the value of this property is not specified, DocumentAssembler behaves as follows:

\- When you specify a file path to save an assembled document, the save file format is determined upon file extension from the path.

\- When you specify a stream to save an assembled document, the save file format remains the same as the file format of a loaded template document.

Beware that it is not always possible to save an assembled document to any file format using GroupDocs.Assembly. For example, it is impossible to save a document loaded from a Word Processing file format (such as DOCX) to a Spreadsheet file format (such as XLSX). For more information on possible combinations of load and save file formats supported by GroupDocs.Assembly, please check GroupDocs.Assembly online documentation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A file format to save an assembled document to. The value must be one of FileFormat constants. |

##### getResourceLoadBaseUri()
```
public String getResourceLoadBaseUri()
```

Gets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. The default value is an empty string.

When loading an HTML document from a file, its containing folder is used as a base URI by default, which cannot happen when loading an HTML document from a stream. Set this property to specify a base URI when loading an HTML document from a stream or to override the default base URI when loading an HTML document from a file.

A value of this property is ignored in the following cases:

 *  An HTML document being loaded contains a BASE HTML element providing a base URI.
 *  An HTML document being loaded is to be assembled and saved to HTML (external resource files are not loaded and relative URIs are not changed then).

**Returns:**
java.lang.String - A base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format.
##### setResourceLoadBaseUri(String value)
```
public void setResourceLoadBaseUri(String value)
```

Sets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. The default value is an empty string.

When loading an HTML document from a file, its containing folder is used as a base URI by default, which cannot happen when loading an HTML document from a stream. Set this property to specify a base URI when loading an HTML document from a stream or to override the default base URI when loading an HTML document from a file.

A value of this property is ignored in the following cases:

 *  An HTML document being loaded contains a BASE HTML element providing a base URI.
 *  An HTML document being loaded is to be assembled and saved to HTML (external resource files are not loaded and relative URIs are not changed then).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. |

##### getResourceSaveFolder()
```
public String getResourceSaveFolder()
```

Gets a path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. The default value is an empty string.

By default, when saving an assembled document to an HTML file, external resource files are stored to a folder having the same name as the HTML file without extension plus the "\_files" suffix. This folder is located in the same folder as the HTML file. However, this cannot be done when saving an assembled document to an HTML stream. Set this property to specify a path to a folder to store external resource files when saving an assembled document to an HTML stream or to override the default folder when saving an assembled document to an HTML file.

A value of this property is ignored if an assembled document being saved to HTML was loaded from HTML as well (external resource files are not stored and links to them are not changed then).

**Returns:**
java.lang.String - A path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML.
##### setResourceSaveFolder(String value)
```
public void setResourceSaveFolder(String value)
```

Sets a path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. The default value is an empty string.

By default, when saving an assembled document to an HTML file, external resource files are stored to a folder having the same name as the HTML file without extension plus the "\_files" suffix. This folder is located in the same folder as the HTML file. However, this cannot be done when saving an assembled document to an HTML stream. Set this property to specify a path to a folder to store external resource files when saving an assembled document to an HTML stream or to override the default folder when saving an assembled document to an HTML file.

A value of this property is ignored if an assembled document being saved to HTML was loaded from HTML as well (external resource files are not stored and links to them are not changed then).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. |

### Metered
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods to work with metered licensing. In this example, an attempt to set metered public and private keys is made:

```

 Metered metered = new Metered();
 metered.setMeteredKey("PublicKey", "PrivateKey");
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() | Creates a new instance of this class. |
#### Methods

| Method | Description |
| --- | --- |
| setMeteredKey(String publicKey, String privateKey) | Enables metered licensing for the component by specifying appropriate public and private metered keys. |
| getConsumptionQuantity() | Returns the currently consumed number of megabytes. |
| getConsumptionCredit() | Returns the currently consumed number of credits. |
##### Metered()
```
public Metered()
```

Creates a new instance of this class.

##### setMeteredKey(String publicKey, String privateKey)
```
public void setMeteredKey(String publicKey, String privateKey)
```

Enables metered licensing for the component by specifying appropriate public and private metered keys.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | The public metered key. |
| privateKey | java.lang.String | The private metered key. |

##### getConsumptionQuantity()
```
public static double getConsumptionQuantity()
```

Returns the currently consumed number of megabytes.

**Returns:**
double - The currently consumed number of megabytes.
##### getConsumptionCredit()
```
public static double getConsumptionCredit()
```

Returns the currently consumed number of credits.

**Returns:**
double - The currently consumed number of credits.

### XmlDataLoadOptions
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/xmldataloadoptions.md

**Inheritance:**
java.lang.Object
```
public class XmlDataLoadOptions
```

Represents options for XML data loading. An instance of this class can be passed into constructors of XmlDataSource.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlDataLoadOptions() | Initializes a new instance of this class with default options. |
#### Methods

| Method | Description |
| --- | --- |
| getAlwaysGenerateRootObject() | Gets a flag indicating whether a generated data source will always contain an object for an XML root element. |
| setAlwaysGenerateRootObject(boolean value) | Sets a flag indicating whether a generated data source will always contain an object for an XML root element. |
##### XmlDataLoadOptions()
```
public XmlDataLoadOptions()
```

Initializes a new instance of this class with default options.

##### getAlwaysGenerateRootObject()
```
public boolean getAlwaysGenerateRootObject()
```

Gets a flag indicating whether a generated data source will always contain an object for an XML root element. If an XML root element has no attributes and all its child elements have same names, such an object is not created by default. The default value is **false**.

**Returns:**
boolean - A flag indicating whether a generated data source will always contain an object for an XML root element.
##### setAlwaysGenerateRootObject(boolean value)
```
public void setAlwaysGenerateRootObject(boolean value)
```

Sets a flag indicating whether a generated data source will always contain an object for an XML root element. If an XML root element has no attributes and all its child elements have same names, such an object is not created by default. The default value is **false**.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A flag indicating whether a generated data source will always contain an object for an XML root element. |

### XmlDataSource
Path: https://reference.groupdocs.com/assembly/java/com.groupdocs.assembly/xmldatasource.md

**Inheritance:**
java.lang.Object
```
public class XmlDataSource
```

Provides access to data of an XML file or stream to be used while assembling a document.

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. assembleDocument overloads.

In template documents, if a top-level XML element contains only a list of elements of the same type, an XmlDataSource instance should be treated in the same way as if it was a DataTable instance. Otherwise, an XmlDataSource instance should be treated in the same way as if it was a DataRow instance. For more information, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2\#TemplateSyntax-Part1of2-UsingDataSources).

When XML Schema Definition is passed to a constructor of this class, data types of values of simple XML elements and attributes are determined according to the schema. So in template documents, you can work with typed values rather than just strings.

When XML Schema Definition is not passed to a constructor of this class, data types of values of simple XML elements and attributes are determined automatically upon their string representations. So in template documents, you can work with typed values in this case as well. The engine is capable to automatically recognize values of the following types:

 *   java.lang.Long
 *   java.lang.Double
 *   java.lang.Boolean
 *   java.util.Date
 *   java.lang.String

Note that for automatic recognition of data types to work, string representations of values of simple XML elements and attributes should be formed using invariant culture settings.

To override default behavior of XML data loading, initialize and pass a XmlDataLoadOptions instance to a constructor of this class.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlDataSource(String xmlPath) | Creates a new data source with data from an XML file using default options for XML data loading. |
| XmlDataSource(InputStream xmlStream) | Creates a new data source with data from an XML stream using default options for XML data loading. |
| XmlDataSource(String xmlPath, String xmlSchemaPath) | Creates a new data source with data from an XML file using an XML Schema Definition file. |
| XmlDataSource(InputStream xmlStream, InputStream xmlSchemaStream) | Creates a new data source with data from an XML stream using an XML Schema Definition stream. |
| XmlDataSource(String xmlPath, XmlDataLoadOptions options) | Creates a new data source with data from an XML file using the specified options for XML data loading. |
| XmlDataSource(InputStream xmlStream, XmlDataLoadOptions options) | Initializes a new instance of this class. |
| XmlDataSource(String xmlPath, String xmlSchemaPath, XmlDataLoadOptions options) | Creates a new data source with data from an XML file using an XML Schema Definition file. |
| XmlDataSource(InputStream xmlStream, InputStream xmlSchemaStream, XmlDataLoadOptions options) | Initializes a new instance of this class. |
##### XmlDataSource(String xmlPath)
```
public XmlDataSource(String xmlPath)
```

Creates a new data source with data from an XML file using default options for XML data loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | java.lang.String | The path to the XML file to be used as the data source. |

##### XmlDataSource(InputStream xmlStream)
```
public XmlDataSource(InputStream xmlStream)
```

Creates a new data source with data from an XML stream using default options for XML data loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream | The stream of XML data to be used as the data source. |

##### XmlDataSource(String xmlPath, String xmlSchemaPath)
```
public XmlDataSource(String xmlPath, String xmlSchemaPath)
```

Creates a new data source with data from an XML file using an XML Schema Definition file. Default options are used for XML data loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | java.lang.String | The path to the XML file to be used as the data source. |
| xmlSchemaPath | java.lang.String | The path to the XML Schema Definition file that provides schema for the XML file. |

##### XmlDataSource(InputStream xmlStream, InputStream xmlSchemaStream)
```
public XmlDataSource(InputStream xmlStream, InputStream xmlSchemaStream)
```

Creates a new data source with data from an XML stream using an XML Schema Definition stream. Default options are used for XML data loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream | The stream of XML data to be used as the data source. |
| xmlSchemaStream | java.io.InputStream | The stream of XML Schema Definition that provides schema for the XML data. |

##### XmlDataSource(String xmlPath, XmlDataLoadOptions options)
```
public XmlDataSource(String xmlPath, XmlDataLoadOptions options)
```

Creates a new data source with data from an XML file using the specified options for XML data loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | java.lang.String | The path to the XML file to be used as the data source. |
| options | XmlDataLoadOptions | Options for XML data loading. |

##### XmlDataSource(InputStream xmlStream, XmlDataLoadOptions options)
```
public XmlDataSource(InputStream xmlStream, XmlDataLoadOptions options)
```

Initializes a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream |  |
| options | XmlDataLoadOptions |  |

##### XmlDataSource(String xmlPath, String xmlSchemaPath, XmlDataLoadOptions options)
```
public XmlDataSource(String xmlPath, String xmlSchemaPath, XmlDataLoadOptions options)
```

Creates a new data source with data from an XML file using an XML Schema Definition file. The specified options are used for XML data loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | java.lang.String | The path to the XML file to be used as the data source. |
| xmlSchemaPath | java.lang.String | The path to the XML Schema Definition file that provides schema for the XML file. |
| options | XmlDataLoadOptions | Options for XML data loading. |

##### XmlDataSource(InputStream xmlStream, InputStream xmlSchemaStream, XmlDataLoadOptions options)
```
public XmlDataSource(InputStream xmlStream, InputStream xmlSchemaStream, XmlDataLoadOptions options)
```

Initializes a new instance of this class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | java.io.InputStream |  |
| xmlSchemaStream | java.io.InputStream |  |
| options | XmlDataLoadOptions |  |

## .NET

### GroupDocs.Assembly for .NET
Path: https://reference.groupdocs.com/assembly/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Assembly | Provides classes for generating documents in popular office file formats based upon template documents and data obtained from various sources including databases, XML, JSON, OData, objects of custom .NET types, and more. |
| GroupDocs.Assembly.Data | Provides classes for accessing data of external documents to be used while assembling a document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Assembly.dll -->

### GroupDocs.Assembly.Data
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data.md

Provides classes for accessing data of external documents to be used while assembling a document.

#### Classes

| Class | Description |
| --- | --- |
| CsvDataLoadOptions | Represents options for parsing CSV data. |
| CsvDataSource | Provides access to data of a CSV file or stream to be used while assembling a document. |
| DocumentTable | Provides access to data of a single table (or spreadsheet) located in an external document to be used while assembling a document. |
| DocumentTableCollection | Represents a read-only collection of `DocumentTable` objects of a particular `DocumentTableSet` instance. |
| DocumentTableColumn | Represents a single column of a particular `DocumentTable` object. |
| DocumentTableColumnCollection | Represents a read-only collection of `DocumentTableColumn` objects of a particular `DocumentTable` instance. |
| DocumentTableLoadArgs | Provides data for the `Handle` method. |
| DocumentTableOptions | Provides a set of options to control extraction of data from a document table. |
| DocumentTableRelation | Represents a parent-child relationship between two `DocumentTable` objects. |
| DocumentTableRelationCollection | Represents the collection of `DocumentTableRelation` objects of a single `DocumentTableSet` instance. |
| DocumentTableSet | Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while assembling a document. Also, enables to define parent-child relations for the document tables thus simplifying access to related data within template documents. |
| JsonDataLoadOptions | Represents options for parsing JSON data. |
| JsonDataSource | Provides access to data of a JSON file or stream to be used while assembling a document. |
| XmlDataLoadOptions | Represents options for XML data loading. |
| XmlDataSource | Provides access to data of an XML file or stream to be used while assembling a document. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentTableLoadHandler | Overrides default loading of `DocumentTable` objects while creating a `DocumentTableSet` instance. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| JsonSimpleValueParseMode | Specifies a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Assembly.dll -->

### CsvDataLoadOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdataloadoptions.md

#### CsvDataLoadOptions class

Represents options for parsing CSV data.

```csharp
public class CsvDataLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CsvDataLoadOptions() | Initializes a new instance of this class with default options. |
| CsvDataLoadOptions(bool) | Initializes a new instance of this class with specifying whether CSV data contains column names at the first line. |

#### Properties

| Name | Description |
| --- | --- |
| CommentChar { get; set; } | Gets or sets the character that is used to comment lines of CSV data. |
| Delimiter { get; set; } | Gets or sets the character to be used as a column delimiter. |
| HasHeaders { get; set; } | Gets or sets a value indicating whether the first line of CSV data contains column names. |
| QuoteChar { get; set; } | Gets or sets the character that is used to quote field values. |

##### Remarks

An instance of this class can be passed into constructors of `CsvDataSource`.

### CommentChar
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdataloadoptions/commentchar.md

#### CsvDataLoadOptions.CommentChar property

Gets or sets the character that is used to comment lines of CSV data.

```csharp
public char CommentChar { get; set; }
```

##### Remarks

The default value is '#' (number sign).

### CsvDataLoadOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdataloadoptions/csvdataloadoptions.md

#### CsvDataLoadOptions()

Initializes a new instance of this class with default options.

```csharp
public CsvDataLoadOptions()
```

#### CsvDataLoadOptions(bool)

Initializes a new instance of this class with specifying whether CSV data contains column names at the first line.

```csharp
public CsvDataLoadOptions(bool hasHeaders)
```

### Delimiter
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdataloadoptions/delimiter.md

#### CsvDataLoadOptions.Delimiter property

Gets or sets the character to be used as a column delimiter.

```csharp
public char Delimiter { get; set; }
```

##### Remarks

The default value is ',' (comma).

### HasHeaders
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdataloadoptions/hasheaders.md

#### CsvDataLoadOptions.HasHeaders property

Gets or sets a value indicating whether the first line of CSV data contains column names.

```csharp
public bool HasHeaders { get; set; }
```

##### Remarks

The default value is **false**.

### QuoteChar
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdataloadoptions/quotechar.md

#### CsvDataLoadOptions.QuoteChar property

Gets or sets the character that is used to quote field values.

```csharp
public char QuoteChar { get; set; }
```

##### Remarks

The default value is '"' (quotation mark).

Double the character to place it into quoted text.

### CsvDataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdatasource.md

#### CsvDataSource class

Provides access to data of a CSV file or stream to be used while assembling a document.

```csharp
public class CsvDataSource
```

#### Constructors

| Name | Description |
| --- | --- |
| CsvDataSource(Stream) | Creates a new data source with data from a CSV stream using default options for parsing CSV data. |
| CsvDataSource(string) | Creates a new data source with data from a CSV file using default options for parsing CSV data. |
| CsvDataSource(Stream, CsvDataLoadOptions) | Creates a new data source with data from a CSV stream using the specified options for parsing CSV data. |
| CsvDataSource(string, CsvDataLoadOptions) | Creates a new data source with data from a CSV file using the specified options for parsing CSV data. |

##### Remarks

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as a data source to one of `DocumentAssembler`.AssembleDocument overloads.

In template documents, a `CsvDataSource` instance should be treated in the same way as if it was a DataTable instance. For more information, see template syntax reference (https://docs.groupdocs.com/display/assemblynet/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

Data types of comma-separated values are determined automatically upon their string representations. So in template documents, you can work with typed values rather than just strings. The engine is capable to automatically recognize values of the following types:

* `long?`
* `double?`
* `bool?`
* `DateTime?`
* `string`

Note that for automatic recognition of data types to work, string representations of comma-separated values should be formed using invariant culture settings.

To override default behavior of CSV data loading, initialize and pass a `CsvDataLoadOptions` instance to a constructor of this class.

### CsvDataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/csvdatasource/csvdatasource.md

#### CsvDataSource(string)

Creates a new data source with data from a CSV file using default options for parsing CSV data.

```csharp
public CsvDataSource(string csvPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| csvPath | String | The path to the CSV file to be used as the data source. |

#### CsvDataSource(string, CsvDataLoadOptions)

Creates a new data source with data from a CSV file using the specified options for parsing CSV data.

```csharp
public CsvDataSource(string csvPath, CsvDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| csvPath | String | The path to the CSV file to be used as the data source. |
| options | CsvDataLoadOptions | Options for parsing the CSV data. |

#### CsvDataSource(Stream)

Creates a new data source with data from a CSV stream using default options for parsing CSV data.

```csharp
public CsvDataSource(Stream csvStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| csvStream | Stream | The stream of CSV data to be used as the data source. |

#### CsvDataSource(Stream, CsvDataLoadOptions)

Creates a new data source with data from a CSV stream using the specified options for parsing CSV data.

```csharp
public CsvDataSource(Stream csvStream, CsvDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| csvStream | Stream | The stream of CSV data to be used as the data source. |
| options | CsvDataLoadOptions | Options for parsing the CSV data. |

### DocumentTable
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttable.md

#### DocumentTable class

Provides access to data of a single table (or spreadsheet) located in an external document to be used while assembling a document.

```csharp
public class DocumentTable
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentTable(Stream, int) | Creates a new instance of this class using default `DocumentTableOptions`. |
| DocumentTable(string, int) | Creates a new instance of this class using default `DocumentTableOptions`. |
| DocumentTable(Stream, int, DocumentTableOptions) | Creates a new instance of this class. |
| DocumentTable(string, int, DocumentTableOptions) | Creates a new instance of this class. |

#### Properties

| Name | Description |
| --- | --- |
| Columns { get; } | Gets the collection of `DocumentTableColumn` objects representing columns of the corresponding table. |
| IndexInDocument { get; } | Gets the original zero-based index of the corresponding table as per the source document. |
| Name { get; set; } | Gets or sets the name of this table used to access the table's data in a template document passed to `DocumentAssembler`. |

##### Remarks

For documents of Spreadsheet file formats, a `DocumentTable` instance represents a single sheet. For documents of other file formats, a `DocumentTable` instance represents a single table.

To access data of the corresponding table while assembling a document, pass an instance of this class as a data source to one of `DocumentAssembler`.AssembleDocument overloads.

In template documents, a `DocumentTable` instance should be treated in the same way as if it was a DataTable instance. See template syntax reference for more information.

### Columns
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttable/columns.md

#### DocumentTable.Columns property

Gets the collection of `DocumentTableColumn` objects representing columns of the corresponding table.

```csharp
public DocumentTableColumnCollection Columns { get; }
```

### DocumentTable
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttable/documenttable.md

#### DocumentTable(string, int)

Creates a new instance of this class using default `DocumentTableOptions`.

```csharp
public DocumentTable(string documentPath, int indexInDocument)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | String | The path to a document containing the table to be accessed. |
| indexInDocument | Int32 | The zero-based index of the table in the document. |

#### DocumentTable(string, int, DocumentTableOptions)

Creates a new instance of this class.

```csharp
public DocumentTable(string documentPath, int indexInDocument, DocumentTableOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | String | The path to a document containing the table to be accessed. |
| indexInDocument | Int32 | The zero-based index of the table in the document. |
| options | DocumentTableOptions | A set of options controlling extraction of data from the table. If null, default options are applied. |

#### DocumentTable(Stream, int)

Creates a new instance of this class using default `DocumentTableOptions`.

```csharp
public DocumentTable(Stream documentStream, int indexInDocument)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | Stream | The stream containing a document with the table to be accessed. |
| indexInDocument | Int32 | The zero-based index of the table in the document. |

#### DocumentTable(Stream, int, DocumentTableOptions)

Creates a new instance of this class.

```csharp
public DocumentTable(Stream documentStream, int indexInDocument, DocumentTableOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | Stream | The stream containing a document with the table to be accessed. |
| indexInDocument | Int32 | The zero-based index of the table in the document. |
| options | DocumentTableOptions | A set of options controlling extraction of data from the table. If null, default options are applied. |

### IndexInDocument
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttable/indexindocument.md

#### DocumentTable.IndexInDocument property

Gets the original zero-based index of the corresponding table as per the source document.

```csharp
public int IndexInDocument { get; }
```

##### Remarks

Depending on an `IDocumentTableLoadHandler` implementation provided, this index may differ from the index of this `DocumentTable` instance within the table collection of the corresponding `DocumentTableSet` instance, if any.

### Name
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttable/name.md

#### DocumentTable.Name property

Gets or sets the name of this table used to access the table's data in a template document passed to `DocumentAssembler`.

```csharp
public string Name { get; set; }
```

##### Remarks

If the table's name is read from a document, the name is automatically corrected so that it to be valid. However, if the table's name is set manually through this property and the name is invalid, an exception is thrown.

The table's name is considered to be valid, if the following conditions are met:

* The name is not empty.
* The name's first character is a letter or underscore.
* The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '#', '$'.
* The corresponding `DocumentTableSet` object does not contain a `DocumentTable` instance with the same name.

### DocumentTableCollection
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecollection.md

#### DocumentTableCollection class

Represents a read-only collection of `DocumentTable` objects of a particular `DocumentTableSet` instance.

```csharp
public class DocumentTableCollection : IEnumerable
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the total number of `DocumentTable` objects in the collection. |
| Item { get; } | Gets a `DocumentTable` instance from the collection at the specified index. (2 indexers) |

#### Methods

| Name | Description |
| --- | --- |
| Contains(DocumentTable) | Returns a value indicating whether this collection contains the specified table. |
| Contains(string) | Returns a value indicating whether this collection contains a table with the specified name. |
| GetEnumerator() | Returns an enumerator to iterate `DocumentTable` objects of this collection. |
| IndexOf(DocumentTable) | Returns the index of the specified table within this collection. |
| IndexOf(string) | Returns the index of a table with the specified name within this collection. |

##### Remarks

The collection is filled automatically while loading the corresponding tables from a document and can not be modified. However, properties of `DocumentTable` objects contained within the collection can be modified.

### Contains
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecollection/contains.md

#### Contains(string)

Returns a value indicating whether this collection contains a table with the specified name.

```csharp
public bool Contains(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of a table to look for. |

##### Return Value

A value indicating whether this collection contains a table with the specified name.

#### Contains(DocumentTable)

Returns a value indicating whether this collection contains the specified table.

```csharp
public bool Contains(DocumentTable table)
```

| Parameter | Type | Description |
| --- | --- | --- |
| table | DocumentTable | A table to look for. |

##### Return Value

A value indicating whether this collection contains the specified table.

### Count
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecollection/count.md

#### DocumentTableCollection.Count property

Gets the total number of `DocumentTable` objects in the collection.

```csharp
public int Count { get; }
```

### GetEnumerator
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecollection/getenumerator.md

#### DocumentTableCollection.GetEnumerator method

Returns an enumerator to iterate `DocumentTable` objects of this collection.

```csharp
public IEnumerator GetEnumerator()
```

##### Return Value

An enumerator to iterate `DocumentTable` objects of this collection.

### IndexOf
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecollection/indexof.md

#### IndexOf(string)

Returns the index of a table with the specified name within this collection.

```csharp
public int IndexOf(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of a table to find. |

##### Return Value

The zero-based index of a table with the specified name, or -1 if the table does not exist in this collection.

#### IndexOf(DocumentTable)

Returns the index of the specified table within this collection.

```csharp
public int IndexOf(DocumentTable table)
```

| Parameter | Type | Description |
| --- | --- | --- |
| table | DocumentTable | A table to find. |

##### Return Value

The zero-based index of the specified table, or -1 if the table does not exist in this collection.

### Item
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecollection/item.md

#### DocumentTableCollection indexer (1 of 2)

Gets a `DocumentTable` instance from the collection at the specified index.

```csharp
public DocumentTable this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the table to return. |

##### Return Value

A `DocumentTable` instance from the collection at the specified index.

#### DocumentTableCollection indexer (2 of 2)

Gets a `DocumentTable` instance with the specified name from the collection.

```csharp
public DocumentTable this[string name] { get; }
```

| Parameter | Description |
| --- | --- |
| name | The case-insensitive name of the table to return. |

##### Return Value

A `DocumentTable` instance with the specified name from the collection or null if such an instance does not exist.

### DocumentTableColumn
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumn.md

#### DocumentTableColumn class

Represents a single column of a particular `DocumentTable` object.

```csharp
public class DocumentTableColumn
```

#### Properties

| Name | Description |
| --- | --- |
| AllowsNull { get; } | Gets a value indicating whether cells in this column contain null values or not. |
| IndexInDocument { get; } | Gets the original zero-based index of the corresponding table column as per the source document. |
| Name { get; set; } | Gets or sets the name of this column used to access the column's data in a template document passed to `DocumentAssembler`. |
| Type { get; set; } | Gets or sets the type of cell values in this column. |

### AllowsNull
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumn/allowsnull.md

#### DocumentTableColumn.AllowsNull property

Gets a value indicating whether cells in this column contain null values or not.

```csharp
public bool AllowsNull { get; }
```

##### Remarks

Undefined and error values in cells of Spreadsheet documents are also considered to be null.

### IndexInDocument
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumn/indexindocument.md

#### DocumentTableColumn.IndexInDocument property

Gets the original zero-based index of the corresponding table column as per the source document.

```csharp
public int IndexInDocument { get; }
```

##### Remarks

Depending on `DocumentTableOptions` specified, this index may differ from the index of this `DocumentTableColumn` instance within the column collection of the corresponding `DocumentTable` instance.

### Name
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumn/name.md

#### DocumentTableColumn.Name property

Gets or sets the name of this column used to access the column's data in a template document passed to `DocumentAssembler`.

```csharp
public string Name { get; set; }
```

##### Remarks

If the column's name is read from a document (see `FirstRowContainsColumnNames`), the name is automatically corrected so that it to be valid. However, if the column's name is set manually through this property and the name is invalid, an exception is thrown.

The column's name is considered to be valid, if the following conditions are met:

* The name is not empty.
* The name's first character is a letter or underscore.
* The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '#', '$'.
* The corresponding `DocumentTable` object does not contain a `DocumentTableColumn` instance with the same name.

### Type
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumn/type.md

#### DocumentTableColumn.Type property

Gets or sets the type of cell values in this column.

```csharp
public Type Type { get; set; }
```

##### Remarks

For documents of non-Spreadsheet file formats, the initial type is always automatically determined as string. For documents of Spreadsheet file formats, the initial type is automatically determined depending on corresponding cell values.

If cells of a particular Spreadsheet column contain values of different types, then the column's initial type is also automatically determined as string.

### DocumentTableColumnCollection
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumncollection.md

#### DocumentTableColumnCollection class

Represents a read-only collection of `DocumentTableColumn` objects of a particular `DocumentTable` instance.

```csharp
public class DocumentTableColumnCollection : IEnumerable
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the total number of `DocumentTableColumn` objects in the collection. |
| Item { get; } | Gets a `DocumentTableColumn` instance from the collection at the specified index. (2 indexers) |

#### Methods

| Name | Description |
| --- | --- |
| Contains(DocumentTableColumn) | Returns a value indicating whether this collection contains the specified column. |
| Contains(string) | Returns a value indicating whether this collection contains a column with the specified name. |
| GetEnumerator() | Returns an enumerator to iterate `DocumentTableColumn` objects of this collection. |
| IndexOf(DocumentTableColumn) | Returns the index of the specified column within this collection. |
| IndexOf(string) | Returns the index of a column with the specified name within this collection. |

##### Remarks

The collection is filled automatically while loading the corresponding table from a document and can not be modified. However, properties of `DocumentTableColumn` objects contained within the collection can be modified.

### Contains
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumncollection/contains.md

#### Contains(string)

Returns a value indicating whether this collection contains a column with the specified name.

```csharp
public bool Contains(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of a column to look for. |

##### Return Value

A value indicating whether this collection contains a column with the specified name.

#### Contains(DocumentTableColumn)

Returns a value indicating whether this collection contains the specified column.

```csharp
public bool Contains(DocumentTableColumn column)
```

| Parameter | Type | Description |
| --- | --- | --- |
| column | DocumentTableColumn | A column to look for. |

##### Return Value

A value indicating whether this collection contains the specified column.

### Count
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumncollection/count.md

#### DocumentTableColumnCollection.Count property

Gets the total number of `DocumentTableColumn` objects in the collection.

```csharp
public int Count { get; }
```

### GetEnumerator
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumncollection/getenumerator.md

#### DocumentTableColumnCollection.GetEnumerator method

Returns an enumerator to iterate `DocumentTableColumn` objects of this collection.

```csharp
public IEnumerator GetEnumerator()
```

##### Return Value

An enumerator to iterate `DocumentTableColumn` objects of this collection.

### IndexOf
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumncollection/indexof.md

#### IndexOf(string)

Returns the index of a column with the specified name within this collection.

```csharp
public int IndexOf(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of a column to find. |

##### Return Value

The zero-based index of a column with the specified name, or -1 if the column does not exist in this collection.

#### IndexOf(DocumentTableColumn)

Returns the index of the specified column within this collection.

```csharp
public int IndexOf(DocumentTableColumn column)
```

| Parameter | Type | Description |
| --- | --- | --- |
| column | DocumentTableColumn | A column to find. |

##### Return Value

The zero-based index of the specified column, or -1 if the column does not exist in this collection.

### Item
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablecolumncollection/item.md

#### DocumentTableColumnCollection indexer (1 of 2)

Gets a `DocumentTableColumn` instance from the collection at the specified index.

```csharp
public DocumentTableColumn this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the column to return. |

##### Return Value

A `DocumentTableColumn` instance from the collection at the specified index.

#### DocumentTableColumnCollection indexer (2 of 2)

Gets a `DocumentTableColumn` instance with the specified name from the collection.

```csharp
public DocumentTableColumn this[string name] { get; }
```

| Parameter | Description |
| --- | --- |
| name | The case-insensitive name of the column to return. |

##### Return Value

A `DocumentTableColumn` instance with the specified name from the collection or null if such an instance does not exist.

### DocumentTableLoadArgs
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableloadargs.md

#### DocumentTableLoadArgs class

Provides data for the `Handle` method.

```csharp
public class DocumentTableLoadArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IsLoaded { get; set; } | Gets or sets a value indicating whether the corresponding document table is to be loaded or not. The default value is true. |
| Options { get; set; } | Gets or sets `DocumentTableOptions` to be used while loading the corresponding document table. The default value is null, which means that default `DocumentTableOptions` are to be applied. |
| TableIndex { get; } | Gets the zero-based index of the corresponding document table to be loaded. |

### IsLoaded
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableloadargs/isloaded.md

#### DocumentTableLoadArgs.IsLoaded property

Gets or sets a value indicating whether the corresponding document table is to be loaded or not. The default value is true.

```csharp
public bool IsLoaded { get; set; }
```

### Options
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableloadargs/options.md

#### DocumentTableLoadArgs.Options property

Gets or sets `DocumentTableOptions` to be used while loading the corresponding document table. The default value is null, which means that default `DocumentTableOptions` are to be applied.

```csharp
public DocumentTableOptions Options { get; set; }
```

### TableIndex
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableloadargs/tableindex.md

#### DocumentTableLoadArgs.TableIndex property

Gets the zero-based index of the corresponding document table to be loaded.

```csharp
public int TableIndex { get; }
```

### DocumentTableOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions.md

#### DocumentTableOptions class

Provides a set of options to control extraction of data from a document table.

```csharp
public class DocumentTableOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentTableOptions() | Creates a new instance of this class. |

#### Properties

| Name | Description |
| --- | --- |
| FirstRowContainsColumnNames { get; set; } | Gets or sets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. |
| MaxColumnIndex { get; set; } | Gets or sets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited. |
| MaxRowIndex { get; set; } | Gets or sets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited. |
| MinColumnIndex { get; set; } | Gets or sets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited. |
| MinRowIndex { get; set; } | Gets or sets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited. |

### DocumentTableOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions/documenttableoptions.md

#### DocumentTableOptions constructor

Creates a new instance of this class.

```csharp
public DocumentTableOptions()
```

### FirstRowContainsColumnNames
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions/firstrowcontainscolumnnames.md

#### DocumentTableOptions.FirstRowContainsColumnNames property

Gets or sets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false.

```csharp
public bool FirstRowContainsColumnNames { get; set; }
```

##### Remarks

If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, ... Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.

### MaxColumnIndex
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions/maxcolumnindex.md

#### DocumentTableOptions.MaxColumnIndex property

Gets or sets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.

```csharp
public int MaxColumnIndex { get; set; }
```

### MaxRowIndex
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions/maxrowindex.md

#### DocumentTableOptions.MaxRowIndex property

Gets or sets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.

```csharp
public int MaxRowIndex { get; set; }
```

### MinColumnIndex
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions/mincolumnindex.md

#### DocumentTableOptions.MinColumnIndex property

Gets or sets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.

```csharp
public int MinColumnIndex { get; set; }
```

### MinRowIndex
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableoptions/minrowindex.md

#### DocumentTableOptions.MinRowIndex property

Gets or sets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.

```csharp
public int MinRowIndex { get; set; }
```

### DocumentTableRelation
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelation.md

#### DocumentTableRelation class

Represents a parent-child relationship between two `DocumentTable` objects.

```csharp
public class DocumentTableRelation
```

#### Properties

| Name | Description |
| --- | --- |
| ChildColumn { get; } | Gets the child column of this relation. |
| ParentColumn { get; } | Gets the parent column of this relation. |

### ChildColumn
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelation/childcolumn.md

#### DocumentTableRelation.ChildColumn property

Gets the child column of this relation.

```csharp
public DocumentTableColumn ChildColumn { get; }
```

### ParentColumn
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelation/parentcolumn.md

#### DocumentTableRelation.ParentColumn property

Gets the parent column of this relation.

```csharp
public DocumentTableColumn ParentColumn { get; }
```

### DocumentTableRelationCollection
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection.md

#### DocumentTableRelationCollection class

Represents the collection of `DocumentTableRelation` objects of a single `DocumentTableSet` instance.

```csharp
public class DocumentTableRelationCollection : IEnumerable
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the total number of `DocumentTableRelation` objects in the collection. |
| Item { get; } | Gets a `DocumentTableRelation` instance from the collection at the specified index. |

#### Methods

| Name | Description |
| --- | --- |
| Add(DocumentTableColumn, DocumentTableColumn) | Creates a `DocumentTableRelation` object for the specified parent and child columns, and adds it to the collection. |
| Clear() | Clears the collection of any relations. |
| Contains(DocumentTableRelation) | Returns a value indicating whether this collection contains the specified relation. |
| GetEnumerator() | Returns an enumerator to iterate `DocumentTableRelation` objects of this collection. |
| IndexOf(DocumentTableRelation) | Returns the index of the specified relation within this collection. |
| Remove(DocumentTableRelation) | Removes the specified relation from the collection. |
| RemoveAt(int) | Removes the relation at the specified index from the collection. |

### Add
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/add.md

#### DocumentTableRelationCollection.Add method

Creates a `DocumentTableRelation` object for the specified parent and child columns, and adds it to the collection.

```csharp
public DocumentTableRelation Add(DocumentTableColumn parentColumn, DocumentTableColumn childColumn)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parentColumn | DocumentTableColumn | The parent column of the relation. |
| childColumn | DocumentTableColumn | The child column of the relation. |

##### Return Value

The created relation.

### Clear
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/clear.md

#### DocumentTableRelationCollection.Clear method

Clears the collection of any relations.

```csharp
public void Clear()
```

### Contains
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/contains.md

#### DocumentTableRelationCollection.Contains method

Returns a value indicating whether this collection contains the specified relation.

```csharp
public bool Contains(DocumentTableRelation relation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| relation | DocumentTableRelation | A relation to look for. |

##### Return Value

A value indicating whether this collection contains the specified relation.

### Count
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/count.md

#### DocumentTableRelationCollection.Count property

Gets the total number of `DocumentTableRelation` objects in the collection.

```csharp
public int Count { get; }
```

### GetEnumerator
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/getenumerator.md

#### DocumentTableRelationCollection.GetEnumerator method

Returns an enumerator to iterate `DocumentTableRelation` objects of this collection.

```csharp
public IEnumerator GetEnumerator()
```

##### Return Value

An enumerator to iterate `DocumentTableRelation` objects of this collection.

### IndexOf
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/indexof.md

#### DocumentTableRelationCollection.IndexOf method

Returns the index of the specified relation within this collection.

```csharp
public int IndexOf(DocumentTableRelation relation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| relation | DocumentTableRelation | A relation to find. |

##### Return Value

The zero-based index of the specified relation, or -1 if the relation does not exist in this collection.

### Item
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/item.md

#### DocumentTableRelationCollection indexer

Gets a `DocumentTableRelation` instance from the collection at the specified index.

```csharp
public DocumentTableRelation this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the relation to return. |

##### Return Value

A `DocumentTableRelation` instance from the collection at the specified index.

### Remove
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/remove.md

#### DocumentTableRelationCollection.Remove method

Removes the specified relation from the collection.

```csharp
public void Remove(DocumentTableRelation relation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| relation | DocumentTableRelation | The relation to remove. |

### RemoveAt
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttablerelationcollection/removeat.md

#### DocumentTableRelationCollection.RemoveAt method

Removes the relation at the specified index from the collection.

```csharp
public void RemoveAt(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The index of the relation to remove. |

### DocumentTableSet
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableset.md

#### DocumentTableSet class

Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while assembling a document. Also, enables to define parent-child relations for the document tables thus simplifying access to related data within template documents.

```csharp
public class DocumentTableSet
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentTableSet(Stream) | Creates a new instance of this class loading all tables from a document using default `DocumentTableOptions`. |
| DocumentTableSet(string) | Creates a new instance of this class loading all tables from a document using default `DocumentTableOptions`. |
| DocumentTableSet(Stream, IDocumentTableLoadHandler) | Creates a new instance of this class. |
| DocumentTableSet(string, IDocumentTableLoadHandler) | Creates a new instance of this class. |

#### Properties

| Name | Description |
| --- | --- |
| Relations { get; } | Gets the collection of parent-child relations defined for document tables of this set. |
| Tables { get; } | Gets the collection of `DocumentTable` objects representing tables of this set. |

##### Remarks

For documents of Spreadsheet file formats, a `DocumentTableSet` instance represents a set of sheets. For documents of other file formats, a `DocumentTableSet` instance represents a set of tables.

To access data of the corresponding tables while assembling a document, pass an instance of this class as a data source to one of `DocumentAssembler`.AssembleDocument overloads.

In template documents, a `DocumentTableSet` instance should be treated in the same way as if it was a DataSet instance. See template syntax reference for more information.

### DocumentTableSet
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableset/documenttableset.md

#### DocumentTableSet(string)

Creates a new instance of this class loading all tables from a document using default `DocumentTableOptions`.

```csharp
public DocumentTableSet(string documentPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | String | The path to a document containing tables to be accessed. |

#### DocumentTableSet(string, IDocumentTableLoadHandler)

Creates a new instance of this class.

```csharp
public DocumentTableSet(string documentPath, IDocumentTableLoadHandler loadHandler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentPath | String | The path to a document containing tables to be accessed. |
| loadHandler | IDocumentTableLoadHandler | An `IDocumentTableLoadHandler` implementation controlling how document tables are loaded. |

#### DocumentTableSet(Stream)

Creates a new instance of this class loading all tables from a document using default `DocumentTableOptions`.

```csharp
public DocumentTableSet(Stream documentStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | Stream | The stream containing a document with tables to be accessed. |

#### DocumentTableSet(Stream, IDocumentTableLoadHandler)

Creates a new instance of this class.

```csharp
public DocumentTableSet(Stream documentStream, IDocumentTableLoadHandler loadHandler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStream | Stream | The stream containing a document with tables to be accessed. |
| loadHandler | IDocumentTableLoadHandler | An `IDocumentTableLoadHandler` implementation controlling how document tables are loaded. |

### Relations
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableset/relations.md

#### DocumentTableSet.Relations property

Gets the collection of parent-child relations defined for document tables of this set.

```csharp
public DocumentTableRelationCollection Relations { get; }
```

### Tables
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/documenttableset/tables.md

#### DocumentTableSet.Tables property

Gets the collection of `DocumentTable` objects representing tables of this set.

```csharp
public DocumentTableCollection Tables { get; }
```

### IDocumentTableLoadHandler
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/idocumenttableloadhandler.md

#### IDocumentTableLoadHandler interface

Overrides default loading of `DocumentTable` objects while creating a `DocumentTableSet` instance.

```csharp
public interface IDocumentTableLoadHandler
```

#### Methods

| Name | Description |
| --- | --- |
| Handle(DocumentTableLoadArgs) | Overrides default loading of a particular `DocumentTable` object while creating a `DocumentTableSet` instance. |

##### Remarks

Implement this interface if you want to discard loading of specific `DocumentTable` objects or provide specific `DocumentTableOptions` for document tables being loaded.

### Handle
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/idocumenttableloadhandler/handle.md

#### IDocumentTableLoadHandler.Handle method

Overrides default loading of a particular `DocumentTable` object while creating a `DocumentTableSet` instance.

```csharp
public void Handle(DocumentTableLoadArgs args)
```

### JsonDataLoadOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondataloadoptions.md

#### JsonDataLoadOptions class

Represents options for parsing JSON data.

```csharp
public class JsonDataLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| JsonDataLoadOptions() | Initializes a new instance of this class with default options. |

#### Properties

| Name | Description |
| --- | --- |
| AlwaysGenerateRootObject { get; set; } | Gets or sets a flag indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default. |
| ExactDateTimeParseFormats { get; set; } | Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is **null**. |
| SimpleValueParseMode { get; set; } | Gets or sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is Loose. |

##### Remarks

An instance of this class can be passed into constructors of `JsonDataSource`.

### AlwaysGenerateRootObject
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondataloadoptions/alwaysgeneraterootobject.md

#### JsonDataLoadOptions.AlwaysGenerateRootObject property

Gets or sets a flag indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default.

```csharp
public bool AlwaysGenerateRootObject { get; set; }
```

##### Remarks

The default value is **false**.

### ExactDateTimeParseFormats
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondataloadoptions/exactdatetimeparseformats.md

#### JsonDataLoadOptions.ExactDateTimeParseFormats property

Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is **null**.

```csharp
public IEnumerable<string> ExactDateTimeParseFormats { get; set; }
```

##### Remarks

Strings encoded using Microsoft® JSON date-time format (for example, "/Date(1224043200000)/") are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

* When `ExactDateTimeParseFormats` is **null**, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
* When `ExactDateTimeParseFormats` contains strings, they are used as additional date-time formats utilizing the current culture.
* When `ExactDateTimeParseFormats` is empty, no additional date-time formats are used.

### JsonDataLoadOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondataloadoptions/jsondataloadoptions.md

#### JsonDataLoadOptions constructor

Initializes a new instance of this class with default options.

```csharp
public JsonDataLoadOptions()
```

### SimpleValueParseMode
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondataloadoptions/simplevalueparsemode.md

#### JsonDataLoadOptions.SimpleValueParseMode property

Gets or sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is Loose.

```csharp
public JsonSimpleValueParseMode SimpleValueParseMode { get; set; }
```

### JsonDataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondatasource.md

#### JsonDataSource class

Provides access to data of a JSON file or stream to be used while assembling a document.

```csharp
public class JsonDataSource
```

#### Constructors

| Name | Description |
| --- | --- |
| JsonDataSource(Stream) | Creates a new data source with data from a JSON stream using default options for parsing JSON data. |
| JsonDataSource(string) | Creates a new data source with data from a JSON file using default options for parsing JSON data. |
| JsonDataSource(Stream, JsonDataLoadOptions) | Creates a new data source with data from a JSON stream using the specified options for parsing JSON data. |
| JsonDataSource(string, JsonDataLoadOptions) | Creates a new data source with data from a JSON file using the specified options for parsing JSON data. |

##### Remarks

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as a data source to one of `DocumentAssembler`.AssembleDocument overloads.

In template documents, if a top-level JSON element is an array, a `JsonDataSource` instance should be treated in the same way as if it was a DataTable instance. If a top-level JSON element is an object, a `JsonDataSource` instance should be treated in the same way as if it was a DataRow instance. For more information, see template syntax reference (https://docs.groupdocs.com/display/assemblynet/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

In template documents, you can work with typed values of JSON elements. For convenience, the engine replaces the set of JSON simple types with the following one:

* `long?`
* `double?`
* `bool?`
* `DateTime?`
* `string`

The engine automatically recognizes values of the extra types upon their JSON representations.

To override default behavior of JSON data loading, initialize and pass a `JsonDataLoadOptions` instance to a constructor of this class.

### JsonDataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsondatasource/jsondatasource.md

#### JsonDataSource(string)

Creates a new data source with data from a JSON file using default options for parsing JSON data.

```csharp
public JsonDataSource(string jsonPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| jsonPath | String | The path to the JSON file to be used as the data source. |

#### JsonDataSource(string, JsonDataLoadOptions)

Creates a new data source with data from a JSON file using the specified options for parsing JSON data.

```csharp
public JsonDataSource(string jsonPath, JsonDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| jsonPath | String | The path to the JSON file to be used as the data source. |
| options | JsonDataLoadOptions | Options for parsing JSON data. |

#### JsonDataSource(Stream)

Creates a new data source with data from a JSON stream using default options for parsing JSON data.

```csharp
public JsonDataSource(Stream jsonStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| jsonStream | Stream | The stream of JSON data to be used as the data source. |

#### JsonDataSource(Stream, JsonDataLoadOptions)

Creates a new data source with data from a JSON stream using the specified options for parsing JSON data.

```csharp
public JsonDataSource(Stream jsonStream, JsonDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| jsonStream | Stream | The stream of JSON data to be used as the data source. |
| options | JsonDataLoadOptions | Options for parsing JSON data. |

### JsonSimpleValueParseMode
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/jsonsimplevalueparsemode.md

#### JsonSimpleValueParseMode enumeration

Specifies a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values.

```csharp
public enum JsonSimpleValueParseMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Loose | `0` | Specifies the mode where types of JSON simple values are determined upon parsing of their string representations. For example, the type of 'prop' from the JSON snippet '{ prop: "123" }' is determined as integer in this mode. |
| Strict | `1` | Specifies the mode where types of JSON simple values are determined from JSON notation itself. For example, the type of 'prop' from the JSON snippet '{ prop: "123" }' is determined as string in this mode. |

### XmlDataLoadOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/xmldataloadoptions.md

#### XmlDataLoadOptions class

Represents options for XML data loading.

```csharp
public class XmlDataLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| XmlDataLoadOptions() | Initializes a new instance of this class with default options. |

#### Properties

| Name | Description |
| --- | --- |
| AlwaysGenerateRootObject { get; set; } | Gets or sets a flag indicating whether a generated data source will always contain an object for an XML root element. If an XML root element has no attributes and all its child elements have same names, such an object is not created by default. |

##### Remarks

An instance of this class can be passed into constructors of `XmlDataSource`.

### AlwaysGenerateRootObject
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/xmldataloadoptions/alwaysgeneraterootobject.md

#### XmlDataLoadOptions.AlwaysGenerateRootObject property

Gets or sets a flag indicating whether a generated data source will always contain an object for an XML root element. If an XML root element has no attributes and all its child elements have same names, such an object is not created by default.

```csharp
public bool AlwaysGenerateRootObject { get; set; }
```

##### Remarks

The default value is **false**.

### XmlDataLoadOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/xmldataloadoptions/xmldataloadoptions.md

#### XmlDataLoadOptions constructor

Initializes a new instance of this class with default options.

```csharp
public XmlDataLoadOptions()
```

### XmlDataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/xmldatasource.md

#### XmlDataSource class

Provides access to data of an XML file or stream to be used while assembling a document.

```csharp
public class XmlDataSource
```

#### Constructors

| Name | Description |
| --- | --- |
| XmlDataSource(Stream) | Creates a new data source with data from an XML stream using default options for XML data loading. |
| XmlDataSource(string) | Creates a new data source with data from an XML file using default options for XML data loading. |
| XmlDataSource(Stream, Stream) | Creates a new data source with data from an XML stream using an XML Schema Definition stream. Default options are used for XML data loading. |
| XmlDataSource(Stream, XmlDataLoadOptions) | Creates a new data source with data from an XML stream using the specified options for XML data loading. |
| XmlDataSource(string, string) | Creates a new data source with data from an XML file using an XML Schema Definition file. Default options are used for XML data loading. |
| XmlDataSource(string, XmlDataLoadOptions) | Creates a new data source with data from an XML file using the specified options for XML data loading. |
| XmlDataSource(Stream, Stream, XmlDataLoadOptions) | Creates a new data source with data from an XML stream using an XML Schema Definition stream. The specified options are used for XML data loading. |
| XmlDataSource(string, string, XmlDataLoadOptions) | Creates a new data source with data from an XML file using an XML Schema Definition file. The specified options are used for XML data loading. |

##### Remarks

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as a data source to one of `DocumentAssembler`.AssembleDocument overloads.

In template documents, if a top-level XML element contains only a list of elements of the same type, an `XmlDataSource` instance should be treated in the same way as if it was a DataTable instance. Otherwise, an `XmlDataSource` instance should be treated in the same way as if it was a DataRow instance. For more information, see template syntax reference (https://docs.groupdocs.com/display/assemblynet/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

When XML Schema Definition is passed to a constructor of this class, data types of values of simple XML elements and attributes are determined according to the schema. So in template documents, you can work with typed values rather than just strings.

When XML Schema Definition is not passed to a constructor of this class, data types of values of simple XML elements and attributes are determined automatically upon their string representations. So in template documents, you can work with typed values in this case as well. The engine is capable to automatically recognize values of the following types:

* `long?`
* `double?`
* `bool?`
* `DateTime?`
* `string`

Note that for automatic recognition of data types to work, string representations of values of simple XML elements and attributes should be formed using invariant culture settings.

To override default behavior of XML data loading, initialize and pass a `XmlDataLoadOptions` instance to a constructor of this class.

### XmlDataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.data/xmldatasource/xmldatasource.md

#### XmlDataSource(string)

Creates a new data source with data from an XML file using default options for XML data loading.

```csharp
public XmlDataSource(string xmlPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | String | The path to the XML file to be used as the data source. |

#### XmlDataSource(Stream)

Creates a new data source with data from an XML stream using default options for XML data loading.

```csharp
public XmlDataSource(Stream xmlStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | Stream | The stream of XML data to be used as the data source. |

#### XmlDataSource(string, string)

Creates a new data source with data from an XML file using an XML Schema Definition file. Default options are used for XML data loading.

```csharp
public XmlDataSource(string xmlPath, string xmlSchemaPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | String | The path to the XML file to be used as the data source. |
| xmlSchemaPath | String | The path to the XML Schema Definition file that provides schema for the XML file. |

#### XmlDataSource(Stream, Stream)

Creates a new data source with data from an XML stream using an XML Schema Definition stream. Default options are used for XML data loading.

```csharp
public XmlDataSource(Stream xmlStream, Stream xmlSchemaStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | Stream | The stream of XML data to be used as the data source. |
| xmlSchemaStream | Stream | The stream of XML Schema Definition that provides schema for the XML data. |

#### XmlDataSource(string, XmlDataLoadOptions)

Creates a new data source with data from an XML file using the specified options for XML data loading.

```csharp
public XmlDataSource(string xmlPath, XmlDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | String | The path to the XML file to be used as the data source. |
| options | XmlDataLoadOptions | Options for XML data loading. |

#### XmlDataSource(Stream, XmlDataLoadOptions)

Creates a new data source with data from an XML stream using the specified options for XML data loading.

```csharp
public XmlDataSource(Stream xmlStream, XmlDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | Stream | The stream of XML data to be used as the data source. |
| options | XmlDataLoadOptions | Options for XML data loading. |

#### XmlDataSource(string, string, XmlDataLoadOptions)

Creates a new data source with data from an XML file using an XML Schema Definition file. The specified options are used for XML data loading.

```csharp
public XmlDataSource(string xmlPath, string xmlSchemaPath, XmlDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlPath | String | The path to the XML file to be used as the data source. |
| xmlSchemaPath | String | The path to the XML Schema Definition file that provides schema for the XML file. |
| options | XmlDataLoadOptions | Options for XML data loading. |

#### XmlDataSource(Stream, Stream, XmlDataLoadOptions)

Creates a new data source with data from an XML stream using an XML Schema Definition stream. The specified options are used for XML data loading.

```csharp
public XmlDataSource(Stream xmlStream, Stream xmlSchemaStream, XmlDataLoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| xmlStream | Stream | The stream of XML data to be used as the data source. |
| xmlSchemaStream | Stream | The stream of XML Schema Definition that provides schema for the XML data. |
| options | XmlDataLoadOptions | Options for XML data loading. |

### GroupDocs.Assembly
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly.md

Provides classes for generating documents in popular office file formats based upon template documents and data obtained from various sources including databases, XML, JSON, OData, objects of custom .NET types, and more.

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSettings | Represents a set of settings controlling barcode generation while assembling a document. |
| DataSourceInfo | Provides information on a single data source object to be used to assemble a document from a template. |
| DocumentAssembler | Provides routines to populate template documents with data and a set of settings to control these routines. |
| KnownTypeSet | Represents an unordered set (that is, a collection of unique items) containing Type objects which fully or partially qualified names can be used within document templates to invoke the corresponding types' static members, perform type casts, etc. |
| License | Provides methods to license the component. |
| LoadSaveOptions | Specifies additional options for loading and saving of a document to be assembled. |
| Metered | Provides methods to work with metered licensing. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| DocumentAssemblyOptions | Specifies options controlling behavior of `DocumentAssembler` while assembling a document. |
| FileFormat | Specifies the format of a file. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Assembly.dll -->

### BarcodeSettings
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/barcodesettings.md

#### BarcodeSettings class

Represents a set of settings controlling barcode generation while assembling a document.

```csharp
public class BarcodeSettings
```

#### Properties

| Name | Description |
| --- | --- |
| BaseXDimension { get; set; } | Gets or sets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. Measured in `GraphicsUnit`. |
| BaseYDimension { get; set; } | Gets or sets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules. Measured in `GraphicsUnit`. |
| GraphicsUnit { get; set; } | Gets or sets a graphics unit used to measure `BaseXDimension` and `BaseYDimension`. The default value is Millimeter. |
| Resolution { get; set; } | Gets or sets the horizontal and vertical resolution of a barcode image being generated. Measured in dots per inch. The default value is 96. |
| UseAutoCorrection { get; set; } | Gets or sets a value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. The default value is true. |

### BaseXDimension
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/barcodesettings/basexdimension.md

#### BarcodeSettings.BaseXDimension property

Gets or sets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces. Measured in `GraphicsUnit`.

```csharp
public float BaseXDimension { get; set; }
```

##### Remarks

When barcode scaling is applied through a template, an actual x-dimension is calculated upon the base x-dimension and a scaling factor.

### BaseYDimension
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/barcodesettings/baseydimension.md

#### BarcodeSettings.BaseYDimension property

Gets or sets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules. Measured in `GraphicsUnit`.

```csharp
public float BaseYDimension { get; set; }
```

##### Remarks

Barcodes of some types (such as data matrix) may ignore an y-dimension and use an x-dimension for both width and height units.

When barcode scaling is applied through a template, an actual y-dimension is calculated upon the base y-dimension and a scaling factor.

### GraphicsUnit
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/barcodesettings/graphicsunit.md

#### BarcodeSettings.GraphicsUnit property

Gets or sets a graphics unit used to measure `BaseXDimension` and `BaseYDimension`. The default value is Millimeter.

```csharp
public GraphicsUnit GraphicsUnit { get; set; }
```

### Resolution
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/barcodesettings/resolution.md

#### BarcodeSettings.Resolution property

Gets or sets the horizontal and vertical resolution of a barcode image being generated. Measured in dots per inch. The default value is 96.

```csharp
public float Resolution { get; set; }
```

### UseAutoCorrection
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/barcodesettings/useautocorrection.md

#### BarcodeSettings.UseAutoCorrection property

Gets or sets a value indicating whether an invalid barcode value should be corrected automatically (if possible) to fit the barcode's specification or an exception should be thrown to indicate the error. The default value is true.

```csharp
public bool UseAutoCorrection { get; set; }
```

##### Remarks

The auto-correction is not possible for Databar barcodes.

### DataSourceInfo
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/datasourceinfo.md

#### DataSourceInfo class

Provides information on a single data source object to be used to assemble a document from a template.

```csharp
public class DataSourceInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| DataSourceInfo() | Creates a new instance of this class without any properties specified. |
| DataSourceInfo(object) | Creates a new instance of this class with the data source object specified. |
| DataSourceInfo(object, string) | Creates a new instance of this class with the data source object and its name specified. |

#### Properties

| Name | Description |
| --- | --- |
| DataSource { get; set; } | Gets or sets the data source object. |
| Name { get; set; } | Gets or sets the name of the data source object to be used to access the data source object in a template document. |

### DataSource
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/datasourceinfo/datasource.md

#### DataSourceInfo.DataSource property

Gets or sets the data source object.

```csharp
public object DataSource { get; set; }
```

##### Remarks

The data source object can be of one of the following types:

* `XmlDataSource`
* `JsonDataSource`
* `CsvDataSource`
* `DocumentTableSet`
* `DocumentTable`
* DataSet
* DataTable
* DataRow
* IDataReader
* IDataRecord
* DataView
* DataRowView
* Any other arbitrary non-dynamic and non-anonymous .NET type

For information on how to work with data sources of different types in template documents, see template syntax reference (https://docs.groupdocs.com/display/assemblynet/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

### DataSourceInfo
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/datasourceinfo/datasourceinfo.md

#### DataSourceInfo()

Creates a new instance of this class without any properties specified.

```csharp
public DataSourceInfo()
```

#### DataSourceInfo(object)

Creates a new instance of this class with the data source object specified.

```csharp
public DataSourceInfo(object dataSource)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataSource | Object | The data source object. |

##### Remarks

The data source object can be of one of the following types:

* `XmlDataSource`
* `JsonDataSource`
* `CsvDataSource`
* `DocumentTableSet`
* `DocumentTable`
* DataSet
* DataTable
* DataRow
* IDataReader
* IDataRecord
* DataView
* DataRowView
* Any other arbitrary non-dynamic and non-anonymous .NET type

For information on how to work with data sources of different types in template documents, see template syntax reference (https://docs.groupdocs.com/display/assemblynet/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

#### DataSourceInfo(object, string)

Creates a new instance of this class with the data source object and its name specified.

```csharp
public DataSourceInfo(object dataSource, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataSource | Object | The data source object. |
| name | String | The name of the data source object to be used to access the data source object in a template document. |

##### Remarks

The data source object can be of one of the following types:

* `XmlDataSource`
* `JsonDataSource`
* `CsvDataSource`
* `DocumentTableSet`
* `DocumentTable`
* DataSet
* DataTable
* DataRow
* IDataReader
* IDataRecord
* DataView
* DataRowView
* Any other arbitrary non-dynamic and non-anonymous .NET type

For information on how to work with data sources of different types in template documents, see template syntax reference (https://docs.groupdocs.com/display/assemblynet/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple `DataSourceInfo` instances to `DocumentAssembler`, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

### Name
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/datasourceinfo/name.md

#### DataSourceInfo.Name property

Gets or sets the name of the data source object to be used to access the data source object in a template document.

```csharp
public string Name { get; set; }
```

##### Remarks

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple `DataSourceInfo` instances to `DocumentAssembler`, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

### DocumentAssembler
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler.md

#### DocumentAssembler class

Provides routines to populate template documents with data and a set of settings to control these routines.

```csharp
public class DocumentAssembler
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentAssembler() | Initializes a new instance of this class. |

#### Properties

| Name | Description |
| --- | --- |
| BarcodeSettings { get; } | Gets a set of settings controlling barcode generation while assembling a document. |
| KnownTypes { get; } | Gets an unordered set (that is, a collection of unique items) containing Type objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types' static members, perform type casts, etc. |
| Options { get; set; } | Gets or sets a set of flags controlling behavior of this `DocumentAssembler` instance while assembling a document. |
| static UseReflectionOptimization { get; set; } | Gets or sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true. |

#### Methods

| Name | Description |
| --- | --- |
| AssembleDocument(Stream, Stream, params DataSourceInfo[]) | Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using default `LoadSaveOptions`. |
| AssembleDocument(string, string, params DataSourceInfo[]) | Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using default `LoadSaveOptions`. |
| AssembleDocument(Stream, Stream, LoadSaveOptions, params DataSourceInfo[]) | Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using the given `LoadSaveOptions`. |
| AssembleDocument(string, string, LoadSaveOptions, params DataSourceInfo[]) | Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using the given `LoadSaveOptions`. |

### AssembleDocument
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler/assembledocument.md

#### AssembleDocument(string, string, params DataSourceInfo[])

Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using default `LoadSaveOptions`.

```csharp
public bool AssembleDocument(string sourcePath, string targetPath, 
    params DataSourceInfo[] dataSourceInfos)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to a template document to be populated with data. |
| targetPath | String | The path to a result document. |
| dataSourceInfos | DataSourceInfo[] | Provides information on data source objects to be used. |

##### Return Value

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the `Options` property includes the InlineErrorMessages option.

#### AssembleDocument(string, string, LoadSaveOptions, params DataSourceInfo[])

Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using the given `LoadSaveOptions`.

```csharp
public bool AssembleDocument(string sourcePath, string targetPath, LoadSaveOptions loadSaveOptions, 
    params DataSourceInfo[] dataSourceInfos)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to a template document to be populated with data. |
| targetPath | String | The path to a result document. |
| loadSaveOptions | LoadSaveOptions | Specifies additional options for document loading and saving. |
| dataSourceInfos | DataSourceInfo[] | Provides information on data source objects to be used. |

##### Return Value

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the `Options` property includes the InlineErrorMessages option.

#### AssembleDocument(Stream, Stream, params DataSourceInfo[])

Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using default `LoadSaveOptions`.

```csharp
public bool AssembleDocument(Stream sourceStream, Stream targetStream, 
    params DataSourceInfo[] dataSourceInfos)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | Stream | The stream to read a template document from. |
| targetStream | Stream | The stream to write a result document. |
| dataSourceInfos | DataSourceInfo[] | Provides information on data source objects to be used. |

##### Return Value

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the `Options` property includes the InlineErrorMessages option.

#### AssembleDocument(Stream, Stream, LoadSaveOptions, params DataSourceInfo[])

Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using the given `LoadSaveOptions`.

```csharp
public bool AssembleDocument(Stream sourceStream, Stream targetStream, 
    LoadSaveOptions loadSaveOptions, params DataSourceInfo[] dataSourceInfos)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | Stream | The stream to read a template document from. |
| targetStream | Stream | The stream to write a result document. |
| loadSaveOptions | LoadSaveOptions | Specifies additional options for document loading and saving. |
| dataSourceInfos | DataSourceInfo[] | Provides information on data source objects to be used. |

##### Return Value

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the `Options` property includes the InlineErrorMessages option.

### BarcodeSettings
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler/barcodesettings.md

#### DocumentAssembler.BarcodeSettings property

Gets a set of settings controlling barcode generation while assembling a document.

```csharp
public BarcodeSettings BarcodeSettings { get; }
```

### DocumentAssembler
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler/documentassembler.md

#### DocumentAssembler constructor

Initializes a new instance of this class.

```csharp
public DocumentAssembler()
```

### KnownTypes
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler/knowntypes.md

#### DocumentAssembler.KnownTypes property

Gets an unordered set (that is, a collection of unique items) containing Type objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types' static members, perform type casts, etc.

```csharp
public KnownTypeSet KnownTypes { get; }
```

### Options
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler/options.md

#### DocumentAssembler.Options property

Gets or sets a set of flags controlling behavior of this `DocumentAssembler` instance while assembling a document.

```csharp
public DocumentAssemblyOptions Options { get; set; }
```

### UseReflectionOptimization
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassembler/usereflectionoptimization.md

#### DocumentAssembler.UseReflectionOptimization property

Gets or sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true.

```csharp
public static bool UseReflectionOptimization { get; set; }
```

##### Remarks

There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls.

### DocumentAssemblyOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/documentassemblyoptions.md

#### DocumentAssemblyOptions enumeration

Specifies options controlling behavior of `DocumentAssembler` while assembling a document.

```csharp
[Flags]
public enum DocumentAssemblyOptions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies default options. |
| AllowMissingMembers | `1` | Specifies that missing object members should be treated as null literals by the assembler. This option affects only access to instance (that is, non-static) object members and extension methods. If this option is not set, the assembler throws an exception when encounters a missing object member. |
| UpdateFieldsAndFormulas | `2` | Specifies that fields of result Word Processing documents and formulas of result Spreadsheet documents should be updated by the assembler. |
| RemoveEmptyParagraphs | `4` | Specifies that the assembler should remove paragraphs becoming empty after template syntax tags are removed or replaced with empty values. |
| InlineErrorMessages | `8` | Specifies that the assembler should inline template syntax error messages into output documents. If this option is not set, the assembler throws an exception when encounters a syntax error. |
| UseSpreadsheetDataTypes | `10` | Relates to Spreadsheet documents only. Specifies that evaluated expression results should be mapped to corresponding Spreadsheet data types, which also affects their default formatting within cells. If this option is not set, expression results are always written as strings by the assembler. This option has no effect when expression results are formatted using template syntax - expression results are always written as strings then as well. |

### FileFormat
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/fileformat.md

#### FileFormat enumeration

Specifies the format of a file.

```csharp
public enum FileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unspecified | `0` | Specifies an unset value. The default. |
| Doc | `1` | Specifies the Microsoft Word 97 - 2007 Binary Document format. |
| Dot | `2` | Specifies the Microsoft Word 97 - 2007 Binary Template format. |
| Docx | `3` | Specifies the Office Open XML WordprocessingML Document (macro-free) format. |
| Docm | `4` | Specifies the Office Open XML WordprocessingML Macro-Enabled Document format. |
| Dotx | `5` | Specifies the Office Open XML WordprocessingML Template (macro-free) format. |
| Dotm | `6` | Specifies the Office Open XML WordprocessingML Macro-Enabled Template format. |
| FlatOpc | `7` | Specifies the Office Open XML WordprocessingML format stored in a flat XML file instead of a ZIP package. |
| FlatOpcMacroEnabled | `8` | Specifies the Office Open XML WordprocessingML Macro-Enabled Document format stored in a flat XML file instead of a ZIP package. |
| FlatOpcTemplate | `9` | Specifies the Office Open XML WordprocessingML Template (macro-free) format stored in a flat XML file instead of a ZIP package. |
| FlatOpcTemplateMacroEnabled | `10` | Specifies the Office Open XML WordprocessingML Macro-Enabled Template format stored in a flat XML file instead of a ZIP package. |
| WordML | `11` | Specifies the Microsoft Word 2003 WordprocessingML format. |
| Odt | `12` | Specifies the ODF Text Document format. |
| Ott | `13` | Specifies the ODF Text Document Template format. |
| Xls | `14` | Specifies the Microsoft Excel 97 - 2007 Binary Workbook format. |
| Xlsx | `15` | Specifies the Office Open XML SpreadsheetML Workbook (macro-free) format. |
| Xlsm | `16` | Specifies the Office Open XML SpreadsheetML Macro-Enabled Workbook format. |
| Xltx | `17` | Specifies the Office Open XML SpreadsheetML Template (macro-free) format. |
| Xltm | `18` | Specifies the Office Open XML SpreadsheetML Macro-Enabled Template format. |
| Xlam | `19` | Specifies the Office Open XML SpreadsheetML Macro-Enabled Add-in format. |
| Xlsb | `20` | Specifies the Microsoft Excel 2007 Macro-Enabled Binary File format. |
| SpreadsheetML | `21` | Specifies the Microsoft Excel 2003 SpreadsheetML format. |
| Ods | `22` | Specifies the ODF Spreadsheet format. |
| Ppt | `23` | Specifies the Microsoft PowerPoint 97 - 2007 Binary Presentation format. |
| Pps | `24` | Specifies the Microsoft PowerPoint 97 - 2007 Binary Slide Show format. |
| Pptx | `25` | Specifies the Office Open XML PresentationML Presentation (macro-free) format. |
| Pptm | `26` | Specifies the Office Open XML PresentationML Macro-Enabled Presentation format. |
| Ppsx | `27` | Specifies the Office Open XML PresentationML Slide Show (macro-free) format. |
| Ppsm | `28` | Specifies the Office Open XML PresentationML Macro-Enabled Slide Show format. |
| Potx | `29` | Specifies the Office Open XML PresentationML Template (macro-free) format. |
| Potm | `30` | Specifies the Office Open XML PresentationML Macro-Enabled Template format. |
| Odp | `31` | Specifies the ODF Presentation format. |
| MsgAscii | `32` | Specifies the Microsoft Outlook Message (MSG) format using ASCII character encoding. |
| MsgUnicode | `33` | Specifies the Microsoft Outlook Message (MSG) format using Unicode character encoding. |
| Eml | `34` | Specifies the MIME standard format. |
| Emlx | `35` | Specifies the Apple Mail.app program file format. |
| Rtf | `36` | Specifies the RTF format. |
| Text | `37` | Specifies the plain text format. |
| Xml | `38` | Specifies the XML format of a general form. |
| Xaml | `39` | Specifies the Extensible Application Markup Language (XAML) format. |
| XamlPackage | `40` | Specifies the Extensible Application Markup Language (XAML) package format. |
| Html | `41` | Specifies the HTML format. |
| Mhtml | `42` | Specifies the MHTML (Web archive) format. |
| Xps | `43` | Specifies the XPS (XML Paper Specification) format. |
| OpenXps | `44` | Specifies the OpenXPS (Ecma-388) format. |
| Pdf | `45` | Specifies the PDF (Adobe Portable Document) format. |
| Epub | `46` | Specifies the IDPF EPUB format. |
| Ps | `47` | Specifies the PS (PostScript) format. |
| Pcl | `48` | Specifies the PCL (Printer Control Language) format. |
| Svg | `49` | Specifies the SVG (Scalable Vector Graphics) format. |
| Tiff | `50` | Specifies the TIFF format. |
| Markdown | `51` | Specifies the Markdown format. |
| Pot | `52` | Specifies the Microsoft PowerPoint 97 - 2007 Binary Template format. |
| Otp | `53` | Specifies the ODF Presentation Template format. |
| Xlt | `54` | Specifies the Microsoft Excel 97 - 2007 Binary Template format. |

### KnownTypeSet
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/knowntypeset.md

#### KnownTypeSet class

Represents an unordered set (that is, a collection of unique items) containing Type objects which fully or partially qualified names can be used within document templates to invoke the corresponding types' static members, perform type casts, etc.

```csharp
public class KnownTypeSet : IEnumerable
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the count of items in the set. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Type) | Adds the specified Type object to the set. |
| Clear() | Removes all items from the set. |
| GetEnumerator() | Returns An IEnumerator object to iterate over items of the set. |
| Remove(Type) | Removes the specified Type object from the set. |

### Add
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/knowntypeset/add.md

#### KnownTypeSet.Add method

Adds the specified Type object to the set.

Throws ArgumentException in the following cases:

- *type* is null.

- *type* represents a void type.

- *type* represents an invisible type, i.e. a non-public type or a public nested type which has a non-public outer type.

- *type* represents a generic type.

- *type* represents an array type.

- *type* has been added to the set already.

```csharp
public void Add(Type type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| type | Type | A Type object to add. |

### Clear
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/knowntypeset/clear.md

#### KnownTypeSet.Clear method

Removes all items from the set.

```csharp
public void Clear()
```

### Count
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/knowntypeset/count.md

#### KnownTypeSet.Count property

Gets the count of items in the set.

```csharp
public int Count { get; }
```

### GetEnumerator
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/knowntypeset/getenumerator.md

#### KnownTypeSet.GetEnumerator method

Returns An IEnumerator object to iterate over items of the set.

```csharp
public IEnumerator GetEnumerator()
```

##### Return Value

An IEnumerator object to iterate over items of the set.

### Remove
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/knowntypeset/remove.md

#### KnownTypeSet.Remove method

Removes the specified Type object from the set.

Throws ArgumentException if *type* is null.

```csharp
public void Remove(Type type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| type | Type | A Type object to remove. |

### License
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/license.md

#### License class

Provides methods to license the component.

```csharp
public class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | Initializes a new instance of this class. |

#### Properties

| Name | Description |
| --- | --- |
| IsLicensed { get; } | Returns true if a valid license has been applied; false if the component is running in evaluation mode. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### IsLicensed
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/license/islicensed.md

#### License.IsLicensed property

Returns true if a valid license has been applied; false if the component is running in evaluation mode.

```csharp
public bool IsLicensed { get; }
```

### License
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/license/license.md

#### License constructor

Initializes a new instance of this class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/license/setlicense.md

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string licenseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseName | String | Can be a full or short file name or name of an embedded resource. Use an empty string to switch to evaluation mode. |

##### Remarks

Tries to find the license in the following locations:

1. Explicit path.

2. The folder that contains the GroupDocs component assembly.

3. The folder that contains the client's calling assembly.

4. The folder that contains the entry (startup) assembly.

5. An embedded resource in the client's calling assembly.

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | A stream that contains the license. |

##### Remarks

Use this method to load a license from a stream.

### LoadSaveOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/loadsaveoptions.md

#### LoadSaveOptions class

Specifies additional options for loading and saving of a document to be assembled.

```csharp
public class LoadSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadSaveOptions() | Creates a new instance of this class without any properties specified. |
| LoadSaveOptions(FileFormat) | Creates a new instance of this class with the specified file format to save an assembled document to. |

#### Properties

| Name | Description |
| --- | --- |
| ResourceLoadBaseUri { get; set; } | Gets or sets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. The default value is an empty string. |
| ResourceSaveFolder { get; set; } | Gets or sets a path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. The default value is an empty string. |
| SaveFormat { get; set; } | Gets or sets a file format to save an assembled document to. Unspecified is the default. |

### LoadSaveOptions
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/loadsaveoptions/loadsaveoptions.md

#### LoadSaveOptions()

Creates a new instance of this class without any properties specified.

```csharp
public LoadSaveOptions()
```

#### LoadSaveOptions(FileFormat)

Creates a new instance of this class with the specified file format to save an assembled document to.

```csharp
public LoadSaveOptions(FileFormat saveFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| saveFormat | FileFormat | A file format to save an assembled document to. |

### ResourceLoadBaseUri
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/loadsaveoptions/resourceloadbaseuri.md

#### LoadSaveOptions.ResourceLoadBaseUri property

Gets or sets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML template document to be assembled and saved to a non-HTML format. The default value is an empty string.

```csharp
public string ResourceLoadBaseUri { get; set; }
```

##### Remarks

When loading an HTML document from a file, its containing folder is used as a base URI by default, which cannot happen when loading an HTML document from a stream. Set this property to specify a base URI when loading an HTML document from a stream or to override the default base URI when loading an HTML document from a file.

A value of this property is ignored in the following cases:

* An HTML document being loaded contains a BASE HTML element providing a base URI.
* An HTML document being loaded is to be assembled and saved to HTML (external resource files are not loaded and relative URIs are not changed then).

### ResourceSaveFolder
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/loadsaveoptions/resourcesavefolder.md

#### LoadSaveOptions.ResourceSaveFolder property

Gets or sets a path to a folder to store external resource files while an assembled document loaded from a non-HTML format is being saved to HTML. The default value is an empty string.

```csharp
public string ResourceSaveFolder { get; set; }
```

##### Remarks

By default, when saving an assembled document to an HTML file, external resource files are stored to a folder having the same name as the HTML file without extension plus the "_files" suffix. This folder is located in the same folder as the HTML file. However, this cannot be done when saving an assembled document to an HTML stream. Set this property to specify a path to a folder to store external resource files when saving an assembled document to an HTML stream or to override the default folder when saving an assembled document to an HTML file.

A value of this property is ignored if an assembled document being saved to HTML was loaded from HTML as well (external resource files are not stored and links to them are not changed then).

### SaveFormat
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/loadsaveoptions/saveformat.md

#### LoadSaveOptions.SaveFormat property

Gets or sets a file format to save an assembled document to. Unspecified is the default.

```csharp
public FileFormat SaveFormat { get; set; }
```

##### Remarks

When the value of this property is not specified, `DocumentAssembler` behaves as follows:

- When you specify a file path to save an assembled document, the save file format is determined upon file extension from the path.

- When you specify a stream to save an assembled document, the save file format remains the same as the file format of a loaded template document.

Beware that it is not always possible to save an assembled document to any file format using GroupDocs.Assembly. For example, it is impossible to save a document loaded from a Word Processing file format (such as DOCX) to a Spreadsheet file format (such as XLSX). For more information on possible combinations of load and save file formats supported by GroupDocs.Assembly, please check GroupDocs.Assembly online documentation.

### Metered
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/metered.md

#### Metered class

Provides methods to work with metered licensing.

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | Creates a new instance of this class. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Enables metered licensing for the component by specifying appropriate public and private metered keys. |
| static GetConsumptionCredit() | Returns the currently consumed number of credits. |
| static GetConsumptionQuantity() | Returns the currently consumed number of megabytes. |

##### Examples

In this example, an attempt to set metered public and private keys is made:

```csharp
[C#]

Metered metered = new Metered();
metered.SetMeteredKey("PublicKey", "PrivateKey");

[Visual Basic]

Dim metered As Metered = New Metered
metered.SetMeteredKey("PublicKey", "PrivateKey")
```

### GetConsumptionCredit
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Returns the currently consumed number of credits.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

The currently consumed number of credits.

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Returns the currently consumed number of megabytes.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

The currently consumed number of megabytes.

### Metered
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/metered/metered.md

#### Metered constructor

Creates a new instance of this class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/assembly/net/groupdocs.assembly/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Enables metered licensing for the component by specifying appropriate public and private metered keys.

```csharp
public void SetMeteredKey(string publicKey, string privateKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | String | The public metered key. |
| privateKey | String | The private metered key. |

## Python

### GroupDocs.Assembly for Python via .NET
Path: https://reference.groupdocs.com/assembly/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.assembly` | Provides classes for generating documents in popular office file formats based upon template documents and data
<br/>obtained from various sources including databases, XML, JSON, OData, objects of custom
<br/>types, and more. |
| `groupdocs.assembly.data` | Provides classes for accessing data of external documents to be used while assembling a document. |

### groupdocs.assembly.data
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data.md

Provides classes for accessing data of external documents to be used while assembling a document.

##### Classes
| Class | Description |
| :- | :- |
| `CsvDataLoadOptions` | Represents options for parsing CSV data. |
| `CsvDataSource` | Provides access to data of a CSV file or stream to be used while assembling a document. |
| `DocumentTable` | Provides access to data of a single table (or spreadsheet) located in an external document to be used while
<br/>assembling a document. |
| `DocumentTableCollection` | Represents a read-only collection of `DocumentTable` objects of a particular `DocumentTableSet`
<br/>instance. |
| `DocumentTableColumn` | Represents a single column of a particular `DocumentTable` object. |
| `DocumentTableColumnCollection` | Represents a read-only collection of `DocumentTableColumn` objects of a particular
<br/>`DocumentTable` instance. |
| `DocumentTableLoadArgs` | Provides data for the `IDocumentTableLoadHandler.handle` method. |
| `DocumentTableOptions` | Provides a set of options to control extraction of data from a document table. |
| `DocumentTableRelation` | Represents a parent-child relationship between two `DocumentTable` objects. |
| `DocumentTableRelationCollection` | Represents the collection of `DocumentTableRelation` objects of a single `DocumentTableSet`
<br/>instance. |
| `DocumentTableSet` | Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while
<br/>assembling a document. Also, enables to define parent-child relations for the document tables thus simplifying
<br/>access to related data within template documents. |
| `IDocumentTableLoadHandler` | Overrides default loading of `DocumentTable` objects while creating a `DocumentTableSet`
<br/>instance. |
| `JsonDataLoadOptions` | Represents options for parsing JSON data. |
| `JsonDataSource` | Provides access to data of a JSON file or stream to be used while assembling a document. |
| `XmlDataLoadOptions` | Represents options for XML data loading. |
| `XmlDataSource` | Provides access to data of an XML file or stream to be used while assembling a document. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `JsonSimpleValueParseMode` | Specifies a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON.
<br/>Such a mode does not affect parsing of date-time values. |

### CsvDataLoadOptions class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdataloadoptions.md

#### CsvDataLoadOptions class

Represents options for parsing CSV data.

The CsvDataLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of this class with default options. |
| __init__ | Initializes a new instance of this class with specifying whether CSV data contains column names
<br/>at the first line. |

##### Properties
| Property | Description |
| :- | :- |
| has_headers | Gets or sets a value indicating whether the first line of CSV data contains column names. |
| delimiter | Gets or sets the character to be used as a column delimiter. |
| quote_char | Gets or sets the character that is used to quote field values. |
| comment_char | Gets or sets the character that is used to comment lines of CSV data. |

##### Remarks

An instance of this class can be passed into constructors of `CsvDataSource`.

### CsvDataLoadOptions constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdataloadoptions/__init__.md

#### __init__

Initializes a new instance of this class with default options.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of this class with specifying whether CSV data contains column names
at the first line.

```python
def __init__(self, has_headers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| has_headers | bool |  |

### comment_char property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdataloadoptions/comment_char.md

#### comment_char property

Gets or sets the character that is used to comment lines of CSV data.

##### Remarks

The default value is '#' (number sign).
##### Definition:
```python
@property
def comment_char(self):
    ...
@comment_char.setter
def comment_char(self, value):
    ...
```

### delimiter property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdataloadoptions/delimiter.md

#### delimiter property

Gets or sets the character to be used as a column delimiter.

##### Remarks

The default value is ',' (comma).
##### Definition:
```python
@property
def delimiter(self):
    ...
@delimiter.setter
def delimiter(self, value):
    ...
```

### has_headers property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdataloadoptions/has_headers.md

#### has_headers property

Gets or sets a value indicating whether the first line of CSV data contains column names.

##### Remarks

The default value is **false** .
##### Definition:
```python
@property
def has_headers(self):
    ...
@has_headers.setter
def has_headers(self, value):
    ...
```

### quote_char property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdataloadoptions/quote_char.md

#### quote_char property

Gets or sets the character that is used to quote field values.

##### Remarks

The default value is '"' (quotation mark).

Double the character to place it into quoted text.
##### Definition:
```python
@property
def quote_char(self):
    ...
@quote_char.setter
def quote_char(self, value):
    ...
```

### CsvDataSource class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdatasource.md

#### CsvDataSource class

Provides access to data of a CSV file or stream to be used while assembling a document.

The CsvDataSource type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new data source with data from a CSV file using default options for parsing CSV data. |
| __init__ | Creates a new data source with data from a CSV file using the specified options for parsing CSV data. |
| __init__ | Creates a new data source with data from a CSV stream using default options for parsing CSV data. |
| __init__ | Creates a new data source with data from a CSV stream using the specified options for parsing CSV data. |

##### Remarks

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as
a data source to one of `DocumentAssembler`.
overloads.

In template documents, a `CsvDataSource` instance should be treated in the same way as if it was
a DataTable instance. For more information, see template syntax reference
.

Data types of comma-separated values are determined automatically upon their string representations. So in template
documents, you can work with typed values rather than just strings. The engine is capable to automatically recognize
values of the following types:

Note that for automatic recognition of data types to work, string representations of comma-separated values should
be formed using invariant culture settings.

To override default behavior of CSV data loading, initialize and pass a `CsvDataLoadOptions` instance
to a constructor of this class.

### CsvDataSource constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/csvdatasource/__init__.md

#### __init__

Creates a new data source with data from a CSV file using default options for parsing CSV data.

```python
def __init__(self, csv_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| csv_path | str | The path to the CSV file to be used as the data source. |

#### __init__

Creates a new data source with data from a CSV stream using default options for parsing CSV data.

```python
def __init__(self, csv_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| csv_stream | io.RawIOBase | The stream of CSV data to be used as the data source. |

#### __init__

Creates a new data source with data from a CSV file using the specified options for parsing CSV data.

```python
def __init__(self, csv_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| csv_path | str | The path to the CSV file to be used as the data source. |
| options | `CsvDataLoadOptions` | Options for parsing the CSV data. |

#### __init__

Creates a new data source with data from a CSV stream using the specified options for parsing CSV data.

```python
def __init__(self, csv_stream, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| csv_stream | io.RawIOBase | The stream of CSV data to be used as the data source. |
| options | `CsvDataLoadOptions` | Options for parsing the CSV data. |

### DocumentTable class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttable.md

#### DocumentTable class

Provides access to data of a single table (or spreadsheet) located in an external document to be used while
assembling a document.

The DocumentTable type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new instance of this class using default `DocumentTableOptions`. |
| __init__ | Creates a new instance of this class. |
| __init__ | Creates a new instance of this class using default `DocumentTableOptions`. |
| __init__ | Creates a new instance of this class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets or sets the name of this table used to access the table's data in a template document passed to
<br/>`DocumentAssembler`. |
| index_in_document | Gets the original zero-based index of the corresponding table as per the source document. |
| columns | Gets the collection of `DocumentTableColumn` objects representing columns of
<br/>the corresponding table. |

##### Remarks

For documents of Spreadsheet file formats, a `DocumentTable` instance represents a single sheet.
For documents of other file formats, a `DocumentTable` instance represents a single table.

To access data of the corresponding table while assembling a document, pass an instance of this class as
a data source to one of `DocumentAssembler`.
overloads.

In template documents, a `DocumentTable` instance should be treated in the same way as if it was
a DataTable instance. See template syntax reference for more information.

### DocumentTable constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttable/__init__.md

#### __init__

Creates a new instance of this class using default `DocumentTableOptions`.

```python
def __init__(self, document_path, index_in_document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_path | str | The path to a document containing the table to be accessed. |
| index_in_document | int | The zero-based index of the table in the document. |

#### __init__

Creates a new instance of this class using default `DocumentTableOptions`.

```python
def __init__(self, document_stream, index_in_document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream | io.RawIOBase | The stream containing a document with the table to be accessed. |
| index_in_document | int | The zero-based index of the table in the document. |

#### __init__

Creates a new instance of this class.

```python
def __init__(self, document_path, index_in_document, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_path | str | The path to a document containing the table to be accessed. |
| index_in_document | int | The zero-based index of the table in the document. |
| options | `DocumentTableOptions` | A set of options controlling extraction of data from the table. If null, default options are applied. |

#### __init__

Creates a new instance of this class.

```python
def __init__(self, document_stream, index_in_document, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream | io.RawIOBase | The stream containing a document with the table to be accessed. |
| index_in_document | int | The zero-based index of the table in the document. |
| options | `DocumentTableOptions` | A set of options controlling extraction of data from the table. If null, default options are applied. |

### columns property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttable/columns.md

#### columns property

Gets the collection of `DocumentTableColumn` objects representing columns of
the corresponding table.
##### Definition:
```python
@property
def columns(self):
    ...
```

### index_in_document property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttable/index_in_document.md

#### index_in_document property

Gets the original zero-based index of the corresponding table as per the source document.

##### Remarks

Depending on an `IDocumentTableLoadHandler` implementation provided, this index may differ from
the index of this `DocumentTable` instance within the table collection of the corresponding
`DocumentTableSet` instance, if any.
##### Definition:
```python
@property
def index_in_document(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttable/name.md

#### name property

Gets or sets the name of this table used to access the table's data in a template document passed to
`DocumentAssembler`.

##### Remarks

If the table's name is read from a document, the name is automatically corrected so that it to be valid.
However, if the table's name is set manually through this property and the name is invalid, an exception is thrown.

The table's name is considered to be valid, if the following conditions are met:

|
|
 |
 |
 |
 |
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### DocumentTableCollection class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecollection.md

#### DocumentTableCollection class

Represents a read-only collection of `DocumentTable` objects of a particular `DocumentTableSet`
instance.

The DocumentTableCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the total number of `DocumentTable` objects in the collection. |

Gets a `DocumentTable` instance from the collection at the specified index.
##### Indexer
| Name | Description |
| :- | :- |
| [index] | The zero-based index of the table to return. |

##### Methods
| Method | Description |
| :- | :- |
| contains | Returns a value indicating whether this collection contains a table with the specified name. |
| contains | Returns a value indicating whether this collection contains the specified table. |
| index_of | Returns the index of a table with the specified name within this collection. |
| index_of | Returns the index of the specified table within this collection. |

##### Remarks

The collection is filled automatically while loading the corresponding tables from a document and can not be modified.
However, properties of `DocumentTable` objects contained within the collection can be modified.

### DocumentTableCollection indexer
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecollection/__getitem__.md

#### DocumentTableCollection indexer

Gets a `DocumentTable` instance from the collection at the specified index.
##### Indexer
| Name | Description |
| :- | :- |
| index | The zero-based index of the table to return. |

##### Returns

A `DocumentTable` instance from the collection at the specified index.

### contains method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecollection/contains.md

#### contains

Returns a value indicating whether this collection contains a table with the specified name.

##### Returns

A value indicating whether this collection contains a table with the specified name.

```python
def contains(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | str | The case-insensitive name of a table to look for. |

#### contains

Returns a value indicating whether this collection contains the specified table.

##### Returns

A value indicating whether this collection contains the specified table.

```python
def contains(self, table):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| table | `DocumentTable` | A table to look for. |

### count property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecollection/count.md

#### count property

Gets the total number of `DocumentTable` objects in the collection.
##### Definition:
```python
@property
def count(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecollection/index_of.md

#### index_of

Returns the index of a table with the specified name within this collection.

##### Returns

The zero-based index of a table with the specified name, or -1 if the table does not exist in this collection.

```python
def index_of(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | str | The case-insensitive name of a table to find. |

#### index_of

Returns the index of the specified table within this collection.

##### Returns

The zero-based index of the specified table, or -1 if the table does not exist in this collection.

```python
def index_of(self, table):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| table | `DocumentTable` | A table to find. |

### DocumentTableColumn class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumn.md

#### DocumentTableColumn class

Represents a single column of a particular `DocumentTable` object.

The DocumentTableColumn type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets or sets the name of this column used to access the column's data in a template document passed to
<br/>`DocumentAssembler`. |
| index_in_document | Gets the original zero-based index of the corresponding table column as per the source document. |
| type | Gets or sets the type of cell values in this column. |
| allows_null | Gets a value indicating whether cells in this column contain null values or not. |

### allows_null property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumn/allows_null.md

#### allows_null property

Gets a value indicating whether cells in this column contain null values or not.

##### Remarks

Undefined and error values in cells of Spreadsheet documents are also considered to be null.
##### Definition:
```python
@property
def allows_null(self):
    ...
```

### index_in_document property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumn/index_in_document.md

#### index_in_document property

Gets the original zero-based index of the corresponding table column as per the source document.

##### Remarks

Depending on `DocumentTableOptions` specified, this index may differ from the index of
this `DocumentTableColumn` instance within the column collection of the corresponding
`DocumentTable` instance.
##### Definition:
```python
@property
def index_in_document(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumn/name.md

#### name property

Gets or sets the name of this column used to access the column's data in a template document passed to
`DocumentAssembler`.

##### Remarks

If the column's name is read from a document (see `DocumentTableOptions.first_row_contains_column_names`),
the name is automatically corrected so that it to be valid. However, if the column's name is set manually through
this property and the name is invalid, an exception is thrown.

The column's name is considered to be valid, if the following conditions are met:

|
|
 |
 |
 |
 |
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumn/type.md

#### type property

Gets or sets the type of cell values in this column.

##### Remarks

For documents of non-Spreadsheet file formats, the initial type is always automatically determined
as string. For documents of Spreadsheet file formats, the initial type is automatically determined
depending on corresponding cell values.

If cells of a particular Spreadsheet column contain values of different types, then the column's
initial type is also automatically determined as string.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### DocumentTableColumnCollection class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumncollection.md

#### DocumentTableColumnCollection class

Represents a read-only collection of `DocumentTableColumn` objects of a particular
`DocumentTable` instance.

The DocumentTableColumnCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the total number of `DocumentTableColumn` objects in the collection. |

Gets a `DocumentTableColumn` instance from the collection at the specified index.
##### Indexer
| Name | Description |
| :- | :- |
| [index] | The zero-based index of the column to return. |

##### Methods
| Method | Description |
| :- | :- |
| contains | Returns a value indicating whether this collection contains a column with the specified name. |
| contains | Returns a value indicating whether this collection contains the specified column. |
| index_of | Returns the index of a column with the specified name within this collection. |
| index_of | Returns the index of the specified column within this collection. |

##### Remarks

The collection is filled automatically while loading the corresponding table from a document and can not be modified.
However, properties of `DocumentTableColumn` objects contained within the collection can be modified.

### DocumentTableColumnCollection indexer
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumncollection/__getitem__.md

#### DocumentTableColumnCollection indexer

Gets a `DocumentTableColumn` instance from the collection at the specified index.
##### Indexer
| Name | Description |
| :- | :- |
| index | The zero-based index of the column to return. |

##### Returns

A `DocumentTableColumn` instance from the collection at the specified index.

### contains method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumncollection/contains.md

#### contains

Returns a value indicating whether this collection contains a column with the specified name.

##### Returns

A value indicating whether this collection contains a column with the specified name.

```python
def contains(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | str | The case-insensitive name of a column to look for. |

#### contains

Returns a value indicating whether this collection contains the specified column.

##### Returns

A value indicating whether this collection contains the specified column.

```python
def contains(self, column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| column | `DocumentTableColumn` | A column to look for. |

### count property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumncollection/count.md

#### count property

Gets the total number of `DocumentTableColumn` objects in the collection.
##### Definition:
```python
@property
def count(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablecolumncollection/index_of.md

#### index_of

Returns the index of a column with the specified name within this collection.

##### Returns

The zero-based index of a column with the specified name, or -1 if the column does not exist in this collection.

```python
def index_of(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | str | The case-insensitive name of a column to find. |

#### index_of

Returns the index of the specified column within this collection.

##### Returns

The zero-based index of the specified column, or -1 if the column does not exist in this collection.

```python
def index_of(self, column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| column | `DocumentTableColumn` | A column to find. |

### DocumentTableLoadArgs class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableloadargs.md

#### DocumentTableLoadArgs class

Provides data for the `IDocumentTableLoadHandler.handle` method.

The DocumentTableLoadArgs type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| table_index | Gets the zero-based index of the corresponding document table to be loaded. |
| is_loaded | Gets or sets a value indicating whether the corresponding document table is to be loaded or not.
<br/>The default value is true. |
| options | Gets or sets `DocumentTableOptions` to be used while loading the corresponding document table.
<br/>The default value is null, which means that default `DocumentTableOptions` are to be applied. |

### is_loaded property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableloadargs/is_loaded.md

#### is_loaded property

Gets or sets a value indicating whether the corresponding document table is to be loaded or not.
The default value is true.
##### Definition:
```python
@property
def is_loaded(self):
    ...
@is_loaded.setter
def is_loaded(self, value):
    ...
```

### options property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableloadargs/options.md

#### options property

Gets or sets `DocumentTableOptions` to be used while loading the corresponding document table.
The default value is null, which means that default `DocumentTableOptions` are to be applied.
##### Definition:
```python
@property
def options(self):
    ...
@options.setter
def options(self, value):
    ...
```

### table_index property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableloadargs/table_index.md

#### table_index property

Gets the zero-based index of the corresponding document table to be loaded.
##### Definition:
```python
@property
def table_index(self):
    ...
```

### DocumentTableOptions class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions.md

#### DocumentTableOptions class

Provides a set of options to control extraction of data from a document table.

The DocumentTableOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new instance of this class. |

##### Properties
| Property | Description |
| :- | :- |
| min_row_index | Gets or sets the smallest zero-based index of a row to be extracted from a document table.
<br/>The default value is negative which means that the smallest row index is not limited. |
| max_row_index | Gets or sets the largest zero-based index of a row to be extracted from a document table.
<br/>The default value is negative which means that the largest row index is not limited. |
| min_column_index | Gets or sets the smallest zero-based index of a column to be extracted from a document table.
<br/>The default value is negative which means that the smallest column index is not limited. |
| max_column_index | Gets or sets the largest zero-based index of a column to be extracted from a document table.
<br/>The default value is negative which means that the largest column index is not limited. |
| first_row_contains_column_names | Gets or sets a value indicating whether column names are to be obtained from the first
<br/>extracted row of a document table. The default value is false. |

### DocumentTableOptions constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions/__init__.md

#### __init__

Creates a new instance of this class.

```python
def __init__(self):
    ...
```

### first_row_contains_column_names property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions/first_row_contains_column_names.md

#### first_row_contains_column_names property

Gets or sets a value indicating whether column names are to be obtained from the first
extracted row of a document table. The default value is false.

##### Remarks

If column names are not set to be obtained from the first extracted row of a document table,
default column names are used instead. For documents of Spreadsheet file formats, default
column names are defined as A, B, C, ... Z, AA, AB, and so on. For documents of other
file formats, default column names are defined as Column1, Column2, Column3, and so on.
##### Definition:
```python
@property
def first_row_contains_column_names(self):
    ...
@first_row_contains_column_names.setter
def first_row_contains_column_names(self, value):
    ...
```

### max_column_index property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions/max_column_index.md

#### max_column_index property

Gets or sets the largest zero-based index of a column to be extracted from a document table.
The default value is negative which means that the largest column index is not limited.
##### Definition:
```python
@property
def max_column_index(self):
    ...
@max_column_index.setter
def max_column_index(self, value):
    ...
```

### max_row_index property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions/max_row_index.md

#### max_row_index property

Gets or sets the largest zero-based index of a row to be extracted from a document table.
The default value is negative which means that the largest row index is not limited.
##### Definition:
```python
@property
def max_row_index(self):
    ...
@max_row_index.setter
def max_row_index(self, value):
    ...
```

### min_column_index property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions/min_column_index.md

#### min_column_index property

Gets or sets the smallest zero-based index of a column to be extracted from a document table.
The default value is negative which means that the smallest column index is not limited.
##### Definition:
```python
@property
def min_column_index(self):
    ...
@min_column_index.setter
def min_column_index(self, value):
    ...
```

### min_row_index property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableoptions/min_row_index.md

#### min_row_index property

Gets or sets the smallest zero-based index of a row to be extracted from a document table.
The default value is negative which means that the smallest row index is not limited.
##### Definition:
```python
@property
def min_row_index(self):
    ...
@min_row_index.setter
def min_row_index(self, value):
    ...
```

### DocumentTableRelation class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelation.md

#### DocumentTableRelation class

Represents a parent-child relationship between two `DocumentTable` objects.

The DocumentTableRelation type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent_column | Gets the parent column of this relation. |
| child_column | Gets the child column of this relation. |

### child_column property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelation/child_column.md

#### child_column property

Gets the child column of this relation.
##### Definition:
```python
@property
def child_column(self):
    ...
```

### parent_column property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelation/parent_column.md

#### parent_column property

Gets the parent column of this relation.
##### Definition:
```python
@property
def parent_column(self):
    ...
```

### DocumentTableRelationCollection class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection.md

#### DocumentTableRelationCollection class

Represents the collection of `DocumentTableRelation` objects of a single `DocumentTableSet`
instance.

The DocumentTableRelationCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the total number of `DocumentTableRelation` objects in the collection. |

Gets a `DocumentTableRelation` instance from the collection at the specified index.
##### Indexer
| Name | Description |
| :- | :- |
| [index] | The zero-based index of the relation to return. |

##### Methods
| Method | Description |
| :- | :- |
| add | Creates a `DocumentTableRelation` object for the specified parent and child columns, and adds it
<br/>to the collection. |
| remove | Removes the specified relation from the collection. |
| remove_at | Removes the relation at the specified index from the collection. |
| clear | Clears the collection of any relations. |
| contains | Returns a value indicating whether this collection contains the specified relation. |
| index_of | Returns the index of the specified relation within this collection. |

### DocumentTableRelationCollection indexer
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/__getitem__.md

#### DocumentTableRelationCollection indexer

Gets a `DocumentTableRelation` instance from the collection at the specified index.
##### Indexer
| Name | Description |
| :- | :- |
| index | The zero-based index of the relation to return. |

##### Returns

A `DocumentTableRelation` instance from the collection at the specified index.

### add method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/add.md

#### add

Creates a `DocumentTableRelation` object for the specified parent and child columns, and adds it
to the collection.

##### Returns

The created relation.

```python
def add(self, parent_column, child_column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parent_column | `DocumentTableColumn` | The parent column of the relation. |
| child_column | `DocumentTableColumn` | The child column of the relation. |

### clear method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/clear.md

#### clear

Clears the collection of any relations.

```python
def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/contains.md

#### contains

Returns a value indicating whether this collection contains the specified relation.

##### Returns

A value indicating whether this collection contains the specified relation.

```python
def contains(self, relation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| relation | `DocumentTableRelation` | A relation to look for. |

### count property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/count.md

#### count property

Gets the total number of `DocumentTableRelation` objects in the collection.
##### Definition:
```python
@property
def count(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/index_of.md

#### index_of

Returns the index of the specified relation within this collection.

##### Returns

The zero-based index of the specified relation, or -1 if the relation does not exist in this collection.

```python
def index_of(self, relation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| relation | `DocumentTableRelation` | A relation to find. |

### remove method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/remove.md

#### remove

Removes the specified relation from the collection.

```python
def remove(self, relation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| relation | `DocumentTableRelation` | The relation to remove. |

### remove_at method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttablerelationcollection/remove_at.md

#### remove_at

Removes the relation at the specified index from the collection.

```python
def remove_at(self, index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | int | The index of the relation to remove. |

### DocumentTableSet class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableset.md

#### DocumentTableSet class

Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while
assembling a document. Also, enables to define parent-child relations for the document tables thus simplifying
access to related data within template documents.

The DocumentTableSet type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new instance of this class loading all tables from a document using default
<br/>`DocumentTableOptions`. |
| __init__ | Creates a new instance of this class. |
| __init__ | Creates a new instance of this class loading all tables from a document using default
<br/>`DocumentTableOptions`. |
| __init__ | Creates a new instance of this class. |

##### Properties
| Property | Description |
| :- | :- |
| tables | Gets the collection of `DocumentTable` objects representing tables of this set. |
| relations | Gets the collection of parent-child relations defined for document tables of this set. |

##### Remarks

For documents of Spreadsheet file formats, a `DocumentTableSet` instance represents a set of sheets.
For documents of other file formats, a `DocumentTableSet` instance represents a set of tables.

To access data of the corresponding tables while assembling a document, pass an instance of this class as
a data source to one of `DocumentAssembler`.
overloads.

In template documents, a `DocumentTableSet` instance should be treated in the same way as if it was
a DataSet instance. See template syntax reference for more information.

### DocumentTableSet constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableset/__init__.md

#### __init__

Creates a new instance of this class loading all tables from a document using default
`DocumentTableOptions`.

```python
def __init__(self, document_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_path | str | The path to a document containing tables to be accessed. |

#### __init__

Creates a new instance of this class loading all tables from a document using default
`DocumentTableOptions`.

```python
def __init__(self, document_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream | io.RawIOBase | The stream containing a document with tables to be accessed. |

#### __init__

Creates a new instance of this class.

```python
def __init__(self, document_path, load_handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_path | str | The path to a document containing tables to be accessed. |
| load_handler | `IDocumentTableLoadHandler` | An `IDocumentTableLoadHandler` implementation controlling how document tables are loaded. |

#### __init__

Creates a new instance of this class.

```python
def __init__(self, document_stream, load_handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream | io.RawIOBase | The stream containing a document with tables to be accessed. |
| load_handler | `IDocumentTableLoadHandler` | An `IDocumentTableLoadHandler` implementation controlling how document tables are loaded. |

### relations property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableset/relations.md

#### relations property

Gets the collection of parent-child relations defined for document tables of this set.
##### Definition:
```python
@property
def relations(self):
    ...
```

### tables property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/documenttableset/tables.md

#### tables property

Gets the collection of `DocumentTable` objects representing tables of this set.
##### Definition:
```python
@property
def tables(self):
    ...
```

### IDocumentTableLoadHandler class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/idocumenttableloadhandler.md

#### IDocumentTableLoadHandler class

Overrides default loading of `DocumentTable` objects while creating a `DocumentTableSet`
instance.

The IDocumentTableLoadHandler type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| handle | Overrides default loading of a particular `DocumentTable` object while creating
<br/>a `DocumentTableSet` instance. |

##### Remarks

Implement this interface if you want to discard loading of specific `DocumentTable` objects or provide
specific `DocumentTableOptions` for document tables being loaded.

### handle method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/idocumenttableloadhandler/handle.md

#### handle

Overrides default loading of a particular `DocumentTable` object while creating
a `DocumentTableSet` instance.

```python
def handle(self, args):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| args | `DocumentTableLoadArgs` |  |

### JsonDataLoadOptions class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondataloadoptions.md

#### JsonDataLoadOptions class

Represents options for parsing JSON data.

The JsonDataLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of this class with default options. |

##### Properties
| Property | Description |
| :- | :- |
| simple_value_parse_mode | Gets or sets a mode for parsing JSON simple values (null, boolean, number, integer, and string)
<br/>while loading JSON. Such a mode does not affect parsing of date-time values. The default is
<br/>`JsonSimpleValueParseMode.LOOSE`. |
| exact_date_time_parse_format | Gets or sets an exact format for parsing JSON date-time values while loading JSON. The default is **null** . |
| exact_date_time_parse_formats | Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is **null** . |
| always_generate_root_object | Gets or sets a flag indicating whether a generated data source will always contain an object for a JSON root
<br/>element. If a JSON root element contains a single complex property, such an object is not created by default. |

##### Remarks

An instance of this class can be passed into constructors of `JsonDataSource`.

### JsonDataLoadOptions constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondataloadoptions/__init__.md

#### __init__

Initializes a new instance of this class with default options.

```python
def __init__(self):
    ...
```

### always_generate_root_object property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondataloadoptions/always_generate_root_object.md

#### always_generate_root_object property

Gets or sets a flag indicating whether a generated data source will always contain an object for a JSON root
element. If a JSON root element contains a single complex property, such an object is not created by default.

##### Remarks

The default value is **false** .
##### Definition:
```python
@property
def always_generate_root_object(self):
    ...
@always_generate_root_object.setter
def always_generate_root_object(self, value):
    ...
```

### exact_date_time_parse_format property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondataloadoptions/exact_date_time_parse_format.md

#### exact_date_time_parse_format property

Gets or sets an exact format for parsing JSON date-time values while loading JSON. The default is **null** .

##### Remarks

Strings encoded using Microsoft® JSON date-time format (for example, "/Date(1224043200000)/") are always
recognized as date-time values regardless of a value of this property. The property defines additional
formats to be used while parsing date-time values from strings in the following way:

|
|
 |
 |
 |
##### Definition:
```python
@property
def exact_date_time_parse_format(self):
    ...
@exact_date_time_parse_format.setter
def exact_date_time_parse_format(self, value):
    ...
```

### exact_date_time_parse_formats property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondataloadoptions/exact_date_time_parse_formats.md

#### exact_date_time_parse_formats property

Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is **null** .

##### Remarks

Strings encoded using Microsoft® JSON date-time format (for example, "/Date(1224043200000)/") are always
recognized as date-time values regardless of a value of this property. The property defines additional
formats to be used while parsing date-time values from strings in the following way:

|
|
 |
 |
 |
##### Definition:
```python
@property
def exact_date_time_parse_formats(self):
    ...
@exact_date_time_parse_formats.setter
def exact_date_time_parse_formats(self, value):
    ...
```

### simple_value_parse_mode property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondataloadoptions/simple_value_parse_mode.md

#### simple_value_parse_mode property

Gets or sets a mode for parsing JSON simple values (null, boolean, number, integer, and string)
while loading JSON. Such a mode does not affect parsing of date-time values. The default is
`JsonSimpleValueParseMode.LOOSE`.
##### Definition:
```python
@property
def simple_value_parse_mode(self):
    ...
@simple_value_parse_mode.setter
def simple_value_parse_mode(self, value):
    ...
```

### JsonDataSource class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondatasource.md

#### JsonDataSource class

Provides access to data of a JSON file or stream to be used while assembling a document.

The JsonDataSource type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new data source with data from a JSON file using default options for parsing JSON data. |
| __init__ | Creates a new data source with data from a JSON file using the specified options for parsing JSON data. |
| __init__ | Creates a new data source with data from a JSON stream using default options for parsing JSON data. |
| __init__ | Creates a new data source with data from a JSON stream using the specified options for parsing JSON data. |

##### Remarks

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as
a data source to one of `DocumentAssembler`.
overloads.

In template documents, if a top-level JSON element is an array, a `JsonDataSource` instance should be
treated in the same way as if it was a DataTable instance. If a top-level JSON element
is an object, a `JsonDataSource` instance should be treated in the same way as if it was
a DataRow instance. For more information, see template syntax reference
.

In template documents, you can work with typed values of JSON elements. For convenience, the engine replaces the set
of JSON simple types with the following one:

The engine automatically recognizes values of the extra types upon their JSON representations.

To override default behavior of JSON data loading, initialize and pass a `JsonDataLoadOptions` instance
to a constructor of this class.

### JsonDataSource constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsondatasource/__init__.md

#### __init__

Creates a new data source with data from a JSON file using default options for parsing JSON data.

```python
def __init__(self, json_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| json_path | str | The path to the JSON file to be used as the data source. |

#### __init__

Creates a new data source with data from a JSON stream using default options for parsing JSON data.

```python
def __init__(self, json_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| json_stream | io.RawIOBase | The stream of JSON data to be used as the data source. |

#### __init__

Creates a new data source with data from a JSON file using the specified options for parsing JSON data.

```python
def __init__(self, json_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| json_path | str | The path to the JSON file to be used as the data source. |
| options | `JsonDataLoadOptions` | Options for parsing JSON data. |

#### __init__

Creates a new data source with data from a JSON stream using the specified options for parsing JSON data.

```python
def __init__(self, json_stream, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| json_stream | io.RawIOBase | The stream of JSON data to be used as the data source. |
| options | `JsonDataLoadOptions` | Options for parsing JSON data. |

### JsonSimpleValueParseMode enumeration
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/jsonsimplevalueparsemode.md

#### JsonSimpleValueParseMode enumeration

Specifies a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON.
Such a mode does not affect parsing of date-time values.

The JsonSimpleValueParseMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LOOSE | Specifies the mode where types of JSON simple values are determined upon parsing of their string representations.
<br/>For example, the type of 'prop' from the JSON snippet '{ prop: "123" }' is determined as integer in this mode. |
| STRICT | Specifies the mode where types of JSON simple values are determined from JSON notation itself.
<br/>For example, the type of 'prop' from the JSON snippet '{ prop: "123" }' is determined as string in this mode. |

### XmlDataLoadOptions class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/xmldataloadoptions.md

#### XmlDataLoadOptions class

Represents options for XML data loading.

The XmlDataLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of this class with default options. |

##### Properties
| Property | Description |
| :- | :- |
| always_generate_root_object | Gets or sets a flag indicating whether a generated data source will always contain an object for an XML root
<br/>element. If an XML root element has no attributes and all its child elements have same names, such an object
<br/>is not created by default. |

##### Remarks

An instance of this class can be passed into constructors of `XmlDataSource`.

### XmlDataLoadOptions constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/xmldataloadoptions/__init__.md

#### __init__

Initializes a new instance of this class with default options.

```python
def __init__(self):
    ...
```

### always_generate_root_object property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/xmldataloadoptions/always_generate_root_object.md

#### always_generate_root_object property

Gets or sets a flag indicating whether a generated data source will always contain an object for an XML root
element. If an XML root element has no attributes and all its child elements have same names, such an object
is not created by default.

##### Remarks

The default value is **false** .
##### Definition:
```python
@property
def always_generate_root_object(self):
    ...
@always_generate_root_object.setter
def always_generate_root_object(self, value):
    ...
```

### XmlDataSource class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/xmldatasource.md

#### XmlDataSource class

Provides access to data of an XML file or stream to be used while assembling a document.

The XmlDataSource type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new data source with data from an XML file using default options for XML data loading. |
| __init__ | Creates a new data source with data from an XML stream using default options for XML data loading. |
| __init__ | Creates a new data source with data from an XML file using an XML Schema Definition file. Default options
<br/>are used for XML data loading. |
| __init__ | Creates a new data source with data from an XML stream using an XML Schema Definition stream. Default options
<br/>are used for XML data loading. |
| __init__ | Creates a new data source with data from an XML file using the specified options for XML data loading. |
| __init__ | Creates a new data source with data from an XML stream using the specified options for XML data loading. |
| __init__ | Creates a new data source with data from an XML file using an XML Schema Definition file. The specified
<br/>options are used for XML data loading. |
| __init__ | Creates a new data source with data from an XML stream using an XML Schema Definition stream. The specified
<br/>options are used for XML data loading. |

##### Remarks

To access data of the corresponding file or stream while assembling a document, pass an instance of this class as
a data source to one of `DocumentAssembler`.
overloads.

In template documents, if a top-level XML element contains only a list of elements of the same type,
an `XmlDataSource` instance should be treated in the same way as if it was
a DataTable instance. Otherwise, an `XmlDataSource` instance should be
treated in the same way as if it was a DataRow instance. For more information,
see template syntax reference
.

When XML Schema Definition is passed to a constructor of this class, data types of values of simple XML elements
and attributes are determined according to the schema. So in template documents, you can work with typed values
rather than just strings.

When XML Schema Definition is not passed to a constructor of this class, data types of values of simple XML elements
and attributes are determined automatically upon their string representations. So in template documents, you can work
with typed values in this case as well. The engine is capable to automatically recognize values of the following types:

Note that for automatic recognition of data types to work, string representations of values of simple XML elements
and attributes should be formed using invariant culture settings.

To override default behavior of XML data loading, initialize and pass a `XmlDataLoadOptions`
instance to a constructor of this class.

### XmlDataSource constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.data/xmldatasource/__init__.md

#### __init__

Creates a new data source with data from an XML file using default options for XML data loading.

```python
def __init__(self, xml_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_path | str | The path to the XML file to be used as the data source. |

#### __init__

Creates a new data source with data from an XML stream using default options for XML data loading.

```python
def __init__(self, xml_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_stream | io.RawIOBase | The stream of XML data to be used as the data source. |

#### __init__

Creates a new data source with data from an XML file using an XML Schema Definition file. Default options
are used for XML data loading.

```python
def __init__(self, xml_path, xml_schema_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_path | str | The path to the XML file to be used as the data source. |
| xml_schema_path | str | The path to the XML Schema Definition file that provides schema for the XML
<br/>file. |

#### __init__

Creates a new data source with data from an XML stream using an XML Schema Definition stream. Default options
are used for XML data loading.

```python
def __init__(self, xml_stream, xml_schema_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_stream | io.RawIOBase | The stream of XML data to be used as the data source. |
| xml_schema_stream | io.RawIOBase | The stream of XML Schema Definition that provides schema for the XML data. |

#### __init__

Creates a new data source with data from an XML file using the specified options for XML data loading.

```python
def __init__(self, xml_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_path | str | The path to the XML file to be used as the data source. |
| options | `XmlDataLoadOptions` | Options for XML data loading. |

#### __init__

Creates a new data source with data from an XML stream using the specified options for XML data loading.

```python
def __init__(self, xml_stream, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_stream | io.RawIOBase | The stream of XML data to be used as the data source. |
| options | `XmlDataLoadOptions` | Options for XML data loading. |

#### __init__

Creates a new data source with data from an XML file using an XML Schema Definition file. The specified
options are used for XML data loading.

```python
def __init__(self, xml_path, xml_schema_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_path | str | The path to the XML file to be used as the data source. |
| xml_schema_path | str | The path to the XML Schema Definition file that provides schema for the XML
<br/>file. |
| options | `XmlDataLoadOptions` | Options for XML data loading. |

#### __init__

Creates a new data source with data from an XML stream using an XML Schema Definition stream. The specified
options are used for XML data loading.

```python
def __init__(self, xml_stream, xml_schema_stream, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xml_stream | io.RawIOBase | The stream of XML data to be used as the data source. |
| xml_schema_stream | io.RawIOBase | The stream of XML Schema Definition that provides schema for the XML data. |
| options | `XmlDataLoadOptions` | Options for XML data loading. |

### groupdocs.assembly
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly.md

Provides classes for generating documents in popular office file formats based upon template documents and data
obtained from various sources including databases, XML, JSON, OData, objects of custom
types, and more.

##### Classes
| Class | Description |
| :- | :- |
| `BarcodeSettings` | Represents a set of settings controlling barcode generation while assembling a document. |
| `DataSourceInfo` | Provides information on a single data source object to be used to assemble a document from a template. |
| `DocumentAssembler` | Provides routines to populate template documents with data and a set of settings to control these routines. |
| `KnownTypeSet` | Represents an unordered set (that is, a collection of unique items) containing Type objects
<br/>which fully or partially qualified names can be used within document templates to invoke the corresponding
<br/>types' static members, perform type casts, etc. |
| `License` | Provides methods to license the component. |
| `LoadSaveOptions` | Specifies additional options for loading and saving of a document to be assembled. |
| `Metered` | Provides methods to work with metered licensing. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `DocumentAssemblyOptions` | Specifies options controlling behavior of `DocumentAssembler` while assembling a document. |
| `FileFormat` | Specifies the format of a file. |
| `GraphicsUnit` |  |

### BarcodeSettings class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings.md

#### BarcodeSettings class

Represents a set of settings controlling barcode generation while assembling a document.

The BarcodeSettings type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| graphics_unit | Gets or sets a graphics unit used to measure `BarcodeSettings.base_x_dimension` and `BarcodeSettings.base_y_dimension`.
<br/>The default value is `GraphicsUnit.MILLIMETER`. |
| base_x_dimension | Gets or sets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces.
<br/>Measured in `BarcodeSettings.graphics_unit`. |
| base_y_dimension | Gets or sets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules.
<br/>Measured in `BarcodeSettings.graphics_unit`. |
| resolution | Gets or sets the horizontal and vertical resolution of a barcode image being generated. Measured in dots
<br/>per inch. The default value is 96. |
| x_resolution | Gets or sets the horizontal resolution of a barcode image being generated. Measured in dots per inch.
<br/>The default value is 96. |
| y_resolution | Gets or sets the vertical resolution of a barcode image being generated. Measured in dots per inch.
<br/>The default value is 96. |
| use_auto_correction | Gets or sets a value indicating whether an invalid barcode value should be corrected automatically
<br/>(if possible) to fit the barcode's specification or an exception should be thrown to indicate the error.
<br/>The default value is true. |

### base_x_dimension property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/base_x_dimension.md

#### base_x_dimension property

Gets or sets a base x-dimension, that is, the smallest width of the unit of barcode bars and spaces.
Measured in `BarcodeSettings.graphics_unit`.

##### Remarks

When barcode scaling is applied through a template, an actual x-dimension is calculated upon the base
x-dimension and a scaling factor.
##### Definition:
```python
@property
def base_x_dimension(self):
    ...
@base_x_dimension.setter
def base_x_dimension(self, value):
    ...
```

### base_y_dimension property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/base_y_dimension.md

#### base_y_dimension property

Gets or sets a base y-dimension, that is, the smallest height of the unit of 2D barcode modules.
Measured in `BarcodeSettings.graphics_unit`.

##### Remarks

Barcodes of some types (such as data matrix) may ignore an y-dimension and use an x-dimension for both
width and height units.

When barcode scaling is applied through a template, an actual y-dimension is calculated upon the base
y-dimension and a scaling factor.
##### Definition:
```python
@property
def base_y_dimension(self):
    ...
@base_y_dimension.setter
def base_y_dimension(self, value):
    ...
```

### graphics_unit property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/graphics_unit.md

#### graphics_unit property

Gets or sets a graphics unit used to measure `BarcodeSettings.base_x_dimension` and `BarcodeSettings.base_y_dimension`.
The default value is `GraphicsUnit.MILLIMETER`.
##### Definition:
```python
@property
def graphics_unit(self):
    ...
@graphics_unit.setter
def graphics_unit(self, value):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/resolution.md

#### resolution property

Gets or sets the horizontal and vertical resolution of a barcode image being generated. Measured in dots
per inch. The default value is 96.
##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### use_auto_correction property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/use_auto_correction.md

#### use_auto_correction property

Gets or sets a value indicating whether an invalid barcode value should be corrected automatically
(if possible) to fit the barcode's specification or an exception should be thrown to indicate the error.
The default value is true.

##### Remarks

The auto-correction is not possible for Databar barcodes.
##### Definition:
```python
@property
def use_auto_correction(self):
    ...
@use_auto_correction.setter
def use_auto_correction(self, value):
    ...
```

### x_resolution property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/x_resolution.md

#### x_resolution property

Gets or sets the horizontal resolution of a barcode image being generated. Measured in dots per inch.
The default value is 96.
##### Definition:
```python
@property
def x_resolution(self):
    ...
@x_resolution.setter
def x_resolution(self, value):
    ...
```

### y_resolution property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/barcodesettings/y_resolution.md

#### y_resolution property

Gets or sets the vertical resolution of a barcode image being generated. Measured in dots per inch.
The default value is 96.
##### Definition:
```python
@property
def y_resolution(self):
    ...
@y_resolution.setter
def y_resolution(self, value):
    ...
```

### DataSourceInfo class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/datasourceinfo.md

#### DataSourceInfo class

Provides information on a single data source object to be used to assemble a document from a template.

The DataSourceInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new instance of this class without any properties specified. |
| __init__ | Creates a new instance of this class with the data source object specified. |
| __init__ | Creates a new instance of this class with the data source object and its name specified. |

##### Properties
| Property | Description |
| :- | :- |
| data_source | Gets or sets the data source object. |
| name | Gets or sets the name of the data source object to be used to access the data source object in a template document. |

### DataSourceInfo constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/datasourceinfo/__init__.md

#### __init__

Creates a new instance of this class without any properties specified.

```python
def __init__(self):
    ...
```

#### __init__

Creates a new instance of this class with the data source object specified.

```python
def __init__(self, data_source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_source | any | The data source object. |

#### __init__

Creates a new instance of this class with the data source object and its name specified.

```python
def __init__(self, data_source, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_source | any | The data source object. |
| name | str | The name of the data source object to be used to access the data source object in a template document. |

### data_source property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/datasourceinfo/data_source.md

#### data_source property

Gets or sets the data source object.

##### Remarks

The data source object can be of one of the following types:

|
|
 |
 |
 |
 |

For information on how to work with data sources of different types in template documents, see template syntax reference
.
##### Definition:
```python
@property
def data_source(self):
    ...
@data_source.setter
def data_source(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/datasourceinfo/name.md

#### name property

Gets or sets the name of the data source object to be used to access the data source object in a template document.

##### Remarks

When the name of the data source object is specified, you can access the data source object and its members
in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object
in a template document using context object member access (see Template Syntax Reference for more information),
but you cannot access the data source object itself.

When passing multiple `DataSourceInfo` instances to `DocumentAssembler`, only the name of
the first data source object can be null or empty. Names of the rest ones must be specified and unique.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### DocumentAssembler class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler.md

#### DocumentAssembler class

Provides routines to populate template documents with data and a set of settings to control these routines.

The DocumentAssembler type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of this class. |

##### Properties
| Property | Description |
| :- | :- |
| options | Gets or sets a set of flags controlling behavior of this `DocumentAssembler` instance
<br/>while assembling a document. |
| barcode_settings | Gets a set of settings controlling barcode generation while assembling a document. |
| known_types | Gets an unordered set (that is, a collection of unique items) containing Type objects
<br/>which fully or partially qualified names can be used within document templates processed by this
<br/>assembler instance to invoke the corresponding types' static members, perform type casts, etc. |
| use_reflection_optimization | Gets or sets a value indicating whether invocations of custom type members performed via reflection API are
<br/>optimized using dynamic class generation or not. The default value is true. |

##### Methods
| Method | Description |
| :- | :- |
| assemble_document | Loads a template document from the specified source path, populates the template document with data from
<br/>the specified single or multiple sources, and stores the result document to the target path using default
<br/>`LoadSaveOptions`. |
| assemble_document | Loads a template document from the specified source path, populates the template document with data from
<br/>the specified single or multiple sources, and stores the result document to the target path using the given
<br/>`LoadSaveOptions`. |
| assemble_document | Loads a template document from the specified source stream, populates the template document with data from
<br/>the specified single or multiple sources, and stores the result document to the target stream using default
<br/>`LoadSaveOptions`. |
| assemble_document | Loads a template document from the specified source stream, populates the template document with data from
<br/>the specified single or multiple sources, and stores the result document to the target stream using the given
<br/>`LoadSaveOptions`. |

### DocumentAssembler constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler/__init__.md

#### __init__

Initializes a new instance of this class.

```python
def __init__(self):
    ...
```

### assemble_document method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler/assemble_document.md

#### assemble_document

Loads a template document from the specified source path, populates the template document with data from
the specified single or multiple sources, and stores the result document to the target path using default
`LoadSaveOptions`.

##### Returns

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if
a value of the `DocumentAssembler.options` property includes the `DocumentAssemblyOptions.INLINE_ERROR_MESSAGES`
option.

```python
def assemble_document(self, source_path, target_path, data_source_infos):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | str | The path to a template document to be populated with data. |
| target_path | str | The path to a result document. |
| data_source_infos | list | Provides information on data source objects to be used. |

#### assemble_document

Loads a template document from the specified source stream, populates the template document with data from
the specified single or multiple sources, and stores the result document to the target stream using default
`LoadSaveOptions`.

##### Returns

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if
a value of the `DocumentAssembler.options` property includes the `DocumentAssemblyOptions.INLINE_ERROR_MESSAGES`
option.

```python
def assemble_document(self, source_stream, target_stream, data_source_infos):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream | io.RawIOBase | The stream to read a template document from. |
| target_stream | io.RawIOBase | The stream to write a result document. |
| data_source_infos | list | Provides information on data source objects to be used. |

#### assemble_document

Loads a template document from the specified source path, populates the template document with data from
the specified single or multiple sources, and stores the result document to the target path using the given
`LoadSaveOptions`.

##### Returns

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if
a value of the `DocumentAssembler.options` property includes the `DocumentAssemblyOptions.INLINE_ERROR_MESSAGES`
option.

```python
def assemble_document(self, source_path, target_path, load_save_options, data_source_infos):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | str | The path to a template document to be populated with data. |
| target_path | str | The path to a result document. |
| load_save_options | `LoadSaveOptions` | Specifies additional options for document loading and saving. |
| data_source_infos | list | Provides information on data source objects to be used. |

#### assemble_document

Loads a template document from the specified source stream, populates the template document with data from
the specified single or multiple sources, and stores the result document to the target stream using the given
`LoadSaveOptions`.

##### Returns

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if
a value of the `DocumentAssembler.options` property includes the `DocumentAssemblyOptions.INLINE_ERROR_MESSAGES`
option.

```python
def assemble_document(self, source_stream, target_stream, load_save_options, data_source_infos):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream | io.RawIOBase | The stream to read a template document from. |
| target_stream | io.RawIOBase | The stream to write a result document. |
| load_save_options | `LoadSaveOptions` | Specifies additional options for document loading and saving. |
| data_source_infos | list | Provides information on data source objects to be used. |

### barcode_settings property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler/barcode_settings.md

#### barcode_settings property

Gets a set of settings controlling barcode generation while assembling a document.
##### Definition:
```python
@property
def barcode_settings(self):
    ...
```

### known_types property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler/known_types.md

#### known_types property

Gets an unordered set (that is, a collection of unique items) containing Type objects
which fully or partially qualified names can be used within document templates processed by this
assembler instance to invoke the corresponding types' static members, perform type casts, etc.
##### Definition:
```python
@property
def known_types(self):
    ...
```

### options property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler/options.md

#### options property

Gets or sets a set of flags controlling behavior of this `DocumentAssembler` instance
while assembling a document.
##### Definition:
```python
@property
def options(self):
    ...
@options.setter
def options(self, value):
    ...
```

### use_reflection_optimization property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassembler/use_reflection_optimization.md

#### use_reflection_optimization property

Gets or sets a value indicating whether invocations of custom type members performed via reflection API are
optimized using dynamic class generation or not. The default value is true.

##### Remarks

There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing
with small collections of data items all the time, then an overhead of dynamic class generation can be more
noticeable than an overhead of direct reflection API calls.

### DocumentAssemblyOptions enumeration
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/documentassemblyoptions.md

#### DocumentAssemblyOptions enumeration

Specifies options controlling behavior of `DocumentAssembler` while assembling a document.

The DocumentAssemblyOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies default options. |
| ALLOW_MISSING_MEMBERS | Specifies that missing object members should be treated as null literals by the assembler. This option
<br/>affects only access to instance (that is, non-static) object members and extension methods. If this
<br/>option is not set, the assembler throws an exception when encounters a missing object member. |
| UPDATE_FIELDS_AND_FORMULAS | Specifies that fields of result Word Processing documents and formulas of result Spreadsheet documents
<br/>should be updated by the assembler. |
| REMOVE_EMPTY_PARAGRAPHS | Specifies that the assembler should remove paragraphs becoming empty after template syntax tags are
<br/>removed or replaced with empty values. |
| INLINE_ERROR_MESSAGES | Specifies that the assembler should inline template syntax error messages into output documents.
<br/>If this option is not set, the assembler throws an exception when encounters a syntax error. |
| USE_SPREADSHEET_DATA_TYPES | Relates to Spreadsheet documents only. Specifies that evaluated expression results should be mapped to
<br/>corresponding Spreadsheet data types, which also affects their default formatting within cells. If this
<br/>option is not set, expression results are always written as strings by the assembler. This option has
<br/>no effect when expression results are formatted using template syntax - expression results are always
<br/>written as strings then as well. |

### FileFormat enumeration
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/fileformat.md

#### FileFormat enumeration

Specifies the format of a file.

The FileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNSPECIFIED | Specifies an unset value. The default. |
| DOC | Specifies the Microsoft Word 97 - 2007 Binary Document format. |
| DOT | Specifies the Microsoft Word 97 - 2007 Binary Template format. |
| DOCX | Specifies the Office Open XML WordprocessingML Document (macro-free) format. |
| DOCM | Specifies the Office Open XML WordprocessingML Macro-Enabled Document format. |
| DOTX | Specifies the Office Open XML WordprocessingML Template (macro-free) format. |
| DOTM | Specifies the Office Open XML WordprocessingML Macro-Enabled Template format. |
| FLAT_OPC | Specifies the Office Open XML WordprocessingML format stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_MACRO_ENABLED | Specifies the Office Open XML WordprocessingML Macro-Enabled Document format stored in a flat XML file
<br/>instead of a ZIP package. |
| FLAT_OPC_TEMPLATE | Specifies the Office Open XML WordprocessingML Template (macro-free) format stored in a flat XML file
<br/>instead of a ZIP package. |
| FLAT_OPC_TEMPLATE_MACRO_ENABLED | Specifies the Office Open XML WordprocessingML Macro-Enabled Template format stored in a flat XML file
<br/>instead of a ZIP package. |
| WORD_ML | Specifies the Microsoft Word 2003 WordprocessingML format. |
| ODT | Specifies the ODF Text Document format. |
| OTT | Specifies the ODF Text Document Template format. |
| XLS | Specifies the Microsoft Excel 97 - 2007 Binary Workbook format. |
| XLSX | Specifies the Office Open XML SpreadsheetML Workbook (macro-free) format. |
| XLSM | Specifies the Office Open XML SpreadsheetML Macro-Enabled Workbook format. |
| XLTX | Specifies the Office Open XML SpreadsheetML Template (macro-free) format. |
| XLTM | Specifies the Office Open XML SpreadsheetML Macro-Enabled Template format. |
| XLAM | Specifies the Office Open XML SpreadsheetML Macro-Enabled Add-in format. |
| XLSB | Specifies the Microsoft Excel 2007 Macro-Enabled Binary File format. |
| SPREADSHEET_ML | Specifies the Microsoft Excel 2003 SpreadsheetML format. |
| ODS | Specifies the ODF Spreadsheet format. |
| PPT | Specifies the Microsoft PowerPoint 97 - 2007 Binary Presentation format. |
| PPS | Specifies the Microsoft PowerPoint 97 - 2007 Binary Slide Show format. |
| PPTX | Specifies the Office Open XML PresentationML Presentation (macro-free) format. |
| PPTM | Specifies the Office Open XML PresentationML Macro-Enabled Presentation format. |
| PPSX | Specifies the Office Open XML PresentationML Slide Show (macro-free) format. |
| PPSM | Specifies the Office Open XML PresentationML Macro-Enabled Slide Show format. |
| POTX | Specifies the Office Open XML PresentationML Template (macro-free) format. |
| POTM | Specifies the Office Open XML PresentationML Macro-Enabled Template format. |
| ODP | Specifies the ODF Presentation format. |
| MSG_ASCII | Specifies the Microsoft Outlook Message (MSG) format using ASCII character encoding. |
| MSG_UNICODE | Specifies the Microsoft Outlook Message (MSG) format using Unicode character encoding. |
| EML | Specifies the MIME standard format. |
| EMLX | Specifies the Apple Mail.app program file format. |
| RTF | Specifies the RTF format. |
| TEXT | Specifies the plain text format. |
| XML | Specifies the XML format of a general form. |
| XAML | Specifies the Extensible Application Markup Language (XAML) format. |
| XAML_PACKAGE | Specifies the Extensible Application Markup Language (XAML) package format. |
| HTML | Specifies the HTML format. |
| MHTML | Specifies the MHTML (Web archive) format. |
| XPS | Specifies the XPS (XML Paper Specification) format. |
| OPEN_XPS | Specifies the OpenXPS (Ecma-388) format. |
| PDF | Specifies the PDF (Adobe Portable Document) format. |
| EPUB | Specifies the IDPF EPUB format. |
| PS | Specifies the PS (PostScript) format. |
| PCL | Specifies the PCL (Printer Control Language) format. |
| SVG | Specifies the SVG (Scalable Vector Graphics) format. |
| TIFF | Specifies the TIFF format. |
| MARKDOWN | Specifies the Markdown format. |
| POT | Specifies the Microsoft PowerPoint 97 - 2007 Binary Template format. |
| OTP | Specifies the ODF Presentation Template format. |
| XLT | Specifies the Microsoft Excel 97 - 2007 Binary Template format. |

### GraphicsUnit enumeration
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/graphicsunit.md

#### GraphicsUnit enumeration

The GraphicsUnit type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| WORLD | Specifies the world coordinate system unit as the unit of measure. |
| DISPLAY | Specifies the unit of measure of the display device. Typically pixels for video displays, and 1/100 inch for printers. |
| PIXEL | Specifies a device pixel as the unit of measure. |
| POINT | Specifies a printer's point (1/72 inch) as the unit of measure. |
| INCH | Specifies the inch as the unit of measure. |
| DOCUMENT | Specifies the document unit (1/300 inch) as the unit of measure. |
| MILLIMETER | Specifies the millimeter as the unit of measure. |

### KnownTypeSet class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/knowntypeset.md

#### KnownTypeSet class

Represents an unordered set (that is, a collection of unique items) containing Type objects
which fully or partially qualified names can be used within document templates to invoke the corresponding
types' static members, perform type casts, etc.

The KnownTypeSet type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the count of items in the set. |

##### Methods
| Method | Description |
| :- | :- |
| add |  |
| remove |  |
| clear | Removes all items from the set. |

### add method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/knowntypeset/add.md

#### add

```python
def add(self, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| type | Type |  |

### clear method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/knowntypeset/clear.md

#### clear

Removes all items from the set.

```python
def clear(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/knowntypeset/count.md

#### count property

Gets the count of items in the set.
##### Definition:
```python
@property
def count(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/knowntypeset/remove.md

#### remove

```python
def remove(self, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| type | Type |  |

### License class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/license.md

#### License class

Provides methods to license the component.

The License type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of this class. |

##### Properties
| Property | Description |
| :- | :- |
| is_licensed | Returns true if a valid license has been applied; false if the component is running in evaluation mode. |

##### Methods
| Method | Description |
| :- | :- |
| set_license | Licenses the component. |
| set_license | Licenses the component. |

### License constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/license/__init__.md

#### __init__

Initializes a new instance of this class.

```python
def __init__(self):
    ...
```

### is_licensed property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/license/is_licensed.md

#### is_licensed property

Returns true if a valid license has been applied; false if the component is running in evaluation mode.
##### Definition:
```python
@property
def is_licensed(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/license/set_license.md

#### set_license

Licenses the component.

```python
def set_license(self, license_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_name | str | Can be a full or short file name.
<br/>Use an empty string to switch to evaluation mode. |

#### set_license

Licenses the component.

```python
def set_license(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | A stream that contains the license. |

### LoadSaveOptions class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/loadsaveoptions.md

#### LoadSaveOptions class

Specifies additional options for loading and saving of a document to be assembled.

The LoadSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new instance of this class without any properties specified. |
| __init__ | Creates a new instance of this class with the specified file format to save an assembled document to. |

##### Properties
| Property | Description |
| :- | :- |
| save_format | Gets or sets a file format to save an assembled document to. `FileFormat.UNSPECIFIED` is the default. |
| resource_load_base_uri | Gets or sets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML
<br/>template document to be assembled and saved to a non-HTML format. The default value is an empty string. |
| resource_save_folder | Gets or sets a path to a folder to store external resource files while an assembled document loaded from a non-HTML
<br/>format is being saved to HTML. The default value is an empty string. |

### LoadSaveOptions constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/loadsaveoptions/__init__.md

#### __init__

Creates a new instance of this class without any properties specified.

```python
def __init__(self):
    ...
```

#### __init__

Creates a new instance of this class with the specified file format to save an assembled document to.

```python
def __init__(self, save_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| save_format | `FileFormat` | A file format to save an assembled document to. |

### resource_load_base_uri property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/loadsaveoptions/resource_load_base_uri.md

#### resource_load_base_uri property

Gets or sets a base URI to resolve external resource files' relative URIs to absolute ones while loading an HTML
template document to be assembled and saved to a non-HTML format. The default value is an empty string.

##### Remarks

When loading an HTML document from a file, its containing folder is used as a base URI by default, which cannot
happen when loading an HTML document from a stream. Set this property to specify a base URI when loading an HTML
document from a stream or to override the default base URI when loading an HTML document from a file.

A value of this property is ignored in the following cases:

|
|
 |
 |
##### Definition:
```python
@property
def resource_load_base_uri(self):
    ...
@resource_load_base_uri.setter
def resource_load_base_uri(self, value):
    ...
```

### resource_save_folder property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/loadsaveoptions/resource_save_folder.md

#### resource_save_folder property

Gets or sets a path to a folder to store external resource files while an assembled document loaded from a non-HTML
format is being saved to HTML. The default value is an empty string.

##### Remarks

By default, when saving an assembled document to an HTML file, external resource files are stored to a folder
having the same name as the HTML file without extension plus the "_files" suffix. This folder is located in
the same folder as the HTML file. However, this cannot be done when saving an assembled document to an HTML stream.
Set this property to specify a path to a folder to store external resource files when saving an assembled document
to an HTML stream or to override the default folder when saving an assembled document to an HTML file.

A value of this property is ignored if an assembled document being saved to HTML was loaded from HTML as well
(external resource files are not stored and links to them are not changed then).
##### Definition:
```python
@property
def resource_save_folder(self):
    ...
@resource_save_folder.setter
def resource_save_folder(self, value):
    ...
```

### save_format property
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/loadsaveoptions/save_format.md

#### save_format property

Gets or sets a file format to save an assembled document to. `FileFormat.UNSPECIFIED` is the default.

##### Remarks

When the value of this property is not specified, `DocumentAssembler` behaves as follows:

- When you specify a file path to save an assembled document, the save file format is determined upon file
extension from the path.

- When you specify a stream to save an assembled document, the save file format remains the same as the file
format of a loaded template document.

Beware that it is not always possible to save an assembled document to any file format using GroupDocs.Assembly.
For example, it is impossible to save a document loaded from a Word Processing file format (such as DOCX) to
a Spreadsheet file format (such as XLSX). For more information on possible combinations of load and save file
formats supported by GroupDocs.Assembly, please check GroupDocs.Assembly online documentation.
##### Definition:
```python
@property
def save_format(self):
    ...
@save_format.setter
def save_format(self, value):
    ...
```

### Metered class
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/metered.md

#### Metered class

Provides methods to work with metered licensing.

The Metered type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates a new instance of this class. |

##### Methods
| Method | Description |
| :- | :- |
| set_metered_key | Enables metered licensing for the component by specifying appropriate public and private metered keys. |
| get_consumption_quantity | Returns the currently consumed number of megabytes. |
| get_consumption_credit | Returns the currently consumed number of credits. |

##### Example

In this example, an attempt to set metered public and private keys is made:

### Metered constructor
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/metered/__init__.md

#### __init__

Creates a new instance of this class.

```python
def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/metered/get_consumption_credit.md

#### get_consumption_credit

Returns the currently consumed number of credits.

##### Returns

The currently consumed number of credits.

```python
def get_consumption_credit(self):
    ...
```

### get_consumption_quantity method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/metered/get_consumption_quantity.md

#### get_consumption_quantity

Returns the currently consumed number of megabytes.

##### Returns

The currently consumed number of megabytes.

```python
def get_consumption_quantity(self):
    ...
```

### set_metered_key method
Path: https://reference.groupdocs.com/assembly/python-net/groupdocs.assembly/metered/set_metered_key.md

#### set_metered_key

Enables metered licensing for the component by specifying appropriate public and private metered keys.

```python
def set_metered_key(self, public_key, private_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| public_key | str | The public metered key. |
| private_key | str | The private metered key. |


# GroupDocs.Classification

> Classify documents and text with IAB-2, Documents, and Sentiment taxonomies.

## Java

### GroupDocs.Classification for Java
Path: https://reference.groupdocs.com/classification/java.md

## .NET

### GroupDocs.Classification for .NET
Path: https://reference.groupdocs.com/classification/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Classification | The GroupDocs.Classification namespace provides classes for texts and documents classification The main classes in the namespace are Classifier is the entry point for the classification. Taxonomy represents all supported taxonomies. PrecisionRecallBalance represents all supported precision/recall balances for Documents taxonomy. |
| GroupDocs.Classification.DTO | The GroupDcos.Classification.DTO namespace provide classes for data type objects. |
| GroupDocs.Classification.Exceptions | The GroupDocs.Classification.Exceptions namespace provides exception classes. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Classification.dll -->

### GroupDocs.Classification.DTO
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto.md

The GroupDcos.Classification.DTO namespace provide classes for data type objects.

#### Classes

| Class | Description |
| --- | --- |
| ClassificationResponse | Classification response. |
| ClassificationResult | Classifition results. |
| SentimentConfig | Configuration for the sentiment classification. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Classification.dll -->

### ClassificationResponse
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresponse.md

#### ClassificationResponse class

Classification response.

```csharp
public class ClassificationResponse
```

#### Constructors

| Name | Description |
| --- | --- |
| ClassificationResponse() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| BestClassName { get; set; } | Gets or sets best class name. |
| BestClassProbability { get; set; } | Gets or sets best class probability. |
| BestResults { get; set; } | Gets or sets array of best classes results. |

### BestClassName
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresponse/bestclassname.md

#### ClassificationResponse.BestClassName property

Gets or sets best class name.

```csharp
public string BestClassName { get; set; }
```

### BestClassProbability
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresponse/bestclassprobability.md

#### ClassificationResponse.BestClassProbability property

Gets or sets best class probability.

```csharp
public float BestClassProbability { get; set; }
```

### BestResults
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresponse/bestresults.md

#### ClassificationResponse.BestResults property

Gets or sets array of best classes results.

```csharp
public ClassificationResult[] BestResults { get; set; }
```

### ClassificationResponse
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresponse/classificationresponse.md

#### ClassificationResponse constructor

The default constructor.

```csharp
public ClassificationResponse()
```

### ClassificationResult
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresult.md

#### ClassificationResult class

Classifition results.

```csharp
public class ClassificationResult
```

#### Constructors

| Name | Description |
| --- | --- |
| ClassificationResult() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Name { get; set; } | Gets or sets the name of the class. |
| Probability { get; set; } | Gets or sets the probability of class. |

### ClassificationResult
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresult/classificationresult.md

#### ClassificationResult constructor

The default constructor.

```csharp
public ClassificationResult()
```

### Name
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresult/name.md

#### ClassificationResult.Name property

Gets or sets the name of the class.

```csharp
public string Name { get; set; }
```

### Probability
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/classificationresult/probability.md

#### ClassificationResult.Probability property

Gets or sets the probability of class.

```csharp
public float Probability { get; set; }
```

### SentimentConfig
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/sentimentconfig.md

#### SentimentConfig class

Configuration for the sentiment classification.

```csharp
public class SentimentConfig
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly AllLanguages | Sentiment configuration for all languages. |
| static readonly ChineseLanguage | Sentiment configuration for the Chinese language. |
| static readonly EnglishLanguage | Sentiment configuration for the English language. |

### AllLanguages
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/sentimentconfig/alllanguages.md

#### SentimentConfig.AllLanguages field

Sentiment configuration for all languages.

```csharp
public static readonly SentimentConfig AllLanguages;
```

### ChineseLanguage
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/sentimentconfig/chineselanguage.md

#### SentimentConfig.ChineseLanguage field

Sentiment configuration for the Chinese language.

```csharp
public static readonly SentimentConfig ChineseLanguage;
```

### EnglishLanguage
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.dto/sentimentconfig/englishlanguage.md

#### SentimentConfig.EnglishLanguage field

Sentiment configuration for the English language.

```csharp
public static readonly SentimentConfig EnglishLanguage;
```

### GroupDocs.Classification.Exceptions
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.exceptions.md

The GroupDocs.Classification.Exceptions namespace provides exception classes.

#### Classes

| Class | Description |
| --- | --- |
| ApiException | GroupDocs.Classification api exception. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Classification.dll -->

### ApiException
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.exceptions/apiexception.md

#### ApiException class

GroupDocs.Classification api exception.

```csharp
public class ApiException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| ApiException(string) | Initializes new instance of ApiException class. |

### ApiException
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.exceptions/apiexception/apiexception.md

#### ApiException constructor

Initializes new instance of ApiException class.

```csharp
public ApiException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message. |

### GroupDocs.Classification
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification.md

The GroupDocs.Classification namespace provides classes for texts and documents classification The main classes in the namespace are Classifier is the entry point for the classification. Taxonomy represents all supported taxonomies. PrecisionRecallBalance represents all supported precision/recall balances for Documents taxonomy.

#### Classes

| Class | Description |
| --- | --- |
| Classifier | Provides methods for executing text classification. |
| License | Provides methods to license the component. |
| Metered | Provides methods to set metered key. |
| SentimentClassifier | Provides methods for executing text classification. |
| TaxonomyClasses | Available taxonomies. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| PrecisionRecallBalance | Enum for the balance between precision and recall. |
| Taxonomy | Enum for supported taxonomies. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Classification.dll -->

### Classifier
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/classifier.md

#### Classifier class

Provides methods for executing text classification.

```csharp
public class Classifier
```

#### Constructors

| Name | Description |
| --- | --- |
| Classifier(SentimentConfig) | Initializes a new instance of the `Classifier` class. |

#### Methods

| Name | Description |
| --- | --- |
| Classify(string, int, Taxonomy, PrecisionRecallBalance) | Classifies text. |
| Classify(Stream, string, int, Taxonomy, PrecisionRecallBalance, string) | Classifies document from stream. |
| Classify(string, string, int, Taxonomy, PrecisionRecallBalance, string) | Classifies document by file name and directory name. |

### Classifier
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/classifier/classifier.md

#### Classifier constructor

Initializes a new instance of the `Classifier` class.

```csharp
public Classifier(SentimentConfig sentimentConfig = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sentimentConfig | SentimentConfig | Sentiment classifier configuration. |

### Classify
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/classifier/classify.md

#### Classify(string, int, Taxonomy, PrecisionRecallBalance)

Classifies text.

```csharp
public ClassificationResponse Classify(string text, int bestClassesCount = 1, 
    Taxonomy taxonomy = Taxonomy.Iab2, 
    PrecisionRecallBalance precisionRecallBalance = PrecisionRecallBalance.Default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Raw text to classify. |
| bestClassesCount | Int32 | Count of the best classes to return. |
| taxonomy | Taxonomy | Taxonomy to use for classification. |
| precisionRecallBalance | PrecisionRecallBalance | Balance between precision and recall: precision, recall or default. |

##### Return Value

`ClassificationResponse` with classification results.

##### Exceptions

| exception | condition |
| --- | --- |
| ApiException | An API exception occurred. |

#### Classify(string, string, int, Taxonomy, PrecisionRecallBalance, string)

Classifies document by file name and directory name.

```csharp
public ClassificationResponse Classify(string filename, string directory, int bestClassesCount = 1, 
    Taxonomy taxonomy = Taxonomy.Iab2, 
    PrecisionRecallBalance precisionRecallBalance = PrecisionRecallBalance.Default, 
    string password = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Document name. |
| directory | String | Document directory. |
| bestClassesCount | Int32 | Count of the best classes to return. |
| taxonomy | Taxonomy | Taxonomy to use for classification. |
| precisionRecallBalance | PrecisionRecallBalance | Balance between precision and recall: precision, recall or default. |
| password | String | Document password. |

##### Return Value

`ClassificationResponse` with classification results.

##### Exceptions

| exception | condition |
| --- | --- |
| ApiException | An API exception occurred. |

#### Classify(Stream, string, int, Taxonomy, PrecisionRecallBalance, string)

Classifies document from stream.

```csharp
public ClassificationResponse Classify(Stream stream, string filename = null, 
    int bestClassesCount = 1, Taxonomy taxonomy = Taxonomy.Iab2, 
    PrecisionRecallBalance precisionRecallBalance = PrecisionRecallBalance.Default, 
    string password = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | File stream. |
| filename | String | File name (for optional file type identification). |
| bestClassesCount | Int32 | Count of the best classes to return. |
| taxonomy | Taxonomy | Taxonomy to use for classification. |
| precisionRecallBalance | PrecisionRecallBalance | Balance between precision and recall: precision, recall or default. |
| password | String | Document password. |

##### Return Value

`ClassificationResponse` with classification results.

##### Exceptions

| exception | condition |
| --- | --- |
| ApiException | An API exception occurred. |

### License
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/license.md

#### License class

Provides methods to license the component.

```csharp
public class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | Initializes a new instance of this class. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### License
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/license/license.md

#### License constructor

Initializes a new instance of this class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/license/setlicense.md

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string licenseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseName | String | Can be a full or short file name or name of an embedded resource. Use an empty string to switch to evaluation mode. |

##### Remarks

Tries to find the license in the following locations:

1. Explicit path.

2. The folder that contains the Aspose component assembly.

3. The folder that contains the client's calling assembly.

4. The folder that contains the entry (startup) assembly.

5. An embedded resource in the client's calling assembly.

**Note:**On the .NET Compact Framework, tries to find the license only in these locations:

1. Explicit path.

2. An embedded resource in the client's calling assembly.

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | A stream that contains the license. |

##### Remarks

Use this method to load a license from a stream.

### Metered
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/metered.md

#### Metered class

Provides methods to set metered key.

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | Initializes a new instance of this class. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Sets metered public and private key |
| static GetConsumptionCredit() | Gets consumption credit |
| static GetConsumptionQuantity() | Gets consumption file size |

##### Examples

In this example, an attempt will be made to set metered public and private key

```csharp
[C#]

Metered matered = new Metered();
matered.SetMeteredKey("PublicKey", "PrivateKey");


[Visual Basic]

Dim matered As Metered = New Metered
matered.SetMeteredKey("PublicKey", "PrivateKey")
```

### GetConsumptionCredit
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Gets consumption credit

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

consumption quantity

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Gets consumption file size

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

consumption quantity

### Metered
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/metered/metered.md

#### Metered constructor

Initializes a new instance of this class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Sets metered public and private key

```csharp
public void SetMeteredKey(string publicKey, string privateKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | String | public key |
| privateKey | String | private key |

### PrecisionRecallBalance
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/precisionrecallbalance.md

#### PrecisionRecallBalance enumeration

Enum for the balance between precision and recall.

```csharp
public enum PrecisionRecallBalance
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | Default value for the balance between precision and recall. |
| Precision | `1` | Priority for precision. |
| Recall | `2` | Priority for recall. |

### SentimentClassifier
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/sentimentclassifier.md

#### SentimentClassifier class

Provides methods for executing text classification.

```csharp
public class SentimentClassifier
```

#### Constructors

| Name | Description |
| --- | --- |
| SentimentClassifier(SentimentConfig) | Initializes a new instance of the `SentimentClassifier` class. |

#### Methods

| Name | Description |
| --- | --- |
| Classify(string, int, Taxonomy) | Sentiment classification for a text. |
| PositiveProbability(string) | Returns positive probability Sentiment classification for a text. |

### Classify
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/sentimentclassifier/classify.md

#### SentimentClassifier.Classify method

Sentiment classification for a text.

```csharp
public ClassificationResponse Classify(string text, int bestClassesCount = 1, 
    Taxonomy taxonomy = Taxonomy.Sentiment)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Raw text to classify. |
| bestClassesCount | Int32 | Count of the best classes to return. |
| taxonomy | Taxonomy | Sentiment taxonomy (Sentiment or Sentiment3). |

##### Return Value

`ClassificationResponse` with classification results.

##### Exceptions

| exception | condition |
| --- | --- |
| ApiException | An API exception occurred. |

### PositiveProbability
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/sentimentclassifier/positiveprobability.md

#### SentimentClassifier.PositiveProbability method

Returns positive probability Sentiment classification for a text.

```csharp
public float PositiveProbability(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Raw text to classify. |

##### Return Value

Probability that the text is positive.

##### Exceptions

| exception | condition |
| --- | --- |
| ApiException | An API exception occurred. |

### SentimentClassifier
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/sentimentclassifier/sentimentclassifier.md

#### SentimentClassifier constructor

Initializes a new instance of the `SentimentClassifier` class.

```csharp
public SentimentClassifier(SentimentConfig config = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| config | SentimentConfig | Sentiment classifier configuration. |

### Taxonomy
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomy.md

#### Taxonomy enumeration

Enum for supported taxonomies.

```csharp
public enum Taxonomy
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Iab2 | `0` | Default Taxonomy (IAB-2). |
| Documents | `1` | Taxonomy with 10 document classes and one Others class. |
| Sentiment | `2` | Taxonomy for the binary sentiment classification. |
| Sentiment3 | `3` | Taxonomy for 3-classes sentiment classification (negative/neutral/positive). |

### TaxonomyClasses
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses.md

#### TaxonomyClasses class

Available taxonomies.

```csharp
public class TaxonomyClasses
```

#### Constructors

| Name | Description |
| --- | --- |
| TaxonomyClasses() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| static GetClassesForTaxonomy(Taxonomy) | Gets a list of the class names for the taxonomy. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly DocumentsClasses | The list of classes in Documents taxonomy. |
| static readonly Iab2Classes | The list of classes in IAB-2 taxonomy. |
| static readonly Sentiment3Classes | The list of classes in Sentiment3 taxonomy. |
| static readonly SentimentClasses | The list of classes in Sentiment taxonomy. |

### DocumentsClasses
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses/documentsclasses.md

#### TaxonomyClasses.DocumentsClasses field

The list of classes in Documents taxonomy.

```csharp
public static readonly string[] DocumentsClasses;
```

### GetClassesForTaxonomy
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses/getclassesfortaxonomy.md

#### TaxonomyClasses.GetClassesForTaxonomy method

Gets a list of the class names for the taxonomy.

```csharp
public static string[] GetClassesForTaxonomy(Taxonomy taxonomy)
```

| Parameter | Type | Description |
| --- | --- | --- |
| taxonomy | Taxonomy | Taxonomy. |

##### Return Value

List of the class names for the taxonomy.

### Iab2Classes
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses/iab2classes.md

#### TaxonomyClasses.Iab2Classes field

The list of classes in IAB-2 taxonomy.

```csharp
public static readonly string[] Iab2Classes;
```

### Sentiment3Classes
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses/sentiment3classes.md

#### TaxonomyClasses.Sentiment3Classes field

The list of classes in Sentiment3 taxonomy.

```csharp
public static readonly string[] Sentiment3Classes;
```

### SentimentClasses
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses/sentimentclasses.md

#### TaxonomyClasses.SentimentClasses field

The list of classes in Sentiment taxonomy.

```csharp
public static readonly string[] SentimentClasses;
```

### TaxonomyClasses
Path: https://reference.groupdocs.com/classification/net/groupdocs.classification/taxonomyclasses/taxonomyclasses.md

#### TaxonomyClasses constructor

The default constructor.

```csharp
public TaxonomyClasses()
```


# GroupDocs.Comparison

> Detect and merge changes in text, style, and formatting across documents.

## Java

### GroupDocs.Comparison for Java
Path: https://reference.groupdocs.com/comparison/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.comparison | The package provides classes to compare documents for all popular document formats.
 |
| com.groupdocs.comparison.cells.style | Provides classes for working with component styles in Cells format files.
 |
| com.groupdocs.comparison.common | Provides utility classes with methods that can be useful when using the GroupDocs.Comparison API.
 |
| com.groupdocs.comparison.common.delegates | The package provides classes that allows to specify additional options for documents comparison process.
 |
| com.groupdocs.comparison.common.exceptions | Provides exceptions which can be thrown during comparison process in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.common.function | Provides functional interfaces that allow accessing pages data during the document comparison process.
 |
| com.groupdocs.comparison.interfaces | Provides interfaces that define contracts for various components and functionalities in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.license | Provides classes for working with GroupDocs.Comparison license.
 |
| com.groupdocs.comparison.localization | Provides classes and interfaces for localization in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.logging | Provides classes and interfaces for logging in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.options | Provides classes and interfaces for configuring various options and settings related to document comparison.
 |
| com.groupdocs.comparison.options.enums | Provides enumerations for various options and settings in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.options.load | Provides classes and options for configuring loading documents in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.options.save | Provides classes and options for saving and configuring the output of GroupDocs.Comparison.
 |
| com.groupdocs.comparison.options.style | Provides classes and options for styling and configuring the visual appearance of the document comparison output in GroupDocs.Comparison.
 |
| com.groupdocs.comparison.result | Provides classes and interfaces for working with the result of document comparison.
 |
| com.groupdocs.comparison.utils |  |
| com.groupdocs.comparison.words.revision | Provides classes and interfaces for representing revisions and tracked changes in Word documents during the comparison process in GroupDocs.Comparison for Java.
 |

### com.groupdocs.comparison.cells.style
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.cells.style.md

Provides classes for working with component styles in Cells format files.

The classes in this package allow you to work with various styles and formatting options specific to Cells format files (e.g., Excel files).

Key classes in this package include:

* MergeType - Represents the enumeration the type of cell merge.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Enumerations

| Enum | Description |
| --- | --- |
| MergeType | Enumerates the type of cell merge. |

### MergeType
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.cells.style/mergetype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum MergeType extends Enum<MergeType>
```

Enumerates the type of cell merge.

#### Fields

| Field | Description |
| --- | --- |
| NONE | Indicates that the cell does not merge.
 |
| HORIZONTAL | Indicates that the cell merges along the row.
 |
| VERTICAL | Indicates that the cell merges along the column.
 |
| RANGE | Indicates that the cell merges along the row and column, creating an area.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### NONE
```
public static final MergeType NONE
```

Indicates that the cell does not merge.

##### HORIZONTAL
```
public static final MergeType HORIZONTAL
```

Indicates that the cell merges along the row.

##### VERTICAL
```
public static final MergeType VERTICAL
```

Indicates that the cell merges along the column.

##### RANGE
```
public static final MergeType RANGE
```

Indicates that the cell merges along the row and column, creating an area.

##### values()
```
public static MergeType[] values()
```

**Returns:**
com.groupdocs.comparison.cells.style.MergeType[]
##### valueOf(String name)
```
public static MergeType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MergeType

### com.groupdocs.comparison.common.delegates
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.delegates.md

The package provides classes that allows to specify additional options for documents comparison process.

### com.groupdocs.comparison.common.exceptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions.md

Provides exceptions which can be thrown during comparison process in GroupDocs.Comparison.

The main exception classes in this package are:

* ComparisonException - The base exception class for all exceptions related to document comparison.
* InvalidPasswordException - The exception that is thrown when an invalid password is provided for a password-protected document.
* UnsupportedFileFormatException - The exception that is thrown when file of this format is not supported by Comparison.

The exceptions in this package provide specific error handling and reporting for common operations in GroupDocs.Comparison.
They allow for more granular error detection and handling, enabling developers to respond appropriately to different error scenarios.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| ComparisonException | Base class for all exception that is thrown while using Comparison API. |
| DocumentComparisonException | The exception that is thrown when an error occurs while comparing documents. |
| FileFormatException | The exception that is thrown when comparing files with different comparison types. |
| InvalidPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordProtectedFileException | The exception that is thrown when document is protected by password but the password was not provided. |
| UnsupportedFileFormatException | The exception that is thrown when file of this format is not supported by Comparison. |

### ComparisonException
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions/comparisonexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.foundation.exception.GroupDocsException
```
public class ComparisonException extends GroupDocsException
```

Base class for all exception that is thrown while using Comparison API.

#### Constructors

| Constructor | Description |
| --- | --- |
| ComparisonException() | Initializes a new instance of the ComparisonException class.
 |
| ComparisonException(String message) | Initializes a new instance of the ComparisonException class with error message.
 |
| ComparisonException(String message, Throwable cause) | Initializes a new instance of the ComparisonException class with error message and an object that represents the cause of the exception.
 |
| ComparisonException(Throwable cause) | Initializes a new instance of the ComparisonException class with an object that represents the cause of the exception.
 |
##### ComparisonException()
```
public ComparisonException()
```

Initializes a new instance of the ComparisonException class.

##### ComparisonException(String message)
```
public ComparisonException(String message)
```

Initializes a new instance of the ComparisonException class with error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message
 |

##### ComparisonException(String message, Throwable cause)
```
public ComparisonException(String message, Throwable cause)
```

Initializes a new instance of the ComparisonException class with error message and an object that represents the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message
 |
| cause | java.lang.Throwable | The cause of the exception
 |

##### ComparisonException(Throwable cause)
```
public ComparisonException(Throwable cause)
```

Initializes a new instance of the ComparisonException class with an object that represents the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception
 |

### DocumentComparisonException
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions/documentcomparisonexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.comparison.common.exceptions.ComparisonException
```
public class DocumentComparisonException extends ComparisonException
```

The exception that is thrown when an error occurs while comparing documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentComparisonException(String message, Throwable cause) | Initializes a new instance of the DocumentComparisonException class with error message and an object that represents the cause of the exception.
 |
| DocumentComparisonException(Throwable cause) | Initializes a new instance of the DocumentComparisonException class with an object that represents the cause of the exception.
 |
##### DocumentComparisonException(String message, Throwable cause)
```
public DocumentComparisonException(String message, Throwable cause)
```

Initializes a new instance of the DocumentComparisonException class with error message and an object that represents the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message
 |
| cause | java.lang.Throwable | The cause of the exception
 |

##### DocumentComparisonException(Throwable cause)
```
public DocumentComparisonException(Throwable cause)
```

Initializes a new instance of the DocumentComparisonException class with an object that represents the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception
 |

### FileFormatException
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions/fileformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.comparison.common.exceptions.ComparisonException
```
public class FileFormatException extends ComparisonException
```

The exception that is thrown when comparing files with different comparison types.

#### Constructors

| Constructor | Description |
| --- | --- |
| FileFormatException(String sourceComparisonType, String targetComparisonType) | Initializes a new instance of the FileFormatException class with source and target comparison types.
 |
##### FileFormatException(String sourceComparisonType, String targetComparisonType)
```
public FileFormatException(String sourceComparisonType, String targetComparisonType)
```

Initializes a new instance of the FileFormatException class with source and target comparison types.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceComparisonType | java.lang.String | The source comparison type
 |
| targetComparisonType | java.lang.String | The target comparison type
 |

### InvalidPasswordException
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions/invalidpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.comparison.common.exceptions.ComparisonException
```
public class InvalidPasswordException extends ComparisonException
```

The exception that is thrown when specified password is incorrect.

#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidPasswordException() | Initializes a new instance of the InvalidPasswordException class.
 |
##### InvalidPasswordException()
```
public InvalidPasswordException()
```

Initializes a new instance of the InvalidPasswordException class.

### PasswordProtectedFileException
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions/passwordprotectedfileexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.comparison.common.exceptions.ComparisonException
```
public class PasswordProtectedFileException extends ComparisonException
```

The exception that is thrown when document is protected by password but the password was not provided.

#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordProtectedFileException() | Initializes a new instance of the PasswordProtectedFileException class.
 |
| PasswordProtectedFileException(String message, Throwable cause) | Initializes a new instance of the PasswordProtectedFileException class with error message and an object that represents the cause of the exception.
 |
##### PasswordProtectedFileException()
```
public PasswordProtectedFileException()
```

Initializes a new instance of the PasswordProtectedFileException class.

##### PasswordProtectedFileException(String message, Throwable cause)
```
public PasswordProtectedFileException(String message, Throwable cause)
```

Initializes a new instance of the PasswordProtectedFileException class with error message and an object that represents the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message
 |
| cause | java.lang.Throwable | The cause of the exception
 |

### UnsupportedFileFormatException
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.exceptions/unsupportedfileformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.foundation.exception.GroupDocsException, com.groupdocs.comparison.common.exceptions.ComparisonException
```
public class UnsupportedFileFormatException extends ComparisonException
```

The exception that is thrown when file of this format is not supported by Comparison.

#### Constructors

| Constructor | Description |
| --- | --- |
| UnsupportedFileFormatException() | Initializes a new instance of the UnsupportedFileFormatException class.
 |
| UnsupportedFileFormatException(String filePath) | Initializes a new instance of the UnsupportedFileFormatException class with path to the file.
 |
| UnsupportedFileFormatException(Throwable cause) | Initializes a new instance of the UnsupportedFileFormatException class with an object that represents the cause of the exception.
 |
##### UnsupportedFileFormatException()
```
public UnsupportedFileFormatException()
```

Initializes a new instance of the UnsupportedFileFormatException class.

##### UnsupportedFileFormatException(String filePath)
```
public UnsupportedFileFormatException(String filePath)
```

Initializes a new instance of the UnsupportedFileFormatException class with path to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file
 |

##### UnsupportedFileFormatException(Throwable cause)
```
public UnsupportedFileFormatException(Throwable cause)
```

Initializes a new instance of the UnsupportedFileFormatException class with an object that represents the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception
 |

### com.groupdocs.comparison.common.function
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.function.md

Provides functional interfaces that allow accessing pages data during the document comparison process.

The functional interfaces in this package are used to access data of pages when performing document comparison using GroupDocs.Comparison.

The main functional interfaces in this package are:

* CreatePageStreamFunction - Allows handling creating output stream used by Comparison to save pages data.
* ReleasePageStreamFunction - Allows handling releasing output stream used by Comparison to save pages data.

These functional interfaces can be used to define custom logic and behavior when working with document pages.
They provide flexibility to customize how and where to save pages are processed.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Interfaces

| Interface | Description |
| --- | --- |
| CreatePageStreamFunction | Functional interface that is used to create output stream used by Comparison to save preview image. |
| ReleasePageStreamFunction | Functional interface that is used to close output stream that was used by Comparison to save preview image. |

### CreatePageStreamFunction
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.function/createpagestreamfunction.md

### ReleasePageStreamFunction
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.function/releasepagestreamfunction.md

### com.groupdocs.comparison.common
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common.md

Provides utility classes with methods that can be useful when using the GroupDocs.Comparison API.

The classes in this package offer various utility methods that can assist in working
with the GroupDocs.Comparison API and performing common tasks related to document comparison.

Key classes in this package include:

* Utils - Provides common helper methods which can be useful when using Comparison API.

These utility classes aim to simplify common tasks and provide convenience methods for working
with files, paths, and streams in the context of document comparison using the GroupDocs.Comparison API.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| MemoryCleaner | Cleans different resources to free memory. |
| Utils | Utility class that provides common helper methods which can be useful when using Comparison API. |

### MemoryCleaner
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common/memorycleaner.md

**Inheritance:**
java.lang.Object
```
public final class MemoryCleaner
```

Cleans different resources to free memory.

This class provides methods to clear heap memory, delete temp files, and clear font registry information.
It also includes a method to safely clear thread-local instances for the current thread.

Example usage:

````

 // Clean heap memory, keeping font settings
 MemoryCleaner.clearKeepingFontSettings();

 // Clean heap memory and delete temp files
 MemoryCleaner.clear();

 // Clean heap memory from static PDF instances
 MemoryCleaner.clearStaticInstances();

 // Delete all temp files created by PDF in the system temp directory
 MemoryCleaner.clearAllTempFiles();

 // Clear font registry information from heap memory
 MemoryCleaner.clearFontRegistry();

 // Safely clear thread-local instances for the current thread
 MemoryCleaner.clearCurrentThreadLocals();
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| MemoryCleaner() |  |
#### Methods

| Method | Description |
| --- | --- |
| clearKeepingFontSettings() | Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files.
 |
| clear() | Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files.
 |
| clearStaticInstances() | Clears heap memory from static PDF instances.
 |
| clearAllTempFiles() | Clears temp files created by GroupDocs.Comparison in the system temp directory.
 |
| clearFontRegistry() | Clears font registry information from heap memory.
 |
| clearCurrentThreadLocals() | Safely clears heap memory from thread-local instances for the current thread.
 |
##### MemoryCleaner()
```
public MemoryCleaner()
```

##### clearKeepingFontSettings()
```
public static void clearKeepingFontSettings()
```

Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files.
This method does not affect font settings.

##### clear()
```
public static void clear()
```

Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files.

##### clearStaticInstances()
```
public static void clearStaticInstances()
```

Clears heap memory from static PDF instances.

##### clearAllTempFiles()
```
public static void clearAllTempFiles()
```

Clears temp files created by GroupDocs.Comparison in the system temp directory.

##### clearFontRegistry()
```
public static void clearFontRegistry()
```

Clears font registry information from heap memory.

##### clearCurrentThreadLocals()
```
public static void clearCurrentThreadLocals()
```

Safely clears heap memory from thread-local instances for the current thread.

### Utils
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.common/utils.md

**Inheritance:**
java.lang.Object
```
public class Utils
```

Utility class that provides common helper methods which can be useful when using Comparison API.

#### Constructors

| Constructor | Description |
| --- | --- |
| Utils() |  |
#### Methods

| Method | Description |
| --- | --- |
| getMethodByTag(Class<?> clazz, String methodTag, boolean isGetter) |  |
| closeStreams(Closeable[] closeables) | Quietly closes all provided objects catching and logging all IOException.
 |
| closeStreams(BiConsumer<Closeable,IOException> consumer, Closeable[] closeables) | Closes the specified streams, suppressing any exceptions that occur logging or processing IOException
 |
| isText(String data) | Checks that input string has only chars allowed in usual string of any language
 |
| containsOnlyLatinCharsAndPunctuation(String data) |  |
| toString(TextStyle textStyle) |  |
##### Utils()
```
public Utils()
```

##### getMethodByTag(Class<?> clazz, String methodTag, boolean isGetter)
```
public static Optional<Method> getMethodByTag(Class<?> clazz, String methodTag, boolean isGetter)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| clazz | java.lang.Class<?> |  |
| methodTag | java.lang.String |  |
| isGetter | boolean |  |

**Returns:**
java.util.Optional<java.lang.reflect.Method>
##### closeStreams(Closeable[] closeables)
```
public static boolean closeStreams(Closeable[] closeables)
```

Quietly closes all provided objects catching and logging all IOException.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| closeables | java.io.Closeable[] | Any object that implements Closeable interface, may be null
 |

**Returns:**
boolean - true if all closeable objects were closed without exception, otherwise false

##### closeStreams(BiConsumer<Closeable,IOException> consumer, Closeable[] closeables)
```
public static boolean closeStreams(BiConsumer<Closeable,IOException> consumer, Closeable[] closeables)
```

Closes the specified streams, suppressing any exceptions that occur logging or processing IOException
If any of the streams is null or encounters an exception while closing, it is ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| consumer | java.util.function.BiConsumer<java.io.Closeable,java.io.IOException> | Will be called for each pair of closeable and IOException when closing throws the exception, may be null
 |
| closeables | java.io.Closeable[] | Any object that implements Closeable interface, may be null
 |

**Returns:**
boolean - true if all closeable objects were closed without exception, otherwise false

##### isText(String data)
```
public static boolean isText(String data)
```

Checks that input string has only chars allowed in usual string of any language

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.String |  |

**Returns:**
boolean
##### containsOnlyLatinCharsAndPunctuation(String data)
```
public static boolean containsOnlyLatinCharsAndPunctuation(String data)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.String |  |

**Returns:**
boolean
##### toString(TextStyle textStyle)
```
public static void toString(TextStyle textStyle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textStyle | com.aspose.note.TextStyle |  |

### com.groupdocs.comparison.interfaces
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.interfaces.md

Provides interfaces that define contracts for various components and functionalities in GroupDocs.Comparison.

The main interfaces in this package are:

* IDocumentInfo - The interface that defines the contract for the information about a document.

The interfaces in this package provide the necessary contracts for implementing and interacting with different
components and functionalities in GroupDocs.Comparison.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Provides access to document properties. |

### IDocumentInfo
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.interfaces/idocumentinfo.md

**All Implemented Interfaces:**
java.io.Closeable
```
public interface IDocumentInfo extends Closeable
```

Provides access to document properties.

More details about its usage can be found in Document.getDocumentInfo() method or in a documentation.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    try (IDocumentInfo documentInfo = comparer.getSource().getDocumentInfo()) {
      for (int i = 0; i < documentInfo.getPageCount(); i++) {
          System.out.printf("File type: %s%nNumber of pages: %d", documentInfo.getFileType().getFileFormat(), documentInfo.getPageCount());
      }
    }
 }
 
````

#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets a type of the file represented by FileType enum.
 |
| setFileType(FileType value) | Sets a type of the file using FileType enum.
 |
| getPageCount() | Gets a count of the file.
 |
| setPageCount(int value) | Sets a count of the file.
 |
| getSize() | Gets a size of the file.
 |
| setSize(long value) | Sets a size of the file.
 |
| getPagesInfo() | Gets information for each page of the file using PageInfo class.
 |
| setPagesInfo(List<PageInfo> pageInfos) | Sets information for each page of the file using PageInfo class.
 |
| close() | Destroys the object making it impossible to get information of the document using this instance of IDocumentInfo object.
 |
##### getFileType()
```
public abstract FileType getFileType()
```

Gets a type of the file represented by FileType enum.

**Returns:**
FileType - the type of the file

##### setFileType(FileType value)
```
public abstract void setFileType(FileType value)
```

Sets a type of the file using FileType enum.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType | The type of the file
 |

##### getPageCount()
```
public abstract int getPageCount()
```

Gets a count of the file.

**Returns:**
int - the count of the file

##### setPageCount(int value)
```
public abstract void setPageCount(int value)
```

Sets a count of the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The count of the file
 |

##### getSize()
```
public abstract long getSize()
```

Gets a size of the file.

**Returns:**
long - the size of the file

##### setSize(long value)
```
public abstract void setSize(long value)
```

Sets a size of the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The size of the file
 |

##### getPagesInfo()
```
public abstract List<PageInfo> getPagesInfo()
```

Gets information for each page of the file using PageInfo class.

**Returns:**
java.util.List<com.groupdocs.comparison.result.PageInfo> - information for each page of the file

##### setPagesInfo(List<PageInfo> pageInfos)
```
public abstract void setPagesInfo(List<PageInfo> pageInfos)
```

Sets information for each page of the file using PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageInfos | java.util.List<com.groupdocs.comparison.result.PageInfo> | Information for each page of the file
 |

##### close()
```
public abstract void close()
```

Destroys the object making it impossible to get information of the document using this instance of IDocumentInfo object.
Also deletes temporary files and releases used resources.

### com.groupdocs.comparison.license
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.license.md

Provides classes for working with GroupDocs.Comparison license.

The classes in this package allow you to manage and apply licenses for GroupDocs.Comparison.
You can load and set the license file, check the license status, and perform license-related operations.

To use the license-related functionality, you need a valid license file provided by GroupDocs.
You can load the license file using the License class and then apply it to the GroupDocs.Comparison library.

For more details on how to work with licenses in GroupDocs.Comparison, please refer to the
Licensing FAQ.

#### Classes

| Class | Description |
| --- | --- |
| License | The License class provides methods to set and apply licenses for GroupDocs.Comparison. |
| Metered | Provides methods to apply metered license to Comparison. |

### License
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.license/license.md

**Inheritance:**
java.lang.Object
```
public class License
```

The License class provides methods to set and apply licenses for GroupDocs.Comparison.

It allows you to enable or disable specific features of the library based on the license applied.

* More about GroupDocs.Comparison licensing: Evaluation Limitations and Licensing

Example usage:

````

 final License license = new License();
 license.setLicense("GroupDocs.License.lic");
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| isValidLicense() | Gets a value indicating whether license was set or no.
 |
| setLicense(InputStream licenseStream) | Sets a license to Comparison using input stream.
 |
| setLicense(Path licensePath) | Sets a license to Comparison using license file path.
 |
| setLicense(String licensePath) | Sets a license to Comparison using license file path.
 |
##### License()
```
public License()
```

##### isValidLicense()
```
public static boolean isValidLicense()
```

Gets a value indicating whether license was set or no.

**Returns:**
boolean - true if license was set successfully, otherwise false

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Sets a license to Comparison using input stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream, null unsets license
 |

##### setLicense(Path licensePath)
```
public final void setLicense(Path licensePath)
```

Sets a license to Comparison using license file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.nio.file.Path | The license file path
 |

##### setLicense(String licensePath)
```
public final void setLicense(String licensePath)
```

Sets a license to Comparison using license file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license file path
 |

### Metered
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.license/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods to apply metered license to Comparison.

* More about GroupDocs.Comparison licensing: Evaluation Limitations and Licensing

Short example usage:

````

 final Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() | Initializes a new instance of the Metered class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getConsumptionQuantity() | Gets consumption quantity.
 |
| getConsumptionCredit() | Retrieves amount of used credits.
 |
| setMeteredKey(String publicKey, String privateKey) | Applies metered license using public and private keys.
 |
##### Metered()
```
public Metered()
```

Initializes a new instance of the Metered class.

##### getConsumptionQuantity()
```
public static double getConsumptionQuantity()
```

Gets consumption quantity.

**Returns:**
double - consumption quantity

##### getConsumptionCredit()
```
public static double getConsumptionCredit()
```

Retrieves amount of used credits.

**Returns:**
double - number of already used credits

##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Applies metered license using public and private keys.

Example usage:

````

 final Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | Public key
 |
| privateKey | java.lang.String | Private key
 |

### com.groupdocs.comparison.localization
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.localization.md

Provides classes and interfaces for localization in GroupDocs.Comparison. The localization functionality allows you to customize the text and messages displayed in the comparison process based on different languages or regional preferences.

The main classes and interfaces in this package are:

* SupportedLocales - A class provides constants representing the supported locales for GroupDocs.Comparison.

By using the localization functionality, you can customize the text and messages used in GroupDocs.Comparison to match the language or preferences of your users.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| SupportedLocales | The SupportedLocales class provides constants representing the supported locales for GroupDocs.Comparison. |

### SupportedLocales
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.localization/supportedlocales.md

**Inheritance:**
java.lang.Object
```
public class SupportedLocales
```

The SupportedLocales class provides constants representing the supported locales for GroupDocs.Comparison.

It allows you to specify the locale for language-specific operations, such as formatting and displaying messages.

For more information about locales, refer to the Java Locale documentation:
Java Locale

Example usage:

````

 final boolean localeSupported = SupportedLocales.isLocaleSupported(Locale.CANADA);
 
````

#### Methods

| Method | Description |
| --- | --- |
| isLocaleSupported(String localeString) | Determines whether locale supported or not.
 |
| isLocaleSupported(Locale locale) | Determines whether locale supported or not.
 |
| isLocaleSupported(CultureInfo culture) | Determines whether locale, represented as CultureInfo, supported or not.
 |
##### isLocaleSupported(String localeString)
```
public static boolean isLocaleSupported(String localeString)
```

Determines whether locale supported or not.
Format of localeString is  xx-YY  or  xx_YY , examples:  en-US ,  en_US

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| localeString | java.lang.String | The locale to be checked, may be null
 |

**Returns:**
boolean - true if supported, otherwise false

##### isLocaleSupported(Locale locale)
```
public static boolean isLocaleSupported(Locale locale)
```

Determines whether locale supported or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| locale | java.util.Locale | The locale to be checked, not null
 |

**Returns:**
boolean - true if supported, otherwise false

##### isLocaleSupported(CultureInfo culture)
```
public static boolean isLocaleSupported(CultureInfo culture)
```

Determines whether locale, represented as CultureInfo, supported or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| culture | com.groupdocs.foundation.utils.CultureInfo | The culture to be checked, not null
 |

**Returns:**
boolean - true if supported, otherwise false

### com.groupdocs.comparison.logging
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.logging.md

Provides classes and interfaces for logging in GroupDocs.Comparison. The logging functionality allows you to record and monitor various events and messages during the execution of the comparison process.

The main classes and interfaces in this package are:

* com.groupdocs.comparison.logging.ILogger - The interface that defines the contract for a logger.
* ComparisonLogger - Provides methods and a way to configure integrated or set user defined logger.
* com.groupdocs.comparison.logging.ConsoleLogger - Provides logger implementation which sends all messages to console.

By using the logging functionality, you can customize how log messages are handled,
such as writing them to a file, console, or any other destination of your choice.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| ComparisonLogger | Implements logging methods and a way to configure integrated or set user defined logger. |
| FileLogger | Logger that writes logs to file. |

### ComparisonLogger
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.logging/comparisonlogger.md

**Inheritance:**
java.lang.Object
```
public class ComparisonLogger
```

Implements logging methods and a way to configure integrated or set user defined logger.

The class allows setting up integrated or custom logger and writing log messages.

Example usage:

````

 ComparisonLogger.setLogger(new com.groupdocs.comparison.logging.ConsoleLogger(false, true, true, true));
 ComparisonLogger.warning(exceptionObject, "Warning message with parameters: {}, {}", "parameter1", 2);
 
````

#### Methods

| Method | Description |
| --- | --- |
| trace(String message, Object[] arguments) | Writes trace message to pre-configured logger.
 |
| trace(Throwable throwable, String message, Object[] arguments) | Writes trace message, stacktrace and message from an exception to pre-configured logger.
 |
| isTraceEnabled() | Checks whether trace logging enabled in pre-configured logger.
 |
| debug(String message, Object[] arguments) | Writes debug message to pre-configured logger.
 |
| debug(Throwable throwable, String message, Object[] arguments) | Writes debug message, stacktrace and message from an exception to pre-configured logger.
 |
| isDebugEnabled() | Checks whether debug logging enabled in pre-configured logger.
 |
| warning(String message, Object[] arguments) | Writes warning message to pre-configured logger.
 |
| warning(Throwable throwable, String message, Object[] arguments) | Writes warning message, stacktrace and message from an exception to pre-configured logger.
 |
| isWarningEnabled() | Checks whether warning logging enabled in pre-configured logger.
 |
| error(String message, Object[] arguments) | Writes error message to pre-configured logger.
 |
| error(Throwable throwable, String message, Object[] arguments) | Writes error message, stacktrace and message from an exception to pre-configured logger.
 |
| isErrorEnabled() | Checks whether error logging enabled in pre-configured logger.
 |
| getLogger() | Gets pre-configured logger that will be used to write all types of logs.
 |
| setLogger(ILogger logger) | Sets the logger that will be used to write all types of logs.
 |
##### trace(String message, Object[] arguments)
```
public static void trace(String message, Object[] arguments)
```

Writes trace message to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### trace(Throwable throwable, String message, Object[] arguments)
```
public static void trace(Throwable throwable, String message, Object[] arguments)
```

Writes trace message, stacktrace and message from an exception to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace, if null behaviour depends on logger
 |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### isTraceEnabled()
```
public static boolean isTraceEnabled()
```

Checks whether trace logging enabled in pre-configured logger.

**Returns:**
boolean - true if enabled in pre-configured logger, otherwise false

##### debug(String message, Object[] arguments)
```
public static void debug(String message, Object[] arguments)
```

Writes debug message to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### debug(Throwable throwable, String message, Object[] arguments)
```
public static void debug(Throwable throwable, String message, Object[] arguments)
```

Writes debug message, stacktrace and message from an exception to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace, if null behaviour depends on logger
 |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### isDebugEnabled()
```
public static boolean isDebugEnabled()
```

Checks whether debug logging enabled in pre-configured logger.

**Returns:**
boolean - true if enabled in pre-configured logger, otherwise false

##### warning(String message, Object[] arguments)
```
public static void warning(String message, Object[] arguments)
```

Writes warning message to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### warning(Throwable throwable, String message, Object[] arguments)
```
public static void warning(Throwable throwable, String message, Object[] arguments)
```

Writes warning message, stacktrace and message from an exception to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace, if null behaviour depends on logger
 |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### isWarningEnabled()
```
public static boolean isWarningEnabled()
```

Checks whether warning logging enabled in pre-configured logger.

**Returns:**
boolean - true if enabled in pre-configured logger, otherwise false

##### error(String message, Object[] arguments)
```
public static void error(String message, Object[] arguments)
```

Writes error message to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### error(Throwable throwable, String message, Object[] arguments)
```
public static void error(Throwable throwable, String message, Object[] arguments)
```

Writes error message, stacktrace and message from an exception to pre-configured logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace, if null behaviour depends on logger
 |
| message | java.lang.String | The message, if null behaviour depends on logger
 |
| arguments | java.lang.Object[] | The arguments to be embedded into message, if null behaviour depends on logger
 |

##### isErrorEnabled()
```
public static boolean isErrorEnabled()
```

Checks whether error logging enabled in pre-configured logger.

**Returns:**
boolean - true if enabled in pre-configured logger, otherwise false

##### getLogger()
```
public static synchronized ILogger getLogger()
```

Gets pre-configured logger that will be used to write all types of logs.

**Returns:**
com.groupdocs.foundation.logging.ILogger - the logger

##### setLogger(ILogger logger)
```
public static synchronized void setLogger(ILogger logger)
```

Sets the logger that will be used to write all types of logs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger
 |

### FileLogger
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.logging/filelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.foundation.logging.ILogger
```
public class FileLogger implements ILogger
```

Logger that writes logs to file.

Should be used together with ComparisonLogger.

Example usage:

````

 ComparisonLogger.setLogger(new FileLogger("/path/to/file.log.txt", false, true, true, true));
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| FileLogger(String filePath) | Initializes a new instance of the FileLogger class with file path.
 |
| FileLogger(String filePath, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) | Initializes a new instance of the FileLogger class with file path and logs levels configuration.
 |
#### Fields

| Field | Description |
| --- | --- |
| MESSAGE |  |
| EXCEPTION |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message, Object[] arguments) | Writes a trace message to the file.
 |
| trace(Throwable throwable, String message, Object[] arguments) | Writes a trace message to the file.
 |
| isTraceEnabled() | Checks whether trace logging enabled.
 |
| debug(String message, Object[] arguments) | Writes a debug message to the file.
 |
| debug(Throwable throwable, String message, Object[] arguments) | Writes a debug message to the file.
 |
| isDebugEnabled() | Checks whether debug logging enabled.
 |
| warning(String message, Object[] arguments) | Writes a warning message to the file.
 |
| warning(Throwable throwable, String message, Object[] arguments) | Writes a warning message to the file.
 |
| isWarningEnabled() | Checks whether warning logging enabled.
 |
| error(String message, Object[] arguments) | Writes an error message to the file.
 |
| error(Throwable throwable, String message, Object[] arguments) | Writes an error message to the file.
 |
| isErrorEnabled() | Checks whether error logging enabled.
 |
##### FileLogger(String filePath)
```
public FileLogger(String filePath)
```

Initializes a new instance of the FileLogger class with file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file that will be used to write logs
 |

##### FileLogger(String filePath, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
```
public FileLogger(String filePath, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
```

Initializes a new instance of the FileLogger class with file path and logs levels configuration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file that will be used to write logs
 |
| isTraceEnabled | boolean | True to enable trace logging, false otherwise
 |
| isDebugEnabled | boolean | True to enable debug logging, false otherwise
 |
| isWarningEnabled | boolean | True to enable warning logging, false otherwise
 |
| isErrorEnabled | boolean | True to enable error logging, false otherwise
 |

##### MESSAGE
```
public static final String MESSAGE
```

##### EXCEPTION
```
public static final String EXCEPTION
```

##### trace(String message, Object[] arguments)
```
public void trace(String message, Object[] arguments)
```

Writes a trace message to the file.

Trace log messages provide maximum detailed information about application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### trace(Throwable throwable, String message, Object[] arguments)
```
public void trace(Throwable throwable, String message, Object[] arguments)
```

Writes a trace message to the file.

Trace log messages provide maximum detailed information about application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace
 |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### isTraceEnabled()
```
public boolean isTraceEnabled()
```

Checks whether trace logging enabled.

**Returns:**
boolean - true if enabled, otherwise false

##### debug(String message, Object[] arguments)
```
public void debug(String message, Object[] arguments)
```

Writes a debug message to the file.

Debug log messages provide information about different processes in application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### debug(Throwable throwable, String message, Object[] arguments)
```
public void debug(Throwable throwable, String message, Object[] arguments)
```

Writes a debug message to the file.

Debug log messages provide information about different processes in application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace
 |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### isDebugEnabled()
```
public boolean isDebugEnabled()
```

Checks whether debug logging enabled.

**Returns:**
boolean - true if enabled, otherwise false

##### warning(String message, Object[] arguments)
```
public void warning(String message, Object[] arguments)
```

Writes a warning message to the file.

Warning log messages provide information about unexpected and recoverable events in application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### warning(Throwable throwable, String message, Object[] arguments)
```
public void warning(Throwable throwable, String message, Object[] arguments)
```

Writes a warning message to the file.

Warning log messages provide information about unexpected and recoverable events in application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace
 |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### isWarningEnabled()
```
public boolean isWarningEnabled()
```

Checks whether warning logging enabled.

**Returns:**
boolean - true if enabled, otherwise false

##### error(String message, Object[] arguments)
```
public void error(String message, Object[] arguments)
```

Writes an error message to the file.

Error log messages provide information about unrecoverable events in application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### error(Throwable throwable, String message, Object[] arguments)
```
public void error(Throwable throwable, String message, Object[] arguments)
```

Writes an error message to the file.

Error log messages provide information about unrecoverable events in application flow.
The message can contain one or few {} which will be replaced by corresponding arguments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace
 |
| message | java.lang.String | The message.
 |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as 'null'
 |

##### isErrorEnabled()
```
public boolean isErrorEnabled()
```

Checks whether error logging enabled.

**Returns:**
boolean - true if enabled, otherwise false

### com.groupdocs.comparison.options.enums
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums.md

Provides enumerations for various options and settings in GroupDocs.Comparison.

The classes in this package contain enumerations that define different options and settings
used in GroupDocs.Comparison for customization and configuration purposes.
These enumerations are used as parameters in various methods and classes to control the behavior
and appearance of the document comparison process.

Some of the key enumerations in this package include ChangeType,
com.groupdocs.comparison.cells.style.ComparisonStyle, and more.
These enumerations allow you to get the type of changes, the style of comparison
and other options for the document comparison process.

For more details on the available options and how to use them in GroupDocs.Comparison,
please refer to the GroupDocs.Comparison Documentation.

#### Enumerations

| Enum | Description |
| --- | --- |
| ComparisonType | Represents the type of comparison to be performed. |
| FolderComparisonExtension | The FolderComparisonExtension class is an enumeration that represents different file extensions that can be used in folder comparison. |
| MetadataType | Determines from where the result document will take metadata information. |
| PaperSize | Represents the paper size options for document comparison. |
| PasswordSaveOption | Enumerates the options for saving password information in a document during the comparison process. |
| PreviewFormats | Enumerates the supported preview formats for document comparison. |

### ComparisonType
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums/comparisontype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ComparisonType extends Enum<ComparisonType>
```

Represents the type of comparison to be performed.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    CompareOptions compareOptions = new CompareOptions();
    compareOptions.setComparisonType(ComparisonType.CELLS);

    comparer.compare(resultFile, compareOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| TEXT | Files must be compared as text documents.
 |
| SLIDES | Files must be compared as presentation documents.
 |
| WORDS | Files must be compared as words documents.
 |
| CELLS | Files must be compared as excel documents.
 |
| PDF | Files must be compared as pdf documents.
 |
| IMAGING | Files must be compared as image documents.
 |
| EMAIL | Files must be compared as email documents.
 |
| NOTE | Files must be compared as note documents.
 |
| HTML | Files must be compared as html documents.
 |
| DIAGRAM | Files must be compared as diagram documents.
 |
| DIFFERENT | Files must be compared as documents in different formats.
 |
| SVG | Files must be compared as svg documents.
 |
| UNDEFINED | For internal use.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of ComparisonType to get the enum constant.
 |
| toString() | String representation of ComparisonType.
 |
##### TEXT
```
public static final ComparisonType TEXT
```

Files must be compared as text documents.

##### SLIDES
```
public static final ComparisonType SLIDES
```

Files must be compared as presentation documents.

##### WORDS
```
public static final ComparisonType WORDS
```

Files must be compared as words documents.

##### CELLS
```
public static final ComparisonType CELLS
```

Files must be compared as excel documents.

##### PDF
```
public static final ComparisonType PDF
```

Files must be compared as pdf documents.

##### IMAGING
```
public static final ComparisonType IMAGING
```

Files must be compared as image documents.

##### EMAIL
```
public static final ComparisonType EMAIL
```

Files must be compared as email documents.

##### NOTE
```
public static final ComparisonType NOTE
```

Files must be compared as note documents.

##### HTML
```
public static final ComparisonType HTML
```

Files must be compared as html documents.

##### DIAGRAM
```
public static final ComparisonType DIAGRAM
```

Files must be compared as diagram documents.

##### DIFFERENT
```
public static final ComparisonType DIFFERENT
```

Files must be compared as documents in different formats.

##### SVG
```
public static final ComparisonType SVG
```

Files must be compared as svg documents.

##### UNDEFINED
```
public static final ComparisonType UNDEFINED
```

For internal use.

##### values()
```
public static ComparisonType[] values()
```

**Returns:**
com.groupdocs.comparison.options.enums.ComparisonType[]
##### valueOf(String name)
```
public static ComparisonType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ComparisonType
##### fromString(String toStringValue)
```
public static ComparisonType fromString(String toStringValue)
```

Parses string representation of ComparisonType to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of ComparisonType
 |

**Returns:**
ComparisonType - ComparisonType enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of ComparisonType.

**Returns:**
java.lang.String - string value of enum constant

### FolderComparisonExtension
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums/foldercomparisonextension.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum FolderComparisonExtension extends Enum<FolderComparisonExtension>
```

The FolderComparisonExtension class is an enumeration that represents different file extensions that can be used in folder comparison.

#### Fields

| Field | Description |
| --- | --- |
| HTML | HTML.
 |
| TXT | TXT.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of FolderComparisonExtension to get the enum constant.
 |
| toString() | String representation of FolderComparisonExtension.
 |
##### HTML
```
public static final FolderComparisonExtension HTML
```

HTML.

##### TXT
```
public static final FolderComparisonExtension TXT
```

TXT.

##### values()
```
public static FolderComparisonExtension[] values()
```

**Returns:**
com.groupdocs.comparison.options.enums.FolderComparisonExtension[]
##### valueOf(String name)
```
public static FolderComparisonExtension valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
com.groupdocs.comparison.options.enums.FolderComparisonExtension
##### fromString(String toStringValue)
```
public static FolderComparisonExtension fromString(String toStringValue)
```

Parses string representation of FolderComparisonExtension to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of FolderComparisonExtension
 |

**Returns:**
com.groupdocs.comparison.options.enums.FolderComparisonExtension - FolderComparisonExtension enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of FolderComparisonExtension.

**Returns:**
java.lang.String - string value of enum constant

### MetadataType
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums/metadatatype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum MetadataType extends Enum<MetadataType>
```

Determines from where the result document will take metadata information.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    SaveOptions saveOptions = new SaveOptions();
    saveOptions.setCloneMetadataType(MetadataType.FILE_AUTHOR);

    comparer.compare(resultFile, saveOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| DEFAULT | Metadata will be left as is.
 |
| SOURCE | Metedata will be taken from source document.
 |
| TARGET | Metedata will be taken from target document.
 |
| FILE_AUTHOR | Metedata will be set by user.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of MetadataType to get the enum constant.
 |
| toString() | String representation of MetadataType.
 |
##### DEFAULT
```
public static final MetadataType DEFAULT
```

Metadata will be left as is.

##### SOURCE
```
public static final MetadataType SOURCE
```

Metedata will be taken from source document.

##### TARGET
```
public static final MetadataType TARGET
```

Metedata will be taken from target document.

##### FILE_AUTHOR
```
public static final MetadataType FILE_AUTHOR
```

Metedata will be set by user.

##### values()
```
public static MetadataType[] values()
```

**Returns:**
com.groupdocs.comparison.options.enums.MetadataType[]
##### valueOf(String name)
```
public static MetadataType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MetadataType
##### fromString(String toStringValue)
```
public static MetadataType fromString(String toStringValue)
```

Parses string representation of MetadataType to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of MetadataType
 |

**Returns:**
MetadataType - MetadataType enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of MetadataType.

**Returns:**
java.lang.String - string value of enum constant

### PaperSize
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums/papersize.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PaperSize extends Enum<PaperSize>
```

Represents the paper size options for document comparison.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    CompareOptions compareOptions = new CompareOptions();
    compareOptions.setPaperSize(PaperSize.A6);

    comparer.compare(resultFile, compareOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| DEFAULT | Default paper size.
 |
| A0 | Standard paper size A0 (841mm x 1189mm).
 |
| A1 | Standard paper size A1 (594mm x 841mm).
 |
| A2 | Standard paper size A2 (420mm x 594mm).
 |
| A3 | Standard paper size A3 (297mm x 420mm).
 |
| A4 | Standard paper size A4 (210mm x 297mm).
 |
| A5 | Standard paper size A5 (148mm x 210mm).
 |
| A6 | Standard paper size A6 (105mm x 148mm).
 |
| A7 | Standard paper size A7 (74mm x 105mm).
 |
| A8 | Standard paper size A8 (52mm x 74mm).
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of PaperSize to get the enum constant.
 |
| toString() | String representation of PaperSize.
 |
##### DEFAULT
```
public static final PaperSize DEFAULT
```

Default paper size.

##### A0
```
public static final PaperSize A0
```

Standard paper size A0 (841mm x 1189mm).

##### A1
```
public static final PaperSize A1
```

Standard paper size A1 (594mm x 841mm).

##### A2
```
public static final PaperSize A2
```

Standard paper size A2 (420mm x 594mm).

##### A3
```
public static final PaperSize A3
```

Standard paper size A3 (297mm x 420mm).

##### A4
```
public static final PaperSize A4
```

Standard paper size A4 (210mm x 297mm).

##### A5
```
public static final PaperSize A5
```

Standard paper size A5 (148mm x 210mm).

##### A6
```
public static final PaperSize A6
```

Standard paper size A6 (105mm x 148mm).

##### A7
```
public static final PaperSize A7
```

Standard paper size A7 (74mm x 105mm).

##### A8
```
public static final PaperSize A8
```

Standard paper size A8 (52mm x 74mm).

##### values()
```
public static PaperSize[] values()
```

**Returns:**
com.groupdocs.comparison.options.enums.PaperSize[]
##### valueOf(String name)
```
public static PaperSize valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PaperSize
##### fromString(String toStringValue)
```
public static PaperSize fromString(String toStringValue)
```

Parses string representation of PaperSize to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of PaperSize
 |

**Returns:**
PaperSize - PaperSize enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of PaperSize.

**Returns:**
java.lang.String - string value of enum constant

### PasswordSaveOption
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums/passwordsaveoption.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PasswordSaveOption extends Enum<PasswordSaveOption>
```

Enumerates the options for saving password information in a document during the comparison process.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    CompareOptions compareOptions = new CompareOptions();
    compareOptions.setPasswordSaveOption(PasswordSaveOption.SOURCE);

    comparer.compare(resultFile, compareOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| NONE | Do not save the password.
 |
| SOURCE | Use password from source document.
 |
| TARGET | Use password from target document.
 |
| USER | \* Use password provided by user.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of PasswordSaveOption to get the enum constant.
 |
| toString() | String representation of PasswordSaveOption.
 |
##### NONE
```
public static final PasswordSaveOption NONE
```

Do not save the password.

##### SOURCE
```
public static final PasswordSaveOption SOURCE
```

Use password from source document.

##### TARGET
```
public static final PasswordSaveOption TARGET
```

Use password from target document.

##### USER
```
public static final PasswordSaveOption USER
```

\* Use password provided by user.

##### values()
```
public static PasswordSaveOption[] values()
```

**Returns:**
com.groupdocs.comparison.options.enums.PasswordSaveOption[]
##### valueOf(String name)
```
public static PasswordSaveOption valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PasswordSaveOption
##### fromString(String toStringValue)
```
public static PasswordSaveOption fromString(String toStringValue)
```

Parses string representation of PasswordSaveOption to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of PasswordSaveOption
 |

**Returns:**
PasswordSaveOption - PasswordSaveOption enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of PasswordSaveOption.

**Returns:**
java.lang.String - string value of enum constant

### PreviewFormats
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.enums/previewformats.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PreviewFormats extends Enum<PreviewFormats>
```

Enumerates the supported preview formats for document comparison.
The PreviewFormats enum provides a list of formats that can be used to generate previews of compared documents.

Supported formats include:

* #PNG.PNG - Portable Network Graphics (.png)
* #JPEG.JPEG - Joint Photographic Experts Group (.jpeg)
* #BMP.BMP - Bitmap Picture (.bmp)

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    PreviewOptions previewOptions = new PreviewOptions(
            pageNumber -> Files.newOutputStream(Paths.get(String.format("preview-page_%d.png", pageNumber)))
    );
    previewOptions.setPreviewFormat(PreviewFormats.PNG);

    comparer.getTargets().get(0).generatePreview(previewOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| PNG | PNG - may consume significant disk space or network traffic if the page contains numerous color graphics.
 |
| JPEG | Jpeg - provides faster processing with smaller disk space usage and network traffic, but may result in lower image quality.
 |
| BMP | BMP - offers the best image quality but requires slower processing with higher disk space usage and network traffic.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of PreviewFormats to get the enum constant.
 |
| toString() | String representation of PreviewFormats.
 |
##### PNG
```
public static final PreviewFormats PNG
```

PNG - may consume significant disk space or network traffic if the page contains numerous color graphics. Default preview format.

##### JPEG
```
public static final PreviewFormats JPEG
```

Jpeg - provides faster processing with smaller disk space usage and network traffic, but may result in lower image quality.

##### BMP
```
public static final PreviewFormats BMP
```

BMP - offers the best image quality but requires slower processing with higher disk space usage and network traffic.

##### values()
```
public static PreviewFormats[] values()
```

**Returns:**
com.groupdocs.comparison.options.enums.PreviewFormats[]
##### valueOf(String name)
```
public static PreviewFormats valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PreviewFormats
##### fromString(String toStringValue)
```
public static PreviewFormats fromString(String toStringValue)
```

Parses string representation of PreviewFormats to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of PreviewFormats
 |

**Returns:**
PreviewFormats - PreviewFormats enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of PreviewFormats.

**Returns:**
java.lang.String - string value of enum constant

### com.groupdocs.comparison.options.load
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.load.md

Provides classes and options for configuring loading documents in GroupDocs.Comparison.

The classes in this package are used to load the source and target documents with specific options.
They provide options for specifying document formats, loading password-protected documents,
setting fonts directories and more.

The key class in this package is LoadOptions.
Classes in the package allow you to configure specific options and settings related to different
document formats for accurate and customized document comparison.

For more details on loading and configuring documents using GroupDocs.Comparison,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Allows specifying additional options when loading a document. |

### LoadOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.load/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Allows specifying additional options when loading a document.

Example usage:

````

 final LoadOptions loadOptions = new LoadOptions();
 loadOptions.setPassword("passw");
 loadOptions.setFileType(FileType.PDF);

 try (Comparer comparer = new Comparer(sourceFile, loadOptions)) {
    comparer.add(targetFile);

    comparer.compare(resultFile);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the LoadOptions class.
 |
| LoadOptions(boolean isLoadText) | Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare, not path.
 |
| LoadOptions(String password) | Initializes a new instance of the LoadOptions class with a password to load document.
 |
| LoadOptions(boolean isLoadText, String password) | Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare and a password to load document.
 |
| LoadOptions(FileType fileType) | Initializes a new instance of the LoadOptions class with a type of a file.
 |
#### Methods

| Method | Description |
| --- | --- |
| isLoadText() | Gets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).
 |
| setLoadText(boolean value) | Sets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).
 |
| getPassword() | Gets a password that will be used to load a document.
 |
| setPassword(String value) | Sets a password that should be used to load a document.
 |
| getFontDirectories() | Gets a list of directories where font files to load a document are placed.
 |
| setFontDirectories(List<String> value) | Sets a list of directories where font files to load a document are placed.
 |
| getFileType() | Gets a type of a file that is loading.
 |
| setFileType(FileType value) | Sets a type of a file that is loading.
 |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the LoadOptions class.

##### LoadOptions(boolean isLoadText)
```
public LoadOptions(boolean isLoadText)
```

Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare, not path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isLoadText | boolean | The flag which means that input string is a text to compare, not path
 |

##### LoadOptions(String password)
```
public LoadOptions(String password)
```

Initializes a new instance of the LoadOptions class with a password to load document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password to load document
 |

##### LoadOptions(boolean isLoadText, String password)
```
public LoadOptions(boolean isLoadText, String password)
```

Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare and a password to load document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isLoadText | boolean | The flag which means that input string is a text to compare, not path
 |
| password | java.lang.String | The password to load document
 |

##### LoadOptions(FileType fileType)
```
public LoadOptions(FileType fileType)
```

Initializes a new instance of the LoadOptions class with a type of a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file
 |

##### isLoadText()
```
public boolean isLoadText()
```

Gets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).

**Returns:**
boolean - true if input string is a text to compare, otherwise false

##### setLoadText(boolean value)
```
public void setLoadText(boolean value)
```

Sets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if input string is a text to compare, otherwise false
 |

##### getPassword()
```
public final String getPassword()
```

Gets a password that will be used to load a document.

**Returns:**
java.lang.String - the password to load the document

##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets a password that should be used to load a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The password to load the document
 |

##### getFontDirectories()
```
public List<String> getFontDirectories()
```

Gets a list of directories where font files to load a document are placed.

**Returns:**
java.util.List<java.lang.String> - the list of directories with font files

##### setFontDirectories(List<String> value)
```
public void setFontDirectories(List<String> value)
```

Sets a list of directories where font files to load a document are placed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> | The list of directories with font files
 |

##### getFileType()
```
public FileType getFileType()
```

Gets a type of a file that is loading.

**Returns:**
FileType - the type of the file

##### setFileType(FileType value)
```
public void setFileType(FileType value)
```

Sets a type of a file that is loading.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType | The type of the file
 |

### com.groupdocs.comparison.options.save
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.save.md

Provides classes and options for saving and configuring the output of GroupDocs.Comparison.

The classes in this package are used to save and configure the output document of the comparison process
in GroupDocs.Comparison. They provide options for specifying metadata, output document password, and more.

The key class in this package is SaveOptions.
Classes in this package allow you to configure specific options and settings related to different
output formats for generating the desired output document of the comparison process.

For more details on saving and configuring the output using GroupDocs.Comparison,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| SaveOptions | Allows specifying additional options when saving a document. |

### SaveOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.save/saveoptions.md

**Inheritance:**
java.lang.Object
```
public class SaveOptions
```

Allows specifying additional options when saving a document.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    final SaveOptions saveOptions = new SaveOptions();
    saveOptions.setPassword("passw");

    comparer.compare(resultFile, saveOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of the SaveOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCloneMetadataType() | Gets a strategy of processing metadata saving result document.
 |
| setCloneMetadataType(MetadataType value) | Sets a stragegy of processing metadata saving result document.
 |
| getFileAuthorMetadata() | Gets a metadata object that will be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.
 |
| setFileAuthorMetadata(FileAuthorMetadata value) | Sets a metadata object that should be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.
 |
| getPassword() | Gets a password for result document.
 |
| setPassword(String value) | Sets a password for result document.
 |
| getFolderPath() | Gets a folder path to which result images will be saved.
 |
| setFolderPath(String value) | Sets a folder path to which result images should be saved.
 |
| setFolderPath(Path value) | Sets a folder path to which result images should be saved.
 |
##### SaveOptions()
```
public SaveOptions()
```

Initializes a new instance of the SaveOptions class.

##### getCloneMetadataType()
```
public final MetadataType getCloneMetadataType()
```

Gets a strategy of processing metadata saving result document.
Possible values are in enum MetadataType

**Returns:**
MetadataType - the stragegy of processing metadata

##### setCloneMetadataType(MetadataType value)
```
public final void setCloneMetadataType(MetadataType value)
```

Sets a stragegy of processing metadata saving result document.
Possible values are in enum MetadataType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | MetadataType | The stragegy of processing metadata
 |

##### getFileAuthorMetadata()
```
public final FileAuthorMetadata getFileAuthorMetadata()
```

Gets a metadata object that will be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.

**Returns:**
FileAuthorMetadata - the metadata object

##### setFileAuthorMetadata(FileAuthorMetadata value)
```
public final void setFileAuthorMetadata(FileAuthorMetadata value)
```

Sets a metadata object that should be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileAuthorMetadata | The metadata object
 |

##### getPassword()
```
public final String getPassword()
```

Gets a password for result document.

**Returns:**
java.lang.String - the password

##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets a password for result document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The password
 |

##### getFolderPath()
```
public final String getFolderPath()
```

Gets a folder path to which result images will be saved.
Used for Imaging Comparison only.

**Returns:**
java.lang.String - the folder path to save result images

##### setFolderPath(String value)
```
public final void setFolderPath(String value)
```

Sets a folder path to which result images should be saved.
Used for Imaging Comparison only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The folder path to save result images
 |

##### setFolderPath(Path value)
```
public final void setFolderPath(Path value)
```

Sets a folder path to which result images should be saved.
Used for Imaging Comparison only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.file.Path | The folder path to save result images
 |

### com.groupdocs.comparison.options.style
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.style.md

Provides classes and options for styling and configuring the visual appearance of the document comparison output in GroupDocs.Comparison.

The classes in this package are used to define and customize various styling aspects of the document comparison output, such as colors,
highlighting, underlining, and more. They allow you to control the visual appearance of added, deleted, and modified content in the comparison result.

The key class in this package include StyleSettings.
Classes in the package provide methods and properties to define and configure the style settings for different components and elements of the comparison result.
You can set font styles, colors, highlighting, underlining, and other formatting options to achieve the desired visual representation of the changes.

For more details on styling and configuring the appearance of the document comparison output using GroupDocs.Comparison,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| DiagramMasterSetting | Represents the settings for diagram master comparison. |
| Size | Represents the size of document in comparison. |
| StyleSettings | This class represents style settings for text formatting. |

#### Enumerations

| Enum | Description |
| --- | --- |
| DetalisationLevel | Specifies the level of comparison details. |

### DetalisationLevel
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.style/detalisationlevel.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum DetalisationLevel extends Enum<DetalisationLevel>
```

Specifies the level of comparison details.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    CompareOptions compareOptions = new CompareOptions();
    compareOptions.setDetectStyleChanges(false);
    compareOptions.setDetalisationLevel(DetalisationLevel.HIGH);

    comparer.compare(resultFile, compareOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| LOW | Represents the Low comparison level.
 |
| MIDDLE | Represents the Middle comparison level.
 |
| HIGH | Represents the High comparison level.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of DetalisationLevel to get the enum constant.
 |
| toString() | String representation of DetalisationLevel.
 |
##### LOW
```
public static final DetalisationLevel LOW
```

Represents the Low comparison level.

The "Low" level provides the best speed for comparisons but sacrifices comparison quality.
Comparison is performed per-word.

##### MIDDLE
```
public static final DetalisationLevel MIDDLE
```

Represents the Middle comparison level.

The "Middle" level is a reasonable compromise between comparison speed and quality.
Comparison is performed per-character, but ignoring character case and spaces count.

##### HIGH
```
public static final DetalisationLevel HIGH
```

Represents the High comparison level.

The "High" level is the best comparison quality, but the lowest speed.
Comparison is performed per-character considering character case and spaces count.

##### values()
```
public static DetalisationLevel[] values()
```

**Returns:**
com.groupdocs.comparison.options.style.DetalisationLevel[]
##### valueOf(String name)
```
public static DetalisationLevel valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
DetalisationLevel
##### fromString(String toStringValue)
```
public static DetalisationLevel fromString(String toStringValue)
```

Parses string representation of DetalisationLevel to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of DetalisationLevel
 |

**Returns:**
DetalisationLevel - DetalisationLevel enum constant associated with input string

##### toString()
```
public String toString()
```

String representation of DetalisationLevel.

**Returns:**
java.lang.String - string value of enum constant

### DiagramMasterSetting
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.style/diagrammastersetting.md

**Inheritance:**
java.lang.Object
```
public class DiagramMasterSetting
```

Represents the settings for diagram master comparison.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    final DiagramMasterSetting diagramMasterSetting = new DiagramMasterSetting();
    diagramMasterSetting.setMasterPath(masterFilePath);

    final CompareOptions compareOptions = new CompareOptions();
    compareOptions.setDiagramMasterSetting(diagramMasterSetting);

    comparer.compare(resultFile, compareOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramMasterSetting() | Initializes a new instance of the DiagramMasterSetting class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isUseSourceMaster() | Gets a flag that indicates whether source master path will be used.
 |
| setUseSourceMaster(boolean value) | Gets a flag that indicates whether source master path should be used.
 |
| getMasterPath() | Gets a master path that will be used to render documents.
 |
| setMasterPath(String value) | Sets a master path that should be used to render documents.
 |
##### DiagramMasterSetting()
```
public DiagramMasterSetting()
```

Initializes a new instance of the DiagramMasterSetting class.

##### isUseSourceMaster()
```
public final boolean isUseSourceMaster()
```

Gets a flag that indicates whether source master path will be used.

**Returns:**
boolean - true if source master path will be shown, otherwise false

##### setUseSourceMaster(boolean value)
```
public final void setUseSourceMaster(boolean value)
```

Gets a flag that indicates whether source master path should be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if source master path should be shown, otherwise false
 |

##### getMasterPath()
```
public final String getMasterPath()
```

Gets a master path that will be used to render documents. MasterPath is needed to create a result document from a set of default shapes.

**Returns:**
java.lang.String - path of master document if it is set, otherwise default master path

##### setMasterPath(String value)
```
public final void setMasterPath(String value)
```

Sets a master path that should be used to render documents. MasterPath is needed to create a result document from a set of default shapes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | Path of master document if it is set, otherwise default master path
 |

### Size
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.style/size.md

**Inheritance:**
java.lang.Object
```
public class Size
```

Represents the size of document in comparison.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     final Size originalSize = new Size(100, 200);

     StyleSettings styleSettings = new StyleSettings();
     styleSettings.setOriginalSize(originalSize);

     final CompareOptions compareOptions = new CompareOptions();
     compareOptions.setInsertedItemStyle(styleSettings);

     comparer.compare(resultFile, compareOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Size() | Initializes a new instance of the Size class.
 |
| Size(int width, int height) | Initializes a new instance of the Size class with width and height of a document.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of an original document.
 |
| setWidth(int value) | Sets the width of an original document.
 |
| getHeight() | Gets the height of an original document.
 |
| setHeight(int value) | Sets the height of an original document.
 |
##### Size()
```
public Size()
```

Initializes a new instance of the Size class.

##### Size(int width, int height)
```
public Size(int width, int height)
```

Initializes a new instance of the Size class with width and height of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int |  |
| height | int |  |

##### getWidth()
```
public final int getWidth()
```

Gets the width of an original document.

**Returns:**
int - the width of the document

##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of an original document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the document
 |

##### getHeight()
```
public final int getHeight()
```

Gets the height of an original document.

**Returns:**
int - the height of the document

##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of an original document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the document
 |

### StyleSettings
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.style/stylesettings.md

**Inheritance:**
java.lang.Object
```
public class StyleSettings
```

This class represents style settings for text formatting.

Use this class to customize the font color, highlight color, style attributes (bold, underline, italic, strikethrough),
string separators, original sizes, and word separators for text.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    StyleSettings styleSettings = new StyleSettings();
    styleSettings.setFontColor(Color.GREEN);
    styleSettings.setBold(true);
    styleSettings.setUnderline(true);

    final CompareOptions compareOptions = new CompareOptions();
    compareOptions.setInsertedItemStyle(styleSettings);

    comparer.compare(resultFile, compareOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| StyleSettings() | Initializes a new instance of the StyleSettings class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFontColor() | Gets the font color.
 |
| setFontColor(Color value) | Sets the font color.
 |
| getShapeColor() | Gets the shape color.
 |
| setShapeColor(Color value) | Sets the shape color.
 |
| getHighlightColor() | Gets the highlight color.
 |
| setHighlightColor(Color value) | Sets the highlight color.
 |
| isBold() | Gets a flag that indicates whether the text will be bold or not.
 |
| setBold(boolean value) | Sets a flag that indicates whether the text should be bold or not.
 |
| isUnderline() | Gets a flag that indicates whether the text will be underlined or not.
 |
| setUnderline(boolean value) | Sets a flag that indicates whether the text should be underlined or not.
 |
| isItalic() | Gets a flag that indicates whether the text will be italic or not.
 |
| setItalic(boolean value) | Sets a flag that indicates whether the text should be italic or not.
 |
| isStrikethrough() | Gets a flag that indicates whether the text will be strike through or not.
 |
| setStrikethrough(boolean value) | Sets a flag that indicates whether the text should be strike through or not.
 |
| getStartStringSeparator() | Gets the start string separator.
 |
| setStartStringSeparator(String value) | Sets the start string separator.
 |
| getEndStringSeparator() | Gets the end string separator.
 |
| setEndStringSeparator(String value) | Sets the end string separator.
 |
| getOriginalSize() | Gets the original size of comparing documents.
 |
| setOriginalSize(Size value) | Sets the original size of comparing documents.
 |
| getWordsSeparators() | Gets the word separator chars.
 |
| setWordsSeparators(char[] value) | Sets the word separator chars.
 |
##### StyleSettings()
```
public StyleSettings()
```

Initializes a new instance of the StyleSettings class.

##### getFontColor()
```
public final Color getFontColor()
```

Gets the font color.

**Returns:**
java.awt.Color - the font color.

##### setFontColor(Color value)
```
public final void setFontColor(Color value)
```

Sets the font color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The new font color.
 |

##### getShapeColor()
```
public final Color getShapeColor()
```

Gets the shape color.

**Returns:**
java.awt.Color - the shape color.

##### setShapeColor(Color value)
```
public final void setShapeColor(Color value)
```

Sets the shape color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The new shape color.
 |

##### getHighlightColor()
```
public final Color getHighlightColor()
```

Gets the highlight color.

**Returns:**
java.awt.Color - the highlight color.

##### setHighlightColor(Color value)
```
public final void setHighlightColor(Color value)
```

Sets the highlight color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The new highlight color.
 |

##### isBold()
```
public final boolean isBold()
```

Gets a flag that indicates whether the text will be bold or not.

**Returns:**
boolean - true if the text will be bold, false otherwise.

##### setBold(boolean value)
```
public final void setBold(boolean value)
```

Sets a flag that indicates whether the text should be bold or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the text should be bold, false otherwise.
 |

##### isUnderline()
```
public final boolean isUnderline()
```

Gets a flag that indicates whether the text will be underlined or not.

**Returns:**
boolean - true if the text will be underlined, false otherwise.

##### setUnderline(boolean value)
```
public final void setUnderline(boolean value)
```

Sets a flag that indicates whether the text should be underlined or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the text should be underlined, false otherwise.
 |

##### isItalic()
```
public final boolean isItalic()
```

Gets a flag that indicates whether the text will be italic or not.

**Returns:**
boolean - true if the text will be italic, false otherwise.

##### setItalic(boolean value)
```
public final void setItalic(boolean value)
```

Sets a flag that indicates whether the text should be italic or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the text should be italic, false otherwise.
 |

##### isStrikethrough()
```
public final boolean isStrikethrough()
```

Gets a flag that indicates whether the text will be strike through or not.

**Returns:**
boolean - true if the text will be strike through, false otherwise.

##### setStrikethrough(boolean value)
```
public final void setStrikethrough(boolean value)
```

Sets a flag that indicates whether the text should be strike through or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the text should be strike through, false otherwise.
 |

##### getStartStringSeparator()
```
public final String getStartStringSeparator()
```

Gets the start string separator.

**Returns:**
java.lang.String - the start string separator.

##### setStartStringSeparator(String value)
```
public final void setStartStringSeparator(String value)
```

Sets the start string separator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The new start string separator.
 |

##### getEndStringSeparator()
```
public final String getEndStringSeparator()
```

Gets the end string separator.

**Returns:**
java.lang.String - the end string separator.

##### setEndStringSeparator(String value)
```
public final void setEndStringSeparator(String value)
```

Sets the end string separator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The new end string separator.
 |

##### getOriginalSize()
```
public final Size getOriginalSize()
```

Gets the original size of comparing documents.

**Returns:**
Size - the original size of comparing documents.

##### setOriginalSize(Size value)
```
public final void setOriginalSize(Size value)
```

Sets the original size of comparing documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Size | The new original size of comparing documents.
 |

##### getWordsSeparators()
```
public final char[] getWordsSeparators()
```

Gets the word separator chars.

**Returns:**
char[] - the word separators.

##### setWordsSeparators(char[] value)
```
public final void setWordsSeparators(char[] value)
```

Sets the word separator chars.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char[] | The new word separators.
 |

### com.groupdocs.comparison.options
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options.md

Provides classes and interfaces for configuring various options and settings related to document comparison. These options include comparison settings, load options, save options, style settings, and more. Use these classes to customize the behavior and appearance of the document comparison process.

Key classes in this package:

* CompareOptions - Represents the options for document comparison.
* LoadOptions - Represents the options for loading documents.
* SaveOptions - Represents the options for saving comparison results.
* StyleSettings - Represents style settings for text formatting.

For more details on working with options classes using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| ApplyChangeOptions | Allows updating the list of changes before applying them to the resulting document. |
| CompareOptions | Allows configuring the process of document comparison. |
| FileAuthorMetadata | Allows configuring information about the document's author metadata. |
| GetChangeOptions | Allows configuring filtering for retrieving specific change types from the comparison result. |
| OriginalSize | Represents the original size of a document in a comparison result. |
| PreviewOptions | Provides options for generating document previews in the comparison process. |

### ApplyChangeOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options/applychangeoptions.md

**Inheritance:**
java.lang.Object
```
public class ApplyChangeOptions
```

Allows updating the list of changes before applying them to the resulting document.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();
     ChangeInfo[] changes = comparer.getChanges();
     changes[0].setComparisonAction(ComparisonAction.REJECT);

     final ApplyChangeOptions applyChangeOptions = new ApplyChangeOptions(changes);

     comparer.applyChanges(resultFile, applyChangeOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| ApplyChangeOptions() | Initializes a new instance of the ApplyChangeOptions class.
 |
| ApplyChangeOptions(List<ChangeInfo> changes) | Initializes a new instance of the ApplyChangeOptions class with list of changes.
 |
| ApplyChangeOptions(ChangeInfo[] changes) | Initializes a new instance of the ApplyChangeOptions class with array of changes.
 |
#### Methods

| Method | Description |
| --- | --- |
| getChanges() | Gets an array of changes that must be applied to the resulting document.
 |
| setChanges(ChangeInfo[] value) | Sets an array of changes that must be applied to the resulting document.
 |
| setChanges(List<ChangeInfo> value) | Sets a list of changes that must be applied to the resulting document.
 |
| isSaveOriginalState() | Gets a flag that determines is original state should be saved.
 |
| setSaveOriginalState(boolean saveOriginalState) | Sets a flag that determines is original state should be saved.
 |
##### ApplyChangeOptions()
```
public ApplyChangeOptions()
```

Initializes a new instance of the ApplyChangeOptions class.

##### ApplyChangeOptions(List<ChangeInfo> changes)
```
public ApplyChangeOptions(List<ChangeInfo> changes)
```

Initializes a new instance of the ApplyChangeOptions class with list of changes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| changes | java.util.List<com.groupdocs.comparison.result.ChangeInfo> | The list of changes to be applied
 |

##### ApplyChangeOptions(ChangeInfo[] changes)
```
public ApplyChangeOptions(ChangeInfo[] changes)
```

Initializes a new instance of the ApplyChangeOptions class with array of changes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| changes | ChangeInfo\[\] | The list of changes to be applied
 |

##### getChanges()
```
public final ChangeInfo[] getChanges()
```

Gets an array of changes that must be applied to the resulting document.

**Returns:**
com.groupdocs.comparison.result.ChangeInfo[] - the array of changes to be applied

##### setChanges(ChangeInfo[] value)
```
public final void setChanges(ChangeInfo[] value)
```

Sets an array of changes that must be applied to the resulting document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ChangeInfo\[\] | The array of changes to be applied
 |

##### setChanges(List<ChangeInfo> value)
```
public final void setChanges(List<ChangeInfo> value)
```

Sets a list of changes that must be applied to the resulting document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.comparison.result.ChangeInfo> | The list of changes to be applied
 |

##### isSaveOriginalState()
```
public boolean isSaveOriginalState()
```

Gets a flag that determines is original state should be saved. Default value: false.

**Returns:**
boolean - true if original state should be saved, otherwise false

##### setSaveOriginalState(boolean saveOriginalState)
```
public void setSaveOriginalState(boolean saveOriginalState)
```

Sets a flag that determines is original state should be saved.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveOriginalState | boolean | True if original state should be saved, otherwise false
 |

### CompareOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options/compareoptions.md

**Inheritance:**
java.lang.Object
```
public class CompareOptions
```

Allows configuring the process of document comparison.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     final StyleSettings styleSettings = new StyleSettings();
     styleSettings.setHighlightColor(Color.RED);
     styleSettings.setFontColor(Color.GREEN);
     styleSettings.setUnderline(true);

     CompareOptions compareOptions = new CompareOptions();
     compareOptions.setInsertedItemStyle(styleSettings);

     comparer.compare(resultFile, compareOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| CompareOptions() | Initializes a new instance of the CompareOptions class.
 |
| CompareOptions(StyleSettings insertedItemStyle, StyleSettings deletedItemStyle, StyleSettings changedItemStyle) | Initializes a new instance of the CompareOptions class with settings for different styles.
 |
#### Fields

| Field | Description |
| --- | --- |
| ignoreChangeSettings |  |
#### Methods

| Method | Description |
| --- | --- |
| getIgnoreChangeSettings() | Get settings to ignore changes based on similarity.
 |
| setIgnoreChangeSettings(IgnoreChangeSensitivitySettings ignoreChangeSettings) | Sets settings to ignore changes based on similarity.
 |
| getUserMasterPath() | Gets the path to the user master's template for Diagrams.
 |
| setUserMasterPath(String userMasterPath) | Sets the path to the user master's template for Diagrams.
 |
| getComparisonType() | Gets a type of source and target documents as ComparisonType object so that Comparison will know how to compare them.
 |
| setComparisonType(ComparisonType comparisonType) | Sets a type of source and target documents as ComparisonType object so that Comparison will know how to compare them.
 |
| getPaperSize() | Gets a size of a paper in result document as PaperSize object.
 |
| setPaperSize(PaperSize value) | Sets a size of a paper in result document as PaperSize object.
 |
| getCalculateCoordinatesMode() | Gets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.
 |
| setCalculateCoordinatesMode(CalculateCoordinatesModeEnumeration calculateCoordinatesMode) | Sets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.
 |
| isShowDeletedContent() | Gets a flag that indicates whether to show deleted components in resultant document or not.
 |
| setShowDeletedContent(boolean value) | Sets a flag that indicates whether to show deleted components in resultant document or not.
 |
| isShowInsertedContent() | Gets a flag that indicates whether to show inserted components in resultant document or not.
 |
| setShowInsertedContent(boolean value) | Sets a flag that indicates whether to show inserted components in resultant document or not.
 |
| isGenerateSummaryPage() | Gets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.
 |
| setGenerateSummaryPage(boolean value) | Sets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.
 |
| isExtendedSummaryPage() | Gets a flag that indicates whether to add extended file comparison information to the summary page or not.
 |
| setExtendedSummaryPage(boolean value) | Sets a flag that indicates whether to add extended file comparison information to the summary page or not.
 |
| isShowOnlySummaryPage() | Gets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.
 |
| setShowOnlySummaryPage(boolean value) | Sets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.
 |
| isDetectStyleChanges() | Gets a flag that indicates whether to detect style changes or not.
 |
| setDetectStyleChanges(boolean value) | Sets a flag that indicates whether to detect style changes or not.
 |
| isMarkNestedContent() | Gets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.
 |
| setMarkNestedContent(boolean value) | Sets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.
 |
| isCalculateCoordinates() | Gets a flag that indicates whether to calculate coordinates for changed components.
 |
| setCalculateCoordinates(boolean value) | Sets a flag that indicates whether to calculate coordinates for changed components.
 |
| isHeaderFootersComparison() | Gets a flag that indicates whether to compare header/footer contents.
 |
| setHeaderFootersComparison(boolean value) | Sets a flag that indicates whether to compare header/footer contents.
 |
| getDetalisationLevel() | Gets a level of comparison detalization represented as DetalisationLevel.
 |
| setDetalisationLevel(DetalisationLevel value) | Sets a level of comparison detalization represented as DetalisationLevel.
 |
| isMarkChangedContent() | Gets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.
 |
| setMarkChangedContent(boolean value) | Sets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.
 |
| getInsertedItemStyle() | Gets a style settings that will be applied to inserted items.
 |
| setInsertedItemStyle(StyleSettings value) | Sets a style settings that will be applied to inserted items.
 |
| getDeletedItemStyle() | Gets a style settings that will be applied to deleted items.
 |
| setDeletedItemStyle(StyleSettings value) | Sets a style settings that will be applied to deleted items.
 |
| getChangedItemStyle() | Gets a style settings that will be applied to changed items.
 |
| setChangedItemStyle(StyleSettings value) | Sets a style settings that will be applied to changed items.
 |
| isCompareImagesPdf() | Get a value indicating whether to compare images.
 |
| setCompareImagesPdf(boolean compareImagesPdf) | Set a value indicating whether to compare images.
 |
| getImagesInheritanceMode() | Get a value indicating whether images inheritance mode
 |
| setImagesInheritanceMode(ImagesInheritance imagesInheritanceMode) | Set a value indicating whether to images inheritance mode.
 |
| getSensitivityOfComparison() | Gets a sensitivity of comparison.
 |
| setSensitivityOfComparison(int value) | Sets a sensitivity of comparison.
 |
| setSensitivityOfComparisonForTables(Integer value) | Sets a sensitivity of comparison for tables.
 |
| getSensitivityOfComparisonForTables() | Get a sensitivity of comparison for tables.
 |
| setWordsSeparatorChars(char[] value) | Sets an array of delimiters which will be used to split text into words.
 |
| getPasswordSaveOption() | Gets a password save option represented by PasswordSaveOption object.
 |
| setPasswordSaveOption(PasswordSaveOption value) | Sets a password save option represented by PasswordSaveOption object.
 |
| getOriginalSize() | Gets an original sizes of compared documents represented by OriginalSize object.
 |
| setOriginalSize(OriginalSize value) | Sets an original sizes of compared documents represented by OriginalSize object.
 |
| getDiagramMasterSetting() | Gets a setting of master page for Diagram documents represented by DiagramMasterSetting object.
 |
| setDiagramMasterSetting(DiagramMasterSetting value) | Sets a setting of master page for Diagram documents represented by DiagramMasterSetting object.
 |
| isDirectoryCompare() | Returns a flag that indicates whether directory comparison is enabled.
 |
| setDirectoryCompare(boolean directoryCompare) | Sets a flag that indicates whether directory comparison should be enabled.
 |
| isShowOnlyChanged() | Returns a boolean value that indicates whether only changed items should be displayed.
 |
| setShowOnlyChanged(boolean showOnlyChanged) | Sets the value indicating whether only changed items should be displayed.
 |
| getFolderComparisonExtension() | Gets the format of the resulting folder comparison file.
 |
| setFolderComparisonExtension(FolderComparisonExtension folderComparisonExtension) | Sets the format of the resulting folder comparison file.
 |
##### CompareOptions()
```
public CompareOptions()
```

Initializes a new instance of the CompareOptions class.

##### CompareOptions(StyleSettings insertedItemStyle, StyleSettings deletedItemStyle, StyleSettings changedItemStyle)
```
public CompareOptions(StyleSettings insertedItemStyle, StyleSettings deletedItemStyle, StyleSettings changedItemStyle)
```

Initializes a new instance of the CompareOptions class with settings for different styles.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| insertedItemStyle | StyleSettings | Style settings for inserted items
 |
| deletedItemStyle | StyleSettings | Style settings for deleted items
 |
| changedItemStyle | StyleSettings | Style settings for changed style items
 |

##### ignoreChangeSettings
```
public IgnoreChangeSensitivitySettings ignoreChangeSettings
```

##### getIgnoreChangeSettings()
```
public IgnoreChangeSensitivitySettings getIgnoreChangeSettings()
```

Get settings to ignore changes based on similarity.

**Returns:**
com.groupdocs.comparison.options.IgnoreChangeSensitivitySettings - Settings to ignore changes.

##### setIgnoreChangeSettings(IgnoreChangeSensitivitySettings ignoreChangeSettings)
```
public void setIgnoreChangeSettings(IgnoreChangeSensitivitySettings ignoreChangeSettings)
```

Sets settings to ignore changes based on similarity.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ignoreChangeSettings | com.groupdocs.comparison.options.IgnoreChangeSensitivitySettings | Settings to ignore changes.
 |

##### getUserMasterPath()
```
public String getUserMasterPath()
```

Gets the path to the user master's template for Diagrams.

**Returns:**
java.lang.String - The path to the user master's template for Diagrams.

##### setUserMasterPath(String userMasterPath)
```
public void setUserMasterPath(String userMasterPath)
```

Sets the path to the user master's template for Diagrams.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| userMasterPath | java.lang.String | The path to the user master's template for Diagrams.
 |

##### getComparisonType()
```
public ComparisonType getComparisonType()
```

Gets a type of source and target documents as ComparisonType object so that Comparison will know how to compare them.
When this option is set, LoadOptions.getFileType() option will be omitted.

**Returns:**
ComparisonType - the type of source and target documents

##### setComparisonType(ComparisonType comparisonType)
```
public void setComparisonType(ComparisonType comparisonType)
```

Sets a type of source and target documents as ComparisonType object so that Comparison will know how to compare them.
When this option is set, LoadOptions.setFileType(FileType) option will be omitted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| comparisonType | ComparisonType | The type of source and target documents
 |

##### getPaperSize()
```
public final PaperSize getPaperSize()
```

Gets a size of a paper in result document as PaperSize object.

**Returns:**
PaperSize - the size of a paper in result document

##### setPaperSize(PaperSize value)
```
public final void setPaperSize(PaperSize value)
```

Sets a size of a paper in result document as PaperSize object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PaperSize | The size of a paper in result document
 |

##### getCalculateCoordinatesMode()
```
public CalculateCoordinatesModeEnumeration getCalculateCoordinatesMode()
```

Gets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.

**Returns:**
CalculateCoordinatesModeEnumeration - the calculate coordinates mode

##### setCalculateCoordinatesMode(CalculateCoordinatesModeEnumeration calculateCoordinatesMode)
```
public void setCalculateCoordinatesMode(CalculateCoordinatesModeEnumeration calculateCoordinatesMode)
```

Sets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| calculateCoordinatesMode | CalculateCoordinatesModeEnumeration | The calculate coordinates mode
 |

##### isShowDeletedContent()
```
public final boolean isShowDeletedContent()
```

Gets a flag that indicates whether to show deleted components in resultant document or not.

**Returns:**
boolean - true if deleted components in resultant document will be shown, otherwise false

##### setShowDeletedContent(boolean value)
```
public final void setShowDeletedContent(boolean value)
```

Sets a flag that indicates whether to show deleted components in resultant document or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if deleted components in resultant document should be shown, otherwise false
 |

##### isShowInsertedContent()
```
public final boolean isShowInsertedContent()
```

Gets a flag that indicates whether to show inserted components in resultant document or not.

**Returns:**
boolean - true if inserted components in resultant document should be shown, otherwise false

##### setShowInsertedContent(boolean value)
```
public final void setShowInsertedContent(boolean value)
```

Sets a flag that indicates whether to show inserted components in resultant document or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if inserted components in resultant document should be shown, otherwise false
 |

##### isGenerateSummaryPage()
```
public final boolean isGenerateSummaryPage()
```

Gets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.

**Returns:**
boolean - true if summary page will be added, otherwise false

##### setGenerateSummaryPage(boolean value)
```
public final void setGenerateSummaryPage(boolean value)
```

Sets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if summary page should be added, otherwise false
 |

##### isExtendedSummaryPage()
```
public boolean isExtendedSummaryPage()
```

Gets a flag that indicates whether to add extended file comparison information to the summary page or not.

**Returns:**
boolean - true if extended file comparison information will be added to summary page, otherwise false

##### setExtendedSummaryPage(boolean value)
```
public void setExtendedSummaryPage(boolean value)
```

Sets a flag that indicates whether to add extended file comparison information to the summary page or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if extended file comparison information should be added to summary page, otherwise false
 |

##### isShowOnlySummaryPage()
```
public boolean isShowOnlySummaryPage()
```

Gets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.

**Returns:**
boolean - true if in the resulting document only a page with statistics of detected changes will be left, otherwise false

##### setShowOnlySummaryPage(boolean value)
```
public void setShowOnlySummaryPage(boolean value)
```

Sets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if in the resulting document only a page with statistics of detected changes should be left, otherwise false
 |

##### isDetectStyleChanges()
```
public final boolean isDetectStyleChanges()
```

Gets a flag that indicates whether to detect style changes or not.

**Returns:**
boolean - true if style changes will be detected, otherwise false

##### setDetectStyleChanges(boolean value)
```
public final void setDetectStyleChanges(boolean value)
```

Sets a flag that indicates whether to detect style changes or not.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if style changes should be detected, otherwise false
 |

##### isMarkNestedContent()
```
public final boolean isMarkNestedContent()
```

Gets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.

**Returns:**
boolean - true if the children of the deleted or inserted elements will be marked as deleted or inserted, otherwise false

##### setMarkNestedContent(boolean value)
```
public final void setMarkNestedContent(boolean value)
```

Sets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if the children of the deleted or inserted elements should be marked as deleted or inserted, otherwise false
 |

##### isCalculateCoordinates()
```
public final boolean isCalculateCoordinates()
```

Gets a flag that indicates whether to calculate coordinates for changed components.

**Returns:**
boolean - true if coordinates for changed components will be calculated, otherwise false

##### setCalculateCoordinates(boolean value)
```
public final void setCalculateCoordinates(boolean value)
```

Sets a flag that indicates whether to calculate coordinates for changed components.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if coordinates for changed components should be calculated, otherwise false
 |

##### isHeaderFootersComparison()
```
public final boolean isHeaderFootersComparison()
```

Gets a flag that indicates whether to compare header/footer contents.

**Returns:**
boolean - true if header/footer contents will be compared, otherwise false

##### setHeaderFootersComparison(boolean value)
```
public final void setHeaderFootersComparison(boolean value)
```

Sets a flag that indicates whether to compare header/footer contents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if header/footer contents should be compared, otherwise false
 |

##### getDetalisationLevel()
```
public final DetalisationLevel getDetalisationLevel()
```

Gets a level of comparison detalization represented as DetalisationLevel.
Default value is DetalisationLevel.LOW.

**Returns:**
DetalisationLevel - the level of comparison detalization

##### setDetalisationLevel(DetalisationLevel value)
```
public final void setDetalisationLevel(DetalisationLevel value)
```

Sets a level of comparison detalization represented as DetalisationLevel.
Default value is DetalisationLevel.LOW

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DetalisationLevel | The level of comparison detalization
 |

##### isMarkChangedContent()
```
public final boolean isMarkChangedContent()
```

Gets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.

**Returns:**
boolean - true if frames will be used, otherwise false

##### setMarkChangedContent(boolean value)
```
public final void setMarkChangedContent(boolean value)
```

Sets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | true if frames should be used, otherwise false
 |

##### getInsertedItemStyle()
```
public final StyleSettings getInsertedItemStyle()
```

Gets a style settings that will be applied to inserted items.

**Returns:**
StyleSettings - style settings of inserted items

##### setInsertedItemStyle(StyleSettings value)
```
public final void setInsertedItemStyle(StyleSettings value)
```

Sets a style settings that will be applied to inserted items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | StyleSettings | Style settings of inserted items
 |

##### getDeletedItemStyle()
```
public final StyleSettings getDeletedItemStyle()
```

Gets a style settings that will be applied to deleted items.

**Returns:**
StyleSettings - style settings of deleted items

##### setDeletedItemStyle(StyleSettings value)
```
public final void setDeletedItemStyle(StyleSettings value)
```

Sets a style settings that will be applied to deleted items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | StyleSettings | Style settings of deleted items
 |

##### getChangedItemStyle()
```
public final StyleSettings getChangedItemStyle()
```

Gets a style settings that will be applied to changed items.

**Returns:**
StyleSettings - style settings of changed items

##### setChangedItemStyle(StyleSettings value)
```
public final void setChangedItemStyle(StyleSettings value)
```

Sets a style settings that will be applied to changed items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | StyleSettings | Style settings of changed items
 |

##### isCompareImagesPdf()
```
public boolean isCompareImagesPdf()
```

Get a value indicating whether to compare images.

**Returns:**
boolean - compare images

##### setCompareImagesPdf(boolean compareImagesPdf)
```
public void setCompareImagesPdf(boolean compareImagesPdf)
```

Set a value indicating whether to compare images.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| compareImagesPdf | boolean | Compare images
 |

##### getImagesInheritanceMode()
```
public ImagesInheritance getImagesInheritanceMode()
```

Get a value indicating whether images inheritance mode

**Returns:**
com.groupdocs.comparison.options.enums.ImagesInheritance - compare images

##### setImagesInheritanceMode(ImagesInheritance imagesInheritanceMode)
```
public void setImagesInheritanceMode(ImagesInheritance imagesInheritanceMode)
```

Set a value indicating whether to images inheritance mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imagesInheritanceMode | com.groupdocs.comparison.options.enums.ImagesInheritance | Images inheritance mode
 |

##### getSensitivityOfComparison()
```
public final int getSensitivityOfComparison()
```

Gets a sensitivity of comparison.
The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

* If this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted.
* Min value - 0% =\> The comparison doesn't occur for any length of the common subsequence of two compared object.
* Default value - 75% =\> Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75.
* Max value - 100% =\> The comparison occurs at any length of the common subsequence of two compared objects.

**Returns:**
int - the sensitivity of comparison

##### setSensitivityOfComparison(int value)
```
public final void setSensitivityOfComparison(int value)
```

Sets a sensitivity of comparison.
The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

* If this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted.
* Min value - 0% =\> The comparison doesn't occur for any length of the common subsequence of two compared object.
* Default value - 75% =\> Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75.
* Max value - 100% =\> The comparison occurs at any length of the common subsequence of two compared objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The sensitivity of comparison
 |

##### setSensitivityOfComparisonForTables(Integer value)
```
public void setSensitivityOfComparisonForTables(Integer value)
```

Sets a sensitivity of comparison for tables.
If the value is null, SensitivityOfComparison is used instead. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

* if this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted.
* Min value - 0% =\> The comparison doesn't occur for any length of the common subsequence of two compared object.
* Default value - 75% =\> Comparison occurs, if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75.
* Max value - 100% =\> The comparison occurs at any length of the common subsequence of two compared objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The sensitivity of comparison for tables
 |

##### getSensitivityOfComparisonForTables()
```
public final Integer getSensitivityOfComparisonForTables()
```

Get a sensitivity of comparison for tables.
If the value is null, SensitivityOfComparison is used instead. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

* if this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted.
* Min value - 0% =\> The comparison doesn't occur for any length of the common subsequence of two compared object.
* Default value - 75% =\> Comparison occurs, if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75.
* Max value - 100% =\> The comparison occurs at any length of the common subsequence of two compared objects.

**Returns:**
java.lang.Integer - The sensitivity of comparison for tables

##### setWordsSeparatorChars(char[] value)
```
public final void setWordsSeparatorChars(char[] value)
```

Sets an array of delimiters which will be used to split text into words.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char[] | The array of delimiters to split text into words
 |

##### getPasswordSaveOption()
```
public final PasswordSaveOption getPasswordSaveOption()
```

Gets a password save option represented by PasswordSaveOption object.

**Returns:**
PasswordSaveOption - the password save option

##### setPasswordSaveOption(PasswordSaveOption value)
```
public final void setPasswordSaveOption(PasswordSaveOption value)
```

Sets a password save option represented by PasswordSaveOption object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PasswordSaveOption | The password save option
 |

##### getOriginalSize()
```
public final OriginalSize getOriginalSize()
```

Gets an original sizes of compared documents represented by OriginalSize object.

**Returns:**
OriginalSize - the original size of documents

##### setOriginalSize(OriginalSize value)
```
public final void setOriginalSize(OriginalSize value)
```

Sets an original sizes of compared documents represented by OriginalSize object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | OriginalSize | The original size of documents
 |

##### getDiagramMasterSetting()
```
public final DiagramMasterSetting getDiagramMasterSetting()
```

Gets a setting of master page for Diagram documents represented by DiagramMasterSetting object.

**Returns:**
DiagramMasterSetting - the diagram master page setting

##### setDiagramMasterSetting(DiagramMasterSetting value)
```
public final void setDiagramMasterSetting(DiagramMasterSetting value)
```

Sets a setting of master page for Diagram documents represented by DiagramMasterSetting object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DiagramMasterSetting | The diagram master page setting
 |

##### isDirectoryCompare()
```
public boolean isDirectoryCompare()
```

Returns a flag that indicates whether directory comparison is enabled.

**Returns:**
boolean - true if directory comparison is enabled, otherwise false

##### setDirectoryCompare(boolean directoryCompare)
```
public void setDirectoryCompare(boolean directoryCompare)
```

Sets a flag that indicates whether directory comparison should be enabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| directoryCompare | boolean | true if directory comparison should be enabled, otherwise false
 |

##### isShowOnlyChanged()
```
public boolean isShowOnlyChanged()
```

Returns a boolean value that indicates whether only changed items should be displayed.

**Returns:**
boolean - true if only changed items should be displayed, otherwise false

##### setShowOnlyChanged(boolean showOnlyChanged)
```
public void setShowOnlyChanged(boolean showOnlyChanged)
```

Sets the value indicating whether only changed items should be displayed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| showOnlyChanged | boolean | the boolean value indicating whether only changed items should be displayed
 |

##### getFolderComparisonExtension()
```
public FolderComparisonExtension getFolderComparisonExtension()
```

Gets the format of the resulting folder comparison file.

**Returns:**
com.groupdocs.comparison.options.enums.FolderComparisonExtension - the FolderComparisonExtension representing the format of the resulting folder comparison file

##### setFolderComparisonExtension(FolderComparisonExtension folderComparisonExtension)
```
public void setFolderComparisonExtension(FolderComparisonExtension folderComparisonExtension)
```

Sets the format of the resulting folder comparison file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folderComparisonExtension | com.groupdocs.comparison.options.enums.FolderComparisonExtension | the FolderComparisonExtension representing the format of the resulting folder comparison file
 |

### FileAuthorMetadata
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options/fileauthormetadata.md

**Inheritance:**
java.lang.Object
```
public class FileAuthorMetadata
```

Allows configuring information about the document's author metadata.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     SaveOptions saveOptions = new SaveOptions();
     saveOptions.setCloneMetadataType(MetadataType.FILE_AUTHOR);

     final FileAuthorMetadata fileAuthorMetadata = new FileAuthorMetadata();
     fileAuthorMetadata.setAuthor("Tom");
     fileAuthorMetadata.setCompany("GroupDocs");
     fileAuthorMetadata.setLastSaveBy("Jack");

     saveOptions.setFileAuthorMetadata(fileAuthorMetadata);

     comparer.compare(resultFile, saveOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| FileAuthorMetadata() | Initializes a new instance of the FileAuthorMetadata class.
 |
#### Fields

| Field | Description |
| --- | --- |
| GROUP_DOCS |  |
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of a document.
 |
| setAuthor(String value) | Sets the author of a document.
 |
| getLastSaveBy() | Gets name of a person who saved the document for the last time.
 |
| setLastSaveBy(String value) | Sets name of a person who saved the document for the last time.
 |
| getCompany() | Gets name of a company whose document is.
 |
| setCompany(String value) | Sets name of a company whose document is.
 |
##### FileAuthorMetadata()
```
public FileAuthorMetadata()
```

Initializes a new instance of the FileAuthorMetadata class.

##### GROUP_DOCS
```
public static final String GROUP_DOCS
```

##### getAuthor()
```
public final String getAuthor()
```

Gets the author of a document.

**Returns:**
java.lang.String - the author

##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the author of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author
 |

##### getLastSaveBy()
```
public final String getLastSaveBy()
```

Gets name of a person who saved the document for the last time.

**Returns:**
java.lang.String - the name

##### setLastSaveBy(String value)
```
public final void setLastSaveBy(String value)
```

Sets name of a person who saved the document for the last time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of a person
 |

##### getCompany()
```
public final String getCompany()
```

Gets name of a company whose document is.

**Returns:**
java.lang.String - the name of a company

##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets name of a company whose document is.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of a company
 |

### GetChangeOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options/getchangeoptions.md

**Inheritance:**
java.lang.Object
```
public class GetChangeOptions
```

Allows configuring filtering for retrieving specific change types from the comparison result.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();

     GetChangeOptions getChangeOptions = new GetChangeOptions();

     getChangeOptions.setFilter(ChangeType.DELETED);

     ChangeInfo[] changes = comparer.getChanges(getChangeOptions);
     System.out.println(Arrays.toString(changes));
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| GetChangeOptions() | Initializes a new instance of the GetChangeOptions class.
 |
| GetChangeOptions(ChangeType filter) | Initializes a new instance of the GetChangeOptions class for specified filter type.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFilter() | Gets the filter for retrieving specific change types from the comparison result.
 |
| setFilter(ChangeType value) | Sets the filter for retrieving specific change types from the comparison result.
 |
##### GetChangeOptions()
```
public GetChangeOptions()
```

Initializes a new instance of the GetChangeOptions class.

##### GetChangeOptions(ChangeType filter)
```
public GetChangeOptions(ChangeType filter)
```

Initializes a new instance of the GetChangeOptions class for specified filter type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | ChangeType |  |

##### getFilter()
```
public final ChangeType getFilter()
```

Gets the filter for retrieving specific change types from the comparison result.

**Returns:**
ChangeType - the filter specifying the types of changes to be retrieved.

##### setFilter(ChangeType value)
```
public final void setFilter(ChangeType value)
```

Sets the filter for retrieving specific change types from the comparison result.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ChangeType | The filter specifying the types of changes to be retrieved.
 |

### OriginalSize
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options/originalsize.md

**Inheritance:**
java.lang.Object
```
public class OriginalSize
```

Represents the original size of a document in a comparison result.

The original size includes the dimensions (width and height) of the document's pages.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     CompareOptions compareOptions = new CompareOptions();
     final OriginalSize originalSize = compareOptions.getOriginalSize();
     originalSize.setWidth(480);
     originalSize.setHeight(640);

     comparer.compare(resultFile, compareOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| OriginalSize() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of the document's pages.
 |
| setWidth(int value) | Sets the width of the document's pages.
 |
| getHeight() | Gets the height of the document's pages.
 |
| setHeight(int value) | Sets the height of the document's pages.
 |
##### OriginalSize()
```
public OriginalSize()
```

##### getWidth()
```
public final int getWidth()
```

Gets the width of the document's pages.

**Returns:**
int - the width of the document's pages.

##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the document's pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the document's pages.
 |

##### getHeight()
```
public final int getHeight()
```

Gets the height of the document's pages.

**Returns:**
int - the height of the document's pages.

##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the document's pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the document's pages.
 |

### PreviewOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.options/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Provides options for generating document previews in the comparison process.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {

    PreviewOptions previewOptions = new PreviewOptions(
            pageNumber -> Files.newOutputStream(Paths.get(String.format("preview-page_%d.png", pageNumber)))
    );
    previewOptions.setPreviewFormat(PreviewFormats.PNG);
    previewOptions.setPageNumbers(new int[]{1, 2});

    comparer.getSource().generatePreview(previewOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(Delegates.CreatePageStream createPageStream) | Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream function.
 |
| PreviewOptions(CreatePageStreamFunction createPageStream) | Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction function.
 |
| PreviewOptions(Delegates.CreatePageStream createPageStream, Delegates.ReleasePageStream releasePageStream) | Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream and Delegates.ReleasePageStream function.
 |
| PreviewOptions(CreatePageStreamFunction createPageStream, ReleasePageStreamFunction releasePageStream) | Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction and ReleasePageStreamFunction function.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCreatePageStream() | Gets a function to create output page preview stream.
 |
| setCreatePageStream(Delegates.CreatePageStream createPageStream) | Sets a function to create output page preview stream.
 |
| setCreatePageStream(CreatePageStreamFunction createPageStream) | Sets a function to create output page preview stream.
 |
| getReleasePageStream() | Gets a function to release output page preview stream.
 |
| setReleasePageStream(Delegates.ReleasePageStream releasePageStream) | Gets a function to release output page preview stream.
 |
| setReleasePageStream(ReleasePageStreamFunction releasePageStream) | Sets a function to release output page preview stream.
 |
| getWidth() | Gets the width of the preview images.
 |
| setWidth(int value) | Sets the width of the preview images.
 |
| getHeight() | Gets the height of the preview images.
 |
| setHeight(int value) | Sets the height of the preview images.
 |
| getPageNumbers() | Gets an array of page numbers for which preview images will be generated.
 |
| setPageNumbers(int[] value) | Sets an array of page numbers for which preview images will be generated.
 |
| getPreviewFormat() | Gets a format of preview images.
 |
| setPreviewFormat(PreviewFormats value) | Sets a format of preview images.
 |
##### PreviewOptions(Delegates.CreatePageStream createPageStream)
```
public PreviewOptions(Delegates.CreatePageStream createPageStream)
```

Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream function.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The function to create output page preview stream.
 |

##### PreviewOptions(CreatePageStreamFunction createPageStream)
```
public PreviewOptions(CreatePageStreamFunction createPageStream)
```

Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction function.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStreamFunction | The function to create output page preview stream.
 |

##### PreviewOptions(Delegates.CreatePageStream createPageStream, Delegates.ReleasePageStream releasePageStream)
```
public PreviewOptions(Delegates.CreatePageStream createPageStream, Delegates.ReleasePageStream releasePageStream)
```

Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream and Delegates.ReleasePageStream function.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The function to create output page preview stream.
 |
| releasePageStream | ReleasePageStream | The function to release output page preview stream.
 |

##### PreviewOptions(CreatePageStreamFunction createPageStream, ReleasePageStreamFunction releasePageStream)
```
public PreviewOptions(CreatePageStreamFunction createPageStream, ReleasePageStreamFunction releasePageStream)
```

Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction and ReleasePageStreamFunction function.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStreamFunction | The function to create output page preview stream.
 |
| releasePageStream | ReleasePageStreamFunction | The function to release output page preview stream.
 |

##### getCreatePageStream()
```
public CreatePageStreamFunction getCreatePageStream()
```

Gets a function to create output page preview stream.

**Returns:**
CreatePageStreamFunction - the function to create output page preview stream.

##### setCreatePageStream(Delegates.CreatePageStream createPageStream)
```
public void setCreatePageStream(Delegates.CreatePageStream createPageStream)
```

Sets a function to create output page preview stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The function to create output page preview stream.
 |

##### setCreatePageStream(CreatePageStreamFunction createPageStream)
```
public void setCreatePageStream(CreatePageStreamFunction createPageStream)
```

Sets a function to create output page preview stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStreamFunction | The function to create output page preview stream.
 |

##### getReleasePageStream()
```
public ReleasePageStreamFunction getReleasePageStream()
```

Gets a function to release output page preview stream.

**Returns:**
ReleasePageStreamFunction - the function to release output page preview stream.

##### setReleasePageStream(Delegates.ReleasePageStream releasePageStream)
```
public void setReleasePageStream(Delegates.ReleasePageStream releasePageStream)
```

Gets a function to release output page preview stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| releasePageStream | ReleasePageStream | The function to release output page preview stream.
 |

##### setReleasePageStream(ReleasePageStreamFunction releasePageStream)
```
public void setReleasePageStream(ReleasePageStreamFunction releasePageStream)
```

Sets a function to release output page preview stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| releasePageStream | ReleasePageStreamFunction | The function to release output page preview stream.
 |

##### getWidth()
```
public final int getWidth()
```

Gets the width of the preview images.

**Returns:**
int - the width of the preview images.

##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the preview images.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the preview images.
 |

##### getHeight()
```
public final int getHeight()
```

Gets the height of the preview images.

**Returns:**
int - the height of the preview images.

##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the preview images.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the preview images.
 |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets an array of page numbers for which preview images will be generated.

**Returns:**
int[] - page numbers array

##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Sets an array of page numbers for which preview images will be generated.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | Page numbers array
 |

##### getPreviewFormat()
```
public final PreviewFormats getPreviewFormat()
```

Gets a format of preview images.

**Returns:**
PreviewFormats - preview images format

##### setPreviewFormat(PreviewFormats value)
```
public final void setPreviewFormat(PreviewFormats value)
```

Sets a format of preview images.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PreviewFormats | Preview images format
 |

### com.groupdocs.comparison.result
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result.md

Provides classes and interfaces for working with the result of document comparison. The comparison result includes information about changes, revisions, differences, and other comparison-related data.

Key classes in this package:

* ChangeInfo - Represents information about a specific change in the comparison result.
* PageInfo - Represents information about a page in the comparison result.
* StyleChangeInfo - Represents information about a style change in a compared document.

For more details on working with result of the comparison process using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| ChangeInfo | The ChangeInfo class represents information about a specific change in a document comparison. |
| PageInfo | The PageInfo class represents information about a specific page in a document. |
| Rectangle | The Rectangle class represents changed area on a document. |
| StyleChangeInfo | The StyleChangeInfo class represents information about a style change in a compared document. |

#### Enumerations

| Enum | Description |
| --- | --- |
| ChangeType | The ChangeType enum represents the types of changes that can occur during the document comparison process. |
| ComparisonAction | The ComparisonAction enum represents the actions that can be applied to a change during the document comparison process. |
| FileType | The FileType enum represents the type of a file used in the document comparison process. |

### ChangeInfo
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/changeinfo.md

**Inheritance:**
java.lang.Object
```
public class ChangeInfo
```

The ChangeInfo class represents information about a specific change in a document comparison.

It provides details such as the type of change, the affected area, and the content before and after the change.
Use this class to retrieve information about individual changes within a comparison result.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare(resultFile);
     // Get a list of changes from the comparison result
     ChangeInfo[] changes = comparer.getChanges();
     // Iterate through the changes and retrieve information
     for (ChangeInfo change : changes) {
         ChangeType changeType = change.getType();
         String componentType = change.getComponentType();
         PageInfo pageInfo = change.getPageInfo();
         // Process the change information as needed
         // ...
     }
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| ChangeInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getRow() |  |
| setRow(Integer row) |  |
| getColumn() |  |
| setColumn(Integer column) |  |
| getColumnHeader() |  |
| setColumnHeader(String columnHeader) |  |
| getId() | Gets unique id of the change.
 |
| setId(int value) | Sets unique id of the change.
 |
| getComparisonAction() | Gets the action that will be applied to the change.
 |
| setComparisonAction(ComparisonAction value) | Sets the action that should be applied to the change.
 |
| getPageInfo() | Gets information about the page, on which current change was found.
 |
| setPageInfo(PageInfo value) | Sets information about the page, on which current change was found.
 |
| getBox() | Gets coordinates of changed element on the page.
 |
| setBox(Rectangle value) | Sets coordinates of changed element on the page.
 |
| getText() | Gets text value of the change.
 |
| setText(String value) | Sets text value of the change.
 |
| getStyleChanges() | Gets the list of style changes.
 |
| setStyleChanges(List<StyleChangeInfo> value) | Sets the list of style changes.
 |
| getAuthors() | Gets the list of authors.
 |
| setAuthors(List<String> value) | Sets the list of authors.
 |
| getType() | Gets the type of the change represented by enum ChangeType.
 |
| getTargetText() | Gets changed text from target document.
 |
| setTargetText(String value) | Sets changed text from target document.
 |
| getSourceText() | Gets changed text from source document.
 |
| setSourceText(String value) | Sets changed text from source document.
 |
| getComponentType() | Gets the type of the changed component.
 |
| setComponentType(String value) | Sets the type of the changed component.
 |
| toString() |  |
##### ChangeInfo()
```
public ChangeInfo()
```

##### getRow()
```
public Integer getRow()
```

**Returns:**
java.lang.Integer
##### setRow(Integer row)
```
public void setRow(Integer row)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | java.lang.Integer |  |

##### getColumn()
```
public Integer getColumn()
```

**Returns:**
java.lang.Integer
##### setColumn(Integer column)
```
public void setColumn(Integer column)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | java.lang.Integer |  |

##### getColumnHeader()
```
public String getColumnHeader()
```

**Returns:**
java.lang.String
##### setColumnHeader(String columnHeader)
```
public void setColumnHeader(String columnHeader)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnHeader | java.lang.String |  |

##### getId()
```
public final int getId()
```

Gets unique id of the change.

**Returns:**
int - the id of the change

##### setId(int value)
```
public final void setId(int value)
```

Sets unique id of the change.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The id of the change
 |

##### getComparisonAction()
```
public final ComparisonAction getComparisonAction()
```

Gets the action that will be applied to the change.
Action (ComparisonAction.ACCEPT or ComparisonAction.REJECT) tells comparison what to do with this change.

**Returns:**
ComparisonAction - the action that will be applied to the change

##### setComparisonAction(ComparisonAction value)
```
public final void setComparisonAction(ComparisonAction value)
```

Sets the action that should be applied to the change.
Action (ComparisonAction.ACCEPT or ComparisonAction.REJECT) tells comparison what to do with this change.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ComparisonAction | The action that should be applied to the change
 |

##### getPageInfo()
```
public final PageInfo getPageInfo()
```

Gets information about the page, on which current change was found.

**Returns:**
PageInfo - information about the page

##### setPageInfo(PageInfo value)
```
public final void setPageInfo(PageInfo value)
```

Sets information about the page, on which current change was found.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PageInfo | Information about the page
 |

##### getBox()
```
public final Rectangle getBox()
```

Gets coordinates of changed element on the page.

**Returns:**
Rectangle - coordinates of changed element

##### setBox(Rectangle value)
```
public final void setBox(Rectangle value)
```

Sets coordinates of changed element on the page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rectangle | Coordinates of changed element, not null
 |

##### getText()
```
public final String getText()
```

Gets text value of the change.

**Returns:**
java.lang.String - text value of the change

##### setText(String value)
```
public final void setText(String value)
```

Sets text value of the change.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | Text value of the change
 |

##### getStyleChanges()
```
public final List<StyleChangeInfo> getStyleChanges()
```

Gets the list of style changes.

**Returns:**
java.util.List<com.groupdocs.comparison.result.StyleChangeInfo> - the list of style changes

##### setStyleChanges(List<StyleChangeInfo> value)
```
public final void setStyleChanges(List<StyleChangeInfo> value)
```

Sets the list of style changes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.comparison.result.StyleChangeInfo> | The list of style changes
 |

##### getAuthors()
```
public final List<String> getAuthors()
```

Gets the list of authors.

**Returns:**
java.util.List<java.lang.String> - the list of authors

##### setAuthors(List<String> value)
```
public final void setAuthors(List<String> value)
```

Sets the list of authors.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> | The list of authors
 |

##### getType()
```
public final ChangeType getType()
```

Gets the type of the change represented by enum ChangeType.

**Returns:**
ChangeType - the type of the change

##### getTargetText()
```
public String getTargetText()
```

Gets changed text from target document.

**Returns:**
java.lang.String - the changed text

##### setTargetText(String value)
```
public void setTargetText(String value)
```

Sets changed text from target document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The changed text
 |

##### getSourceText()
```
public String getSourceText()
```

Gets changed text from source document.

**Returns:**
java.lang.String - the changed text

##### setSourceText(String value)
```
public void setSourceText(String value)
```

Sets changed text from source document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The changed text
 |

##### getComponentType()
```
public String getComponentType()
```

Gets the type of the changed component.

**Returns:**
java.lang.String - the type of the changed component

##### setComponentType(String value)
```
public void setComponentType(String value)
```

Sets the type of the changed component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the changed component
 |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### ChangeType
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/changetype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ChangeType extends Enum<ChangeType>
```

The ChangeType enum represents the types of changes that can occur during the document comparison process.

Each constant in this enum represents a specific type of change and provides a human-readable description and a numeric value.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo changeInfo : changes) {
         // Get the ChangeType for a specific change
         final ChangeType changeType = changeInfo.getType();
         // Print the ChangeType information
         System.out.println("Description: " + changeType.toString());
         System.out.println("Value: " + changeType.toInt());
     }
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| NONE | Represents no change.
 |
| MODIFIED | Represents a modified change.
 |
| INSERTED | Represents an inserted change.
 |
| DELETED | Represents a deleted change.
 |
| ADDED | Represents an added change.
 |
| NOT_MODIFIED | Represents a not modified change.
 |
| STYLE_CHANGED | Represents a style changed change.
 |
| RESIZED | Represents a resized change.
 |
| MOVED | Represents a moved change.
 |
| MOVED_AND_RESIZED | Represents a moved and resized change.
 |
| SHIFTED_AND_RESIZED | Represents a shifted and resized change.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of ChangeType to get the enum constant.
 |
| fromInt(int intValue) | Creates new constant of enum ChangeType using provided numeric value.
 |
| toString() | String representation of ChangeType.
 |
| toInt() | Numeric representation of ChangeType.
 |
##### NONE
```
public static final ChangeType NONE
```

Represents no change.

##### MODIFIED
```
public static final ChangeType MODIFIED
```

Represents a modified change.

##### INSERTED
```
public static final ChangeType INSERTED
```

Represents an inserted change.

##### DELETED
```
public static final ChangeType DELETED
```

Represents a deleted change.

##### ADDED
```
public static final ChangeType ADDED
```

Represents an added change.

##### NOT_MODIFIED
```
public static final ChangeType NOT_MODIFIED
```

Represents a not modified change.

##### STYLE_CHANGED
```
public static final ChangeType STYLE_CHANGED
```

Represents a style changed change.

##### RESIZED
```
public static final ChangeType RESIZED
```

Represents a resized change.

##### MOVED
```
public static final ChangeType MOVED
```

Represents a moved change.

##### MOVED_AND_RESIZED
```
public static final ChangeType MOVED_AND_RESIZED
```

Represents a moved and resized change.

##### SHIFTED_AND_RESIZED
```
public static final ChangeType SHIFTED_AND_RESIZED
```

Represents a shifted and resized change.

##### values()
```
public static ChangeType[] values()
```

**Returns:**
com.groupdocs.comparison.result.ChangeType[]
##### valueOf(String name)
```
public static ChangeType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ChangeType
##### fromString(String toStringValue)
```
public static ChangeType fromString(String toStringValue)
```

Parses string representation of ChangeType to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of ChangeType
 |

**Returns:**
ChangeType - ChangeType enum constant associated with input string

##### fromInt(int intValue)
```
public static ChangeType fromInt(int intValue)
```

Creates new constant of enum ChangeType using provided numeric value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| intValue | int | The numeric representation of ChangeType
 |

**Returns:**
ChangeType - ChangeType enum constant associated with numeric value

##### toString()
```
public String toString()
```

String representation of ChangeType.

**Returns:**
java.lang.String - string value of enum constant

##### toInt()
```
public int toInt()
```

Numeric representation of ChangeType.

**Returns:**
int - numeric value of enum constant

### ComparisonAction
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/comparisonaction.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ComparisonAction extends Enum<ComparisonAction>
```

The ComparisonAction enum represents the actions that can be applied to a change during the document comparison process.

Each constant in this enum represents a specific action and provides a human-readable description and a numeric value.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();

     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo changeInfo : changes) {
         if (changeInfo.getId() % 2 == 0) {
             changeInfo.setComparisonAction(ComparisonAction.REJECT);
         }
     }
     comparer.applyChanges(resultFile, changes);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| NONE | Represents no action.
 |
| ACCEPT | Represents an accept action.
 |
| REJECT | Represents a reject action.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromString(String toStringValue) | Parses string representation of ComparisonAction to get the enum constant.
 |
| fromInt(int intValue) | Creates new constant of enum ComparisonAction using provided numeric value.
 |
| toString() | String representation of ComparisonAction.
 |
| toInt() | Numeric representation of ComparisonAction.
 |
##### NONE
```
public static final ComparisonAction NONE
```

Represents no action. The change will have no effect.

##### ACCEPT
```
public static final ComparisonAction ACCEPT
```

Represents an accept action. The change will be visible in the result file.

##### REJECT
```
public static final ComparisonAction REJECT
```

Represents a reject action. The change will be invisible in the result file.

##### values()
```
public static ComparisonAction[] values()
```

**Returns:**
com.groupdocs.comparison.result.ComparisonAction[]
##### valueOf(String name)
```
public static ComparisonAction valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ComparisonAction
##### fromString(String toStringValue)
```
public static ComparisonAction fromString(String toStringValue)
```

Parses string representation of ComparisonAction to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of ComparisonAction
 |

**Returns:**
ComparisonAction - ComparisonAction enum constant associated with input string

##### fromInt(int intValue)
```
public static ComparisonAction fromInt(int intValue)
```

Creates new constant of enum ComparisonAction using provided numeric value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| intValue | int | The numeric representation of ComparisonAction
 |

**Returns:**
ComparisonAction - ComparisonAction enum constant associated with numeric value

##### toString()
```
public String toString()
```

String representation of ComparisonAction.

**Returns:**
java.lang.String - string value of enum constant

##### toInt()
```
public int toInt()
```

Numeric representation of ComparisonAction.

**Returns:**
int - numeric value of enum constant

### FileType
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/filetype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public enum FileType extends Enum<FileType> implements System.IEquatable<FileType>
```

The FileType enum represents the type of a file used in the document comparison process.

It defines different file types such as Word documents, PDF files, and more.
Provides methods to obtain list of all file types supported by GroupDocs.Comparison, detect file type by extension etc.
Use this enum to specify the file type when working with the GroupDocs.Comparison library.

* Learn more about file formats supported by GroupDocs.Comparison: Full list of supported document formats
* Learn more about getting supported file types in Java: How to get supported file formats in Java

Example usage:

````

  // Set the file type to Word document
  final FileType fileType = FileType.DOCX;
  // Perform comparison using the specified file type
  final LoadOptions loadOptions = new LoadOptions(fileType);
  try (Comparer comparer = new Comparer(sourceFile, loadOptions)) {
      comparer.add(targetFile);

      comparer.compare(resultFile, compareOptions);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| UNKNOWN | Unknown type
 |
| AS | ActionScript Programming Language format
 |
| AS3 | ActionScript Programming Language format
 |
| ASM | Assembler Programming Language format
 |
| BAT | Script file in DOS, OS/2 and Microsoft Windows
 |
| CMD | Script file in DOS, OS/2 and Microsoft Windows
 |
| C | C-Based Programming Language format
 |
| H | C-Based header files contain definitions of Functions and Variables
 |
| PDF | Adobe Portable Document format
 |
| DOC | Microsoft Word 97-2003 Document
 |
| DOCM | Microsoft Word Macro-Enabled Document
 |
| DOCX | Microsoft Word Document
 |
| DOT | Microsoft Word 97-2003 Template
 |
| DOTM | Microsoft Word Macro-Enabled Template
 |
| DOTX | Microsoft Word Template
 |
| XLS | Microsoft Excel 97-2003 Worksheet
 |
| XLT | Microsoft Excel template
 |
| XLSX | Microsoft Excel Worksheet
 |
| XLTM | Microsoft Excel macro-enabled template
 |
| XLSB | Microsoft Excel Binary Worksheet
 |
| XLSM | Microsoft Excel Macro-Enabled Worksheet
 |
| POT | Microsoft PowerPoint template
 |
| POTX | Microsoft PowerPoint Template
 |
| POTM | Microsoft PowerPoint Template with support for Macros
 |
| PPS | Microsoft PowerPoint 97-2003 Slide Show
 |
| PPSX | Microsoft PowerPoint Slide Show
 |
| PPTX | Microsoft PowerPoint Presentation
 |
| PPT | Microsoft PowerPoint 97-2003 Presentation
 |
| PPTM | Microsoft PowerPoint Macro-Enabled Presentation
 |
| PPSM | Microsoft PowerPoint Macro-Enabled Slide Show Presentation
 |
| VSDX | Microsoft Visio Drawing
 |
| VSD | Microsoft Visio 2003-2010 Drawing
 |
| VSS | Microsoft Visio 2003-2010 Stencil
 |
| VST | Microsoft Visio 2003-2010 Template
 |
| VDX | Microsoft Visio 2003-2010 XML Drawing
 |
| ONE | Microsoft OneNote Document
 |
| ODT | OpenDocument Text
 |
| ODP | OpenDocument Presentation
 |
| OTP | OpenDocument Presentation Template
 |
| ODS | OpenDocument Spreadsheet
 |
| OTT | OpenDocument Text Template
 |
| RTF | Rich Text Document
 |
| TXT | Plain Text Document
 |
| CSV | Comma Separated Values File
 |
| HTML | HyperText Markup Language
 |
| MHTML | Mime HTML
 |
| MOBI | Mobipocket e-book format
 |
| DCM | Digital Imaging and Communications in Medicine
 |
| DJVU | Deja Vu format
 |
| DWG | Autodesk Design Data Formats
 |
| DXF | AutoCAD Drawing Interchange
 |
| BMP | Bitmap Picture
 |
| GIF | Graphics Interchange Format
 |
| JPEG | Joint Photographic Experts Group
 |
| JPG | Joint Photographic Experts Group
 |
| PNG | Portable Network Graphics
 |
| SVG | Scalar Vector Graphics
 |
| EML | E-mail Message
 |
| EMLX | Apple Mail E-mail File
 |
| MSG | Microsoft Outlook E-mail Message
 |
| CAD | CAD file format
 |
| CPP | C-Based Programming Language format
 |
| CC | C-Based Programming Language format
 |
| CXX | C-Based Programming Language format
 |
| HXX | Header Files that are written in the C++ programming language
 |
| HH | Header information referenced by a C++ source code file
 |
| HPP | Header Files that are written in the C++ programming language
 |
| CMAKE | Tool for managing the build process of software
 |
| CS | CSharp Programming Language format
 |
| CSX | CSharp script file format
 |
| CAKE | CSharp cross-platform build automation system format
 |
| DIFF | Data comparison tool format
 |
| PATCH | List of differences format
 |
| REJ | Rejected files format
 |
| GROOVY | Source code file written in Groovy format
 |
| GVY | Source code file written in Groovy format
 |
| GRADLE | Build-automation system format
 |
| HAML | Markup language for simplified HTML generation
 |
| JS | JavaScript Programming Language format
 |
| ES6 | JavaScript standardised scripting language format
 |
| MJS | Extension for EcmaScript (ES) module files
 |
| PAC | Proxy Auto-Configuration file for JavaScript function format
 |
| JSON | Lightweight format for storing and transporting data
 |
| BOWERRC | Configuration file for package control on the server-side
 |
| JSHINTRC | JavaScript code quality tool
 |
| JSCSRC | JavaScript configuration file format
 |
| WEBMANIFEST | Manifest file includes information about the app
 |
| JSMAP | JSON file that contains information on how to translate code back to source code
 |
| HAR | The HTTP Archive format
 |
| JAVA | Java Programming Language format
 |
| LESS | Dynamic preprocessor style sheet language format
 |
| LOG | Logging keeps a registry of events, processes, messages and communication
 |
| MAKE | Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal
 |
| MK | Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal
 |
| MD | Markdown Language format
 |
| MKD | Markdown Language format
 |
| MDWN | Markdown Language format
 |
| MDOWN | Markdown Language format
 |
| MARKDOWN | Markdown Language format
 |
| MARKDN | Markdown Language format
 |
| MDTXT | Markdown Language format
 |
| MDTEXT | Markdown Language format
 |
| ML | Caml Programming Language format
 |
| MLI | Caml Programming Language format
 |
| OBJC | Objective-C Programming Language format
 |
| OBJCP | Objective-C++ Programming Language format
 |
| PHP | PHP Programming Language format
 |
| PHP4 | PHP Programming Language format
 |
| PHP5 | PHP Programming Language format
 |
| PHTML | Standard file extension for PHP 2 programs format
 |
| CTP | CakePHP Template format
 |
| PL | Perl Programming Language format
 |
| PM | Perl module format
 |
| POD | Perl lightweight markup language format
 |
| T | Perl test file format
 |
| PSGI | Interface between web servers and web applications and frameworks written in the Perl programming
 |
| P6 | Perl Programming Language format
 |
| PL6 | Perl Programming Language format
 |
| PM6 | Perl module format
 |
| NQP | Intermediate language used to build the Rakudo Perl 6 compiler
 |
| PROP | Properties file format
 |
| CFG | Configuration file used for storing settings
 |
| CONF | Configuration file used on Unix and Linux based systems
 |
| DIR | Directory is a location for storing files on computer
 |
| PY | Python Programming Language format
 |
| RPY | Python-based file engine to create and run games
 |
| PYW | Files used in Windows to indicate a script needs to be run
 |
| CPY | Controller Python Script format
 |
| GYP | Build automation tool format
 |
| GYPI | Build automation tool format
 |
| PYI | Python Interface file format
 |
| IPY | IPython Script format
 |
| RST | Lightweight markup language
 |
| RB | Ruby Programming Language format
 |
| ERB | Ruby Programming Language format
 |
| RJS | Ruby Programming Language format
 |
| GEMSPEC | Developer file that specifies the attributes of a RubyGems
 |
| RAKE | Ruby build automation tool
 |
| RU | Rack configuration file format
 |
| PODSPEC | Ruby build settings format
 |
| RBI | Ruby Interface file format
 |
| SASS | Style sheet language format
 |
| SCSS | Style sheet language format
 |
| SCALA | Scala Programming Language format
 |
| SBT | SBT build tool for Scala format
 |
| SC | Scala worksheet format
 |
| SH | Script programmed for bash format
 |
| BASH | Type of interpreter that processes shell commands
 |
| BASHRC | File determines the behavior of interactive shells
 |
| EBUILD | Specialized bash script which automates compilation and installation procedures for software packages
 |
| SQL | Structured Query Language format
 |
| DSQL | Dynamic Structured Query Language format
 |
| VIM | Vim source code file format
 |
| YAML | Human-readable data-serialization language format
 |
| YML | Human-readable data-serialization language format
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromFileNameOrExtension(String value) | Return FileType based on file name or extension
 |
| getSupportedFileTypes() | Gets list of supported file types
 |
| areEquals(FileType left, FileType right) | Checks the equality of provided file types
 |
| areNotEquals(FileType left, FileType right) | Checks are provided file types not equals
 |
| getFileFormat() | Gets text description of the file type
 |
| getExtension() | Gets the extension of the file type
 |
| toString() | Gets string representation of FileType, for example
'PHP Programming Language format (.php)'

 |
##### UNKNOWN
```
public static final FileType UNKNOWN
```

Unknown type

##### AS
```
public static final FileType AS
```

ActionScript Programming Language format

##### AS3
```
public static final FileType AS3
```

ActionScript Programming Language format

##### ASM
```
public static final FileType ASM
```

Assembler Programming Language format

##### BAT
```
public static final FileType BAT
```

Script file in DOS, OS/2 and Microsoft Windows

##### CMD
```
public static final FileType CMD
```

Script file in DOS, OS/2 and Microsoft Windows

##### C
```
public static final FileType C
```

C-Based Programming Language format

##### H
```
public static final FileType H
```

C-Based header files contain definitions of Functions and Variables

##### PDF
```
public static final FileType PDF
```

Adobe Portable Document format

##### DOC
```
public static final FileType DOC
```

Microsoft Word 97-2003 Document

##### DOCM
```
public static final FileType DOCM
```

Microsoft Word Macro-Enabled Document

##### DOCX
```
public static final FileType DOCX
```

Microsoft Word Document

##### DOT
```
public static final FileType DOT
```

Microsoft Word 97-2003 Template

##### DOTM
```
public static final FileType DOTM
```

Microsoft Word Macro-Enabled Template

##### DOTX
```
public static final FileType DOTX
```

Microsoft Word Template

##### XLS
```
public static final FileType XLS
```

Microsoft Excel 97-2003 Worksheet

##### XLT
```
public static final FileType XLT
```

Microsoft Excel template

##### XLSX
```
public static final FileType XLSX
```

Microsoft Excel Worksheet

##### XLTM
```
public static final FileType XLTM
```

Microsoft Excel macro-enabled template

##### XLSB
```
public static final FileType XLSB
```

Microsoft Excel Binary Worksheet

##### XLSM
```
public static final FileType XLSM
```

Microsoft Excel Macro-Enabled Worksheet

##### POT
```
public static final FileType POT
```

Microsoft PowerPoint template

##### POTX
```
public static final FileType POTX
```

Microsoft PowerPoint Template

##### POTM
```
public static final FileType POTM
```

Microsoft PowerPoint Template with support for Macros

##### PPS
```
public static final FileType PPS
```

Microsoft PowerPoint 97-2003 Slide Show

##### PPSX
```
public static final FileType PPSX
```

Microsoft PowerPoint Slide Show

##### PPTX
```
public static final FileType PPTX
```

Microsoft PowerPoint Presentation

##### PPT
```
public static final FileType PPT
```

Microsoft PowerPoint 97-2003 Presentation

##### PPTM
```
public static final FileType PPTM
```

Microsoft PowerPoint Macro-Enabled Presentation

##### PPSM
```
public static final FileType PPSM
```

Microsoft PowerPoint Macro-Enabled Slide Show Presentation

##### VSDX
```
public static final FileType VSDX
```

Microsoft Visio Drawing

##### VSD
```
public static final FileType VSD
```

Microsoft Visio 2003-2010 Drawing

##### VSS
```
public static final FileType VSS
```

Microsoft Visio 2003-2010 Stencil

##### VST
```
public static final FileType VST
```

Microsoft Visio 2003-2010 Template

##### VDX
```
public static final FileType VDX
```

Microsoft Visio 2003-2010 XML Drawing

##### ONE
```
public static final FileType ONE
```

Microsoft OneNote Document

##### ODT
```
public static final FileType ODT
```

OpenDocument Text

##### ODP
```
public static final FileType ODP
```

OpenDocument Presentation

##### OTP
```
public static final FileType OTP
```

OpenDocument Presentation Template

##### ODS
```
public static final FileType ODS
```

OpenDocument Spreadsheet

##### OTT
```
public static final FileType OTT
```

OpenDocument Text Template

##### RTF
```
public static final FileType RTF
```

Rich Text Document

##### TXT
```
public static final FileType TXT
```

Plain Text Document

##### CSV
```
public static final FileType CSV
```

Comma Separated Values File

##### HTML
```
public static final FileType HTML
```

HyperText Markup Language

##### MHTML
```
public static final FileType MHTML
```

Mime HTML

##### MOBI
```
public static final FileType MOBI
```

Mobipocket e-book format

##### DCM
```
public static final FileType DCM
```

Digital Imaging and Communications in Medicine

##### DJVU
```
public static final FileType DJVU
```

Deja Vu format

##### DWG
```
public static final FileType DWG
```

Autodesk Design Data Formats

##### DXF
```
public static final FileType DXF
```

AutoCAD Drawing Interchange

##### BMP
```
public static final FileType BMP
```

Bitmap Picture

##### GIF
```
public static final FileType GIF
```

Graphics Interchange Format

##### JPEG
```
public static final FileType JPEG
```

Joint Photographic Experts Group

##### JPG
```
public static final FileType JPG
```

Joint Photographic Experts Group

##### PNG
```
public static final FileType PNG
```

Portable Network Graphics

##### SVG
```
public static final FileType SVG
```

Scalar Vector Graphics

##### EML
```
public static final FileType EML
```

E-mail Message

##### EMLX
```
public static final FileType EMLX
```

Apple Mail E-mail File

##### MSG
```
public static final FileType MSG
```

Microsoft Outlook E-mail Message

##### CAD
```
public static final FileType CAD
```

CAD file format

##### CPP
```
public static final FileType CPP
```

C-Based Programming Language format

##### CC
```
public static final FileType CC
```

C-Based Programming Language format

##### CXX
```
public static final FileType CXX
```

C-Based Programming Language format

##### HXX
```
public static final FileType HXX
```

Header Files that are written in the C++ programming language

##### HH
```
public static final FileType HH
```

Header information referenced by a C++ source code file

##### HPP
```
public static final FileType HPP
```

Header Files that are written in the C++ programming language

##### CMAKE
```
public static final FileType CMAKE
```

Tool for managing the build process of software

##### CS
```
public static final FileType CS
```

CSharp Programming Language format

##### CSX
```
public static final FileType CSX
```

CSharp script file format

##### CAKE
```
public static final FileType CAKE
```

CSharp cross-platform build automation system format

##### DIFF
```
public static final FileType DIFF
```

Data comparison tool format

##### PATCH
```
public static final FileType PATCH
```

List of differences format

##### REJ
```
public static final FileType REJ
```

Rejected files format

##### GROOVY
```
public static final FileType GROOVY
```

Source code file written in Groovy format

##### GVY
```
public static final FileType GVY
```

Source code file written in Groovy format

##### GRADLE
```
public static final FileType GRADLE
```

Build-automation system format

##### HAML
```
public static final FileType HAML
```

Markup language for simplified HTML generation

##### JS
```
public static final FileType JS
```

JavaScript Programming Language format

##### ES6
```
public static final FileType ES6
```

JavaScript standardised scripting language format

##### MJS
```
public static final FileType MJS
```

Extension for EcmaScript (ES) module files

##### PAC
```
public static final FileType PAC
```

Proxy Auto-Configuration file for JavaScript function format

##### JSON
```
public static final FileType JSON
```

Lightweight format for storing and transporting data

##### BOWERRC
```
public static final FileType BOWERRC
```

Configuration file for package control on the server-side

##### JSHINTRC
```
public static final FileType JSHINTRC
```

JavaScript code quality tool

##### JSCSRC
```
public static final FileType JSCSRC
```

JavaScript configuration file format

##### WEBMANIFEST
```
public static final FileType WEBMANIFEST
```

Manifest file includes information about the app

##### JSMAP
```
public static final FileType JSMAP
```

JSON file that contains information on how to translate code back to source code

##### HAR
```
public static final FileType HAR
```

The HTTP Archive format

##### JAVA
```
public static final FileType JAVA
```

Java Programming Language format

##### LESS
```
public static final FileType LESS
```

Dynamic preprocessor style sheet language format

##### LOG
```
public static final FileType LOG
```

Logging keeps a registry of events, processes, messages and communication

##### MAKE
```
public static final FileType MAKE
```

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

##### MK
```
public static final FileType MK
```

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

##### MD
```
public static final FileType MD
```

Markdown Language format

##### MKD
```
public static final FileType MKD
```

Markdown Language format

##### MDWN
```
public static final FileType MDWN
```

Markdown Language format

##### MDOWN
```
public static final FileType MDOWN
```

Markdown Language format

##### MARKDOWN
```
public static final FileType MARKDOWN
```

Markdown Language format

##### MARKDN
```
public static final FileType MARKDN
```

Markdown Language format

##### MDTXT
```
public static final FileType MDTXT
```

Markdown Language format

##### MDTEXT
```
public static final FileType MDTEXT
```

Markdown Language format

##### ML
```
public static final FileType ML
```

Caml Programming Language format

##### MLI
```
public static final FileType MLI
```

Caml Programming Language format

##### OBJC
```
public static final FileType OBJC
```

Objective-C Programming Language format

##### OBJCP
```
public static final FileType OBJCP
```

Objective-C++ Programming Language format

##### PHP
```
public static final FileType PHP
```

PHP Programming Language format

##### PHP4
```
public static final FileType PHP4
```

PHP Programming Language format

##### PHP5
```
public static final FileType PHP5
```

PHP Programming Language format

##### PHTML
```
public static final FileType PHTML
```

Standard file extension for PHP 2 programs format

##### CTP
```
public static final FileType CTP
```

CakePHP Template format

##### PL
```
public static final FileType PL
```

Perl Programming Language format

##### PM
```
public static final FileType PM
```

Perl module format

##### POD
```
public static final FileType POD
```

Perl lightweight markup language format

##### T
```
public static final FileType T
```

Perl test file format

##### PSGI
```
public static final FileType PSGI
```

Interface between web servers and web applications and frameworks written in the Perl programming

##### P6
```
public static final FileType P6
```

Perl Programming Language format

##### PL6
```
public static final FileType PL6
```

Perl Programming Language format

##### PM6
```
public static final FileType PM6
```

Perl module format

##### NQP
```
public static final FileType NQP
```

Intermediate language used to build the Rakudo Perl 6 compiler

##### PROP
```
public static final FileType PROP
```

Properties file format

##### CFG
```
public static final FileType CFG
```

Configuration file used for storing settings

##### CONF
```
public static final FileType CONF
```

Configuration file used on Unix and Linux based systems

##### DIR
```
public static final FileType DIR
```

Directory is a location for storing files on computer

##### PY
```
public static final FileType PY
```

Python Programming Language format

##### RPY
```
public static final FileType RPY
```

Python-based file engine to create and run games

##### PYW
```
public static final FileType PYW
```

Files used in Windows to indicate a script needs to be run

##### CPY
```
public static final FileType CPY
```

Controller Python Script format

##### GYP
```
public static final FileType GYP
```

Build automation tool format

##### GYPI
```
public static final FileType GYPI
```

Build automation tool format

##### PYI
```
public static final FileType PYI
```

Python Interface file format

##### IPY
```
public static final FileType IPY
```

IPython Script format

##### RST
```
public static final FileType RST
```

Lightweight markup language

##### RB
```
public static final FileType RB
```

Ruby Programming Language format

##### ERB
```
public static final FileType ERB
```

Ruby Programming Language format

##### RJS
```
public static final FileType RJS
```

Ruby Programming Language format

##### GEMSPEC
```
public static final FileType GEMSPEC
```

Developer file that specifies the attributes of a RubyGems

##### RAKE
```
public static final FileType RAKE
```

Ruby build automation tool

##### RU
```
public static final FileType RU
```

Rack configuration file format

##### PODSPEC
```
public static final FileType PODSPEC
```

Ruby build settings format

##### RBI
```
public static final FileType RBI
```

Ruby Interface file format

##### SASS
```
public static final FileType SASS
```

Style sheet language format

##### SCSS
```
public static final FileType SCSS
```

Style sheet language format

##### SCALA
```
public static final FileType SCALA
```

Scala Programming Language format

##### SBT
```
public static final FileType SBT
```

SBT build tool for Scala format

##### SC
```
public static final FileType SC
```

Scala worksheet format

##### SH
```
public static final FileType SH
```

Script programmed for bash format

##### BASH
```
public static final FileType BASH
```

Type of interpreter that processes shell commands

##### BASHRC
```
public static final FileType BASHRC
```

File determines the behavior of interactive shells

##### EBUILD
```
public static final FileType EBUILD
```

Specialized bash script which automates compilation and installation procedures for software packages

##### SQL
```
public static final FileType SQL
```

Structured Query Language format

##### DSQL
```
public static final FileType DSQL
```

Dynamic Structured Query Language format

##### VIM
```
public static final FileType VIM
```

Vim source code file format

##### YAML
```
public static final FileType YAML
```

Human-readable data-serialization language format

##### YML
```
public static final FileType YML
```

Human-readable data-serialization language format

##### values()
```
public static FileType[] values()
```

**Returns:**
com.groupdocs.comparison.result.FileType[]
##### valueOf(String name)
```
public static FileType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileType
##### fromFileNameOrExtension(String value)
```
public static FileType fromFileNameOrExtension(String value)
```

Return FileType based on file name or extension

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | File name or extension, not null
 |

**Returns:**
FileType - the file type

##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Gets list of supported file types

**Returns:**
java.util.List<com.groupdocs.comparison.result.FileType> - list of FileType

##### areEquals(FileType left, FileType right)
```
public static boolean areEquals(FileType left, FileType right)
```

Checks the equality of provided file types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left FileType object.
 |
| right | FileType | Right FileType object.
 |

**Returns:**
boolean - true if equal, otherwise false

##### areNotEquals(FileType left, FileType right)
```
public static boolean areNotEquals(FileType left, FileType right)
```

Checks are provided file types not equals

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left FileType object.
 |
| right | FileType | Right FileType object.
 |

**Returns:**
boolean - true if not equal, otherwise false

##### getFileFormat()
```
public String getFileFormat()
```

Gets text description of the file type

**Returns:**
java.lang.String - file type descriptiuon

##### getExtension()
```
public String getExtension()
```

Gets the extension of the file type

**Returns:**
java.lang.String - extension of the file type

##### toString()
```
public String toString()
```

Gets string representation of FileType, for example
'PHP Programming Language format (.php)'

**Returns:**
java.lang.String - string representation

### PageInfo
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

The PageInfo class represents information about a specific page in a document.

It provides details such as the page number, width, height, and other relevant properties.
Use this class to retrieve information about individual pages in a document during the comparison process.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare(resultFile);
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo change : changes) {
         final PageInfo pageInfo = change.getPageInfo();
         // Print the page information
         System.out.println("Page Number: " + pageInfo.getPageNumber());
         System.out.println("Page Width: " + pageInfo.getWidth());
         System.out.println("Page Height: " + pageInfo.getHeight());
     }
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo(int pageNumber, int width, int height) | Initializes a new instance of the PageInfo class with configuring pageNumber, width and height.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of the page
 |
| setWidth(int value) | Sets the width of the page
 |
| getHeight() | Gets the height of the page
 |
| setHeight(int value) | Sets the height of the page
 |
| getPageNumber() | Gets the number of the page
 |
| setPageNumber(int value) | Sets the number of the page
 |
| toString() |  |
##### PageInfo(int pageNumber, int width, int height)
```
public PageInfo(int pageNumber, int width, int height)
```

Initializes a new instance of the PageInfo class with configuring pageNumber, width and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page
 |
| width | int | The width of the page
 |
| height | int | The height of the page
 |

##### getWidth()
```
public final int getWidth()
```

Gets the width of the page

**Returns:**
int - the width of the page

##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the page

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the page
 |

##### getHeight()
```
public final int getHeight()
```

Gets the height of the page

**Returns:**
int - the height of the page

##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the page

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the page
 |

##### getPageNumber()
```
public final int getPageNumber()
```

Gets the number of the page

**Returns:**
int - the number of the page

##### setPageNumber(int value)
```
public final void setPageNumber(int value)
```

Sets the number of the page

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of the page
 |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### Rectangle
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/rectangle.md

**Inheritance:**
java.lang.Object
```
public final class Rectangle
```

The Rectangle class represents changed area on a document.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare(resultFile);
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo change : changes) {
         final Rectangle box = change.getBox();
         // Print the changed area on page
         System.out.println("Changed area on a page: "
                 + box.getX() + ", " + box.getY() + ", " + box.getWidth() + ", " + box.getHeight());
     }
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Rectangle() | Initializes a new instance of the Rectangle class.
 |
| Rectangle(Rectangle other) | Creates a new Rectangle object that is a copy of the specified rectangle.
 |
| Rectangle(double x, double y, double width, double height) | Creates a new instance of the Rectangle class with the specified x, y, width, and height.
 |
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets the height of the rectangle.
 |
| setHeight(double value) | Sets the height of the rectangle.
 |
| getWidth() | Gets the width of the rectangle.
 |
| setWidth(double value) | Sets the width of the rectangle.
 |
| getX() | Gets the x-coordinate of the top-left corner of the rectangle.
 |
| setX(double value) | Sets the x-coordinate of the top-left corner of the rectangle.
 |
| getY() | Gets the y-coordinate of the top-left corner of the rectangle.
 |
| setY(double value) | Sets the y-coordinate of the top-left corner of the rectangle.
 |
| equals(Object o) | {@inheritDoc}
 |
| hashCode() | {@inheritDoc}
 |
| toString() | {@inheritDoc}
 |
##### Rectangle()
```
public Rectangle()
```

Initializes a new instance of the Rectangle class.

##### Rectangle(Rectangle other)
```
public Rectangle(Rectangle other)
```

Creates a new Rectangle object that is a copy of the specified rectangle.

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Rectangle | The rectangle to be copied
 |

##### Rectangle(double x, double y, double width, double height)
```
public Rectangle(double x, double y, double width, double height)
```

Creates a new instance of the Rectangle class with the specified x, y, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| x | double | The x-coordinate of the top-left corner of the rectangle
 |
| y | double | The y-coordinate of the top-left corner of the rectangle
 |
| width | double | The width of the rectangle
 |
| height | double | The height of the rectangle
 |

##### getHeight()
```
public double getHeight()
```

Gets the height of the rectangle.

**Returns:**
double - the height of the rectangle

##### setHeight(double value)
```
public void setHeight(double value)
```

Sets the height of the rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The height of the rectangle
 |

##### getWidth()
```
public double getWidth()
```

Gets the width of the rectangle.

**Returns:**
double - the width of the rectangle

##### setWidth(double value)
```
public void setWidth(double value)
```

Sets the width of the rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The width of the rectangle
 |

##### getX()
```
public double getX()
```

Gets the x-coordinate of the top-left corner of the rectangle.

**Returns:**
double - the x-coordinate of the top-left corner of the rectangle

##### setX(double value)
```
public void setX(double value)
```

Sets the x-coordinate of the top-left corner of the rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The x-coordinate of the top-left corner of the rectangle
 |

##### getY()
```
public double getY()
```

Gets the y-coordinate of the top-left corner of the rectangle.

**Returns:**
double - the y-coordinate of the top-left corner of the rectangle

##### setY(double value)
```
public void setY(double value)
```

Sets the y-coordinate of the top-left corner of the rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The y-coordinate of the top-left corner of the rectangle
 |

##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### StyleChangeInfo
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.result/stylechangeinfo.md

**Inheritance:**
java.lang.Object
```
public class StyleChangeInfo
```

The StyleChangeInfo class represents information about a style change in a compared document.

It provides details such as the changed property name, values before and after the change, and so on.
Use this class to retrieve information about style changes during the document comparison process.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare();
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo change : changes) {
         // Access the style change information
         final List styleChanges = change.getStyleChanges();
         for (StyleChangeInfo styleChange : styleChanges) {
             // Print the style change information
             System.out.println("PropertyName: " + styleChange.getPropertyName());
             System.out.println("OldValue: " + styleChange.getOldValue());
             System.out.println("NewValue: " + styleChange.getNewValue());
         }
     }
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| StyleChangeInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPropertyName() | Gets the name of the property that was changed.
 |
| setPropertyName(String value) | Sets the name of the property that was changed.
 |
| getNewValue() | Gets the new value of the property.
 |
| setNewValue(Object value) | Sets the new value of the property.
 |
| getOldValue() | Gets the old value of the property.
 |
| setOldValue(Object value) | Sets the old value of the property.
 |
| equals(Object o) | {@inheritDoc}
 |
| hashCode() | {@inheritDoc}
 |
##### StyleChangeInfo()
```
public StyleChangeInfo()
```

##### getPropertyName()
```
public final String getPropertyName()
```

Gets the name of the property that was changed.

**Returns:**
java.lang.String - the property name

##### setPropertyName(String value)
```
public final void setPropertyName(String value)
```

Sets the name of the property that was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The property name
 |

##### getNewValue()
```
public final Object getNewValue()
```

Gets the new value of the property.

**Returns:**
java.lang.Object - the new value of the property

##### setNewValue(Object value)
```
public final void setNewValue(Object value)
```

Sets the new value of the property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | The new value of the property
 |

##### getOldValue()
```
public final Object getOldValue()
```

Gets the old value of the property.

**Returns:**
java.lang.Object - the old value of the property

##### setOldValue(Object value)
```
public final void setOldValue(Object value)
```

Sets the old value of the property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | The old value of the property
 |

##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### com.groupdocs.comparison.utils
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.utils.md

### com.groupdocs.comparison.words.revision
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.words.revision.md

Provides classes and interfaces for representing revisions and tracked changes in Word documents during the comparison process in GroupDocs.Comparison for Java.

The classes in this package are used to represent revisions and tracked changes made to Word documents during the comparison process.
These revisions include insertions, deletions, formatting changes, and other modifications to the document content.

The key classes in this package include RevisionHandler,
RevisionAction, and RevisionInfo.

By using the classes and interfaces in this package, you can access, analyze, and manipulate revisions and tracked changes in Word documents.

For more details on working with revisions and tracked changes in Word documents using GroupDocs.Comparison for Java,
please refer to the GroupDocs.Comparison Documentation.

#### Classes

| Class | Description |
| --- | --- |
| ApplyRevisionOptions | The ApplyRevisionOptions class allows you to update the state of revisions before they are applied to the final document. |
| RevisionHandler | Represents a class that controls the handling of revisions. |
| RevisionInfo | Represents a revision in the document. |

#### Enumerations

| Enum | Description |
| --- | --- |
| RevisionAction | Represents an action that can be applied to a revision. |
| RevisionType | Represents the types of revisions in a document. |

### ApplyRevisionOptions
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.words.revision/applyrevisionoptions.md

**Inheritance:**
java.lang.Object
```
public class ApplyRevisionOptions
```

The ApplyRevisionOptions class allows you to update the state of revisions before they are applied to the final document.

It provides various constructors and properties to customize the revision application process.

Example usage:

````

 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         if (revisionInfo.getType() == RevisionType.DELETION)
             // Set an action to be applied to the revision
             revisionInfo.setAction(RevisionAction.Accept);
     }
     // Create an instance of ApplyRevisionOptions
     ApplyRevisionOptions revisionChanges = new ApplyRevisionOptions();
     revisionChanges.setChanges(revisionList);
     // Apply the revisions using the options
     revisionHandler.applyRevisionChanges(resultFile, revisionChanges);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| ApplyRevisionOptions() | Initializes a new instance of the ApplyRevisionOptions class.
 |
| ApplyRevisionOptions(List<RevisionInfo> changes) | Instantiates a new ApplyRevisionOptions object with the specified list of revisions.
 |
| ApplyRevisionOptions(List<RevisionInfo> changes, RevisionAction revisionAction) | Instantiates a new ApplyRevisionOptions object with the specified list of revisions and a common revision action.
 |
| ApplyRevisionOptions(RevisionAction revisionAction) | Instantiates a new ApplyRevisionOptions object with a common revision action.
 |
#### Methods

| Method | Description |
| --- | --- |
| getChanges() | Gets the list of revisions to be applied.
 |
| setChanges(List<RevisionInfo> changes) | Sets the list of revisions to be applied.
 |
| getCommonHandler() | Gets the common revision action to be applied to all revisions.
 |
| setCommonHandler(RevisionAction commonHandler) | Sets the common revision action to be applied to all revisions.
 |
##### ApplyRevisionOptions()
```
public ApplyRevisionOptions()
```

Initializes a new instance of the ApplyRevisionOptions class.

##### ApplyRevisionOptions(List<RevisionInfo> changes)
```
public ApplyRevisionOptions(List<RevisionInfo> changes)
```

Instantiates a new ApplyRevisionOptions object with the specified list of revisions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| changes | java.util.List<com.groupdocs.comparison.words.revision.RevisionInfo> | The list of revisions to be applied
 |

##### ApplyRevisionOptions(List<RevisionInfo> changes, RevisionAction revisionAction)
```
public ApplyRevisionOptions(List<RevisionInfo> changes, RevisionAction revisionAction)
```

Instantiates a new ApplyRevisionOptions object with the specified list of revisions and a common revision action.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| changes | java.util.List<com.groupdocs.comparison.words.revision.RevisionInfo> | The list of revisions to be applied
 |
| revisionAction | RevisionAction | The common revision action to be applied to all revisions
 |

##### ApplyRevisionOptions(RevisionAction revisionAction)
```
public ApplyRevisionOptions(RevisionAction revisionAction)
```

Instantiates a new ApplyRevisionOptions object with a common revision action.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| revisionAction | RevisionAction | The common revision action to be applied to all revisions
 |

##### getChanges()
```
public List<RevisionInfo> getChanges()
```

Gets the list of revisions to be applied.

**Returns:**
java.util.List<com.groupdocs.comparison.words.revision.RevisionInfo> - the list of revisions

##### setChanges(List<RevisionInfo> changes)
```
public void setChanges(List<RevisionInfo> changes)
```

Sets the list of revisions to be applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| changes | java.util.List<com.groupdocs.comparison.words.revision.RevisionInfo> | The list of revisions
 |

##### getCommonHandler()
```
public RevisionAction getCommonHandler()
```

Gets the common revision action to be applied to all revisions.

**Returns:**
RevisionAction - the common revision action

##### setCommonHandler(RevisionAction commonHandler)
```
public void setCommonHandler(RevisionAction commonHandler)
```

Sets the common revision action to be applied to all revisions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| commonHandler | RevisionAction | The common revision action
 |

### RevisionAction
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.words.revision/revisionaction.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum RevisionAction extends Enum<RevisionAction>
```

Represents an action that can be applied to a revision.

Example usage:

````

 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         if (revisionInfo.getType() == RevisionType.DELETION)
             // Set an action to be applied to the revision
             revisionInfo.setAction(RevisionAction.Accept);
     }
     // Create an instance of ApplyRevisionOptions
     ApplyRevisionOptions revisionChanges = new ApplyRevisionOptions();
     revisionChanges.setChanges(revisionList);
     // Apply the revisions using the options
     revisionHandler.applyRevisionChanges(resultFile, revisionChanges);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| NONE | Indicates that no action is to be taken.
 |
| ACCEPT | Indicates that the revision will be displayed if it is of type INSERTION, or it will be removed if the type is DELETION.
 |
| REJECT | Indicates that the revision will be removed if it is of type INSERTION, or it will be displayed if the type is DELETION.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### NONE
```
public static final RevisionAction NONE
```

Indicates that no action is to be taken.

##### ACCEPT
```
public static final RevisionAction ACCEPT
```

Indicates that the revision will be displayed if it is of type INSERTION, or it will be removed if the type is DELETION.

##### REJECT
```
public static final RevisionAction REJECT
```

Indicates that the revision will be removed if it is of type INSERTION, or it will be displayed if the type is DELETION.

##### values()
```
public static RevisionAction[] values()
```

**Returns:**
com.groupdocs.comparison.words.revision.RevisionAction[]
##### valueOf(String name)
```
public static RevisionAction valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
RevisionAction

### RevisionHandler
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.words.revision/revisionhandler.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class RevisionHandler implements Closeable
```

Represents a class that controls the handling of revisions.

The RevisionHandler class allows you to work with revisions in documents.
It provides methods to retrieve the list of revisions, apply changes to revisions, and save the modified document.

Example usage:

````

 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         if (revisionInfo.getType() == RevisionType.DELETION)
             // Set an action to be applied to the revision
             revisionInfo.setAction(RevisionAction.Accept);
     }
     // Create an instance of ApplyRevisionOptions
     ApplyRevisionOptions revisionChanges = new ApplyRevisionOptions();
     revisionChanges.setChanges(revisionList);
     // Apply the revisions using the options
     revisionHandler.applyRevisionChanges(resultFile, revisionChanges);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| RevisionHandler(String filePath) | Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.
 |
| RevisionHandler(Path filePath) | Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.
 |
| RevisionHandler(InputStream file, FileType fileType) | Initializes a new instance of the RevisionHandler class with a file stream containing revisions.
 |
| RevisionHandler(Document document) | Initializes a new instance of the RevisionHandler class with a document.
 |
#### Fields

| Field | Description |
| --- | --- |
| SOURCE_PATH_IS_NULL |  |
#### Methods

| Method | Description |
| --- | --- |
| getRevisions() | Gets the list of all revisions.
 |
| applyRevisionChanges(ApplyRevisionOptions changes) | Processes changes in revisions and applies them to the original file.
 |
| applyRevisionChanges(Path filePath, ApplyRevisionOptions changes) | Processes changes in revisions and writes the result to the specified file.
 |
| applyRevisionChanges(String filePath, ApplyRevisionOptions changes) | Processes changes in revisions and writes the result to the specified file.
 |
| applyRevisionChanges(OutputStream outputStream, ApplyRevisionOptions changes) | Processes changes in revisions and writes the result to the document stream.
 |
| close() |  |
##### RevisionHandler(String filePath)
```
public RevisionHandler(String filePath)
```

Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |

##### RevisionHandler(Path filePath)
```
public RevisionHandler(Path filePath)
```

Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file.
 |

##### RevisionHandler(InputStream file, FileType fileType)
```
public RevisionHandler(InputStream file, FileType fileType)
```

Initializes a new instance of the RevisionHandler class with a file stream containing revisions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | java.io.InputStream | The source document stream.
 |
| fileType | FileType | The type of the file.
 |

##### RevisionHandler(Document document)
```
public RevisionHandler(Document document)
```

Initializes a new instance of the RevisionHandler class with a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | com.aspose.words.Document | The document.
 |

##### SOURCE_PATH_IS_NULL
```
public static final String SOURCE_PATH_IS_NULL
```

##### getRevisions()
```
public List<RevisionInfo> getRevisions()
```

Gets the list of all revisions.

Due to the fact that revisions were originally sorted in a group, revisions must be taken from a List.
In the List, a single revision can be split into multiple revisions with the same general text.
Since the List may contain revisions with the same general text, this must be controlled when creating a list of revisions for the user.
This is controlled here using List\<RevisionGroup\> groups.

**Returns:**
java.util.List<com.groupdocs.comparison.words.revision.RevisionInfo> - the list of revisions.

##### applyRevisionChanges(ApplyRevisionOptions changes)
```
public void applyRevisionChanges(ApplyRevisionOptions changes)
```

Processes changes in revisions and applies them to the original file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| changes | ApplyRevisionOptions | The list of changed revisions.
 |

##### applyRevisionChanges(Path filePath, ApplyRevisionOptions changes)
```
public void applyRevisionChanges(Path filePath, ApplyRevisionOptions changes)
```

Processes changes in revisions and writes the result to the specified file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The result file path.
 |
| changes | ApplyRevisionOptions | The list of changed revisions.
 |

##### applyRevisionChanges(String filePath, ApplyRevisionOptions changes)
```
public void applyRevisionChanges(String filePath, ApplyRevisionOptions changes)
```

Processes changes in revisions and writes the result to the specified file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The result file path.
 |
| changes | ApplyRevisionOptions | The list of changed revisions.
 |

##### applyRevisionChanges(OutputStream outputStream, ApplyRevisionOptions changes)
```
public void applyRevisionChanges(OutputStream outputStream, ApplyRevisionOptions changes)
```

Processes changes in revisions and writes the result to the document stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | java.io.OutputStream | The result document stream.
 |
| changes | ApplyRevisionOptions | The list of changed revisions.
 |

##### close()
```
public void close()
```

### RevisionInfo
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.words.revision/revisioninfo.md

**Inheritance:**
java.lang.Object
```
public class RevisionInfo
```

Represents a revision in the document.

A revision encapsulates information about revision change made to the document.
This class provides methods to retrieve information about the revision, such as its type,
content, author, and so on.

Example usage:

````

 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         System.out.println("Revision Type: " + revisionInfo.getType());
         System.out.println("Text: " + revisionInfo.getText());
         System.out.println("Author: " + revisionInfo.getAuthor());
     }
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| RevisionInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAction() | Gets the action associated with the revision (accept or reject).
 |
| setAction(RevisionAction value) | Sets the value associated with the revision (accept or reject).
 |
| getText() | Gets the text content of the revision.
 |
| setText(String value) | Sets the value content of the revision.
 |
| getAuthor() | Gets the author of the revision.
 |
| setAuthor(String value) | Sets the value of the revision.
 |
| getType() | Gets the type of the revision, depending on the type the Action (accept or reject) logic changes.
 |
| setType(RevisionType value) | Sets the value of the revision, depending on the value the Action (accept or reject) logic changes.
 |
##### RevisionInfo()
```
public RevisionInfo()
```

##### getAction()
```
public RevisionAction getAction()
```

Gets the action associated with the revision (accept or reject). This field allows you to influence the display of the revision.

**Returns:**
RevisionAction - the action associated with the revision.

##### setAction(RevisionAction value)
```
public void setAction(RevisionAction value)
```

Sets the value associated with the revision (accept or reject). This field allows you to influence the display of the revision.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | RevisionAction | The value associated with the revision.
 |

##### getText()
```
public String getText()
```

Gets the text content of the revision.

**Returns:**
java.lang.String - the text content of the revision.

##### setText(String value)
```
public void setText(String value)
```

Sets the value content of the revision.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value content of the revision.
 |

##### getAuthor()
```
public String getAuthor()
```

Gets the author of the revision.

**Returns:**
java.lang.String - the author of the revision.

##### setAuthor(String value)
```
public void setAuthor(String value)
```

Sets the value of the revision.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the revision.
 |

##### getType()
```
public RevisionType getType()
```

Gets the type of the revision, depending on the type the Action (accept or reject) logic changes.

**Returns:**
RevisionType - the type of the revision.

##### setType(RevisionType value)
```
public void setType(RevisionType value)
```

Sets the value of the revision, depending on the value the Action (accept or reject) logic changes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | RevisionType | The value of the revision.
 |

### RevisionType
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.words.revision/revisiontype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum RevisionType extends Enum<RevisionType>
```

Represents the types of revisions in a document.

Example usage:

````

 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         if (revisionInfo.getType() == RevisionType.DELETION)
             // Set an action to be applied to the revision
             revisionInfo.setAction(RevisionAction.Accept);
     }
     // Create an instance of ApplyRevisionOptions
     ApplyRevisionOptions revisionChanges = new ApplyRevisionOptions();
     revisionChanges.setChanges(revisionList);
     // Apply the revisions using the options
     revisionHandler.applyRevisionChanges(resultFile, revisionChanges);
 }
 
````

#### Fields

| Field | Description |
| --- | --- |
| INSERTION | Represents a type when new content was inserted in the document.
 |
| DELETION | Represents a type when content was removed from the document.
 |
| FORMAT_CHANGE | Represents a type when change of formatting was applied to the parent node.
 |
| STYLE_DEFINITION_CHANGE | Represents a type when change of formatting was applied to the parent style.
 |
| MOVING | Represents a type when content was moved in the document.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromInt(int toIntValue) | Creates new constant of enum RevisionType using provided numeric value.
 |
| fromString(String toStringValue) | Parses string representation of RevisionType to get the enum constant.
 |
| toInt() | Numeric representation of RevisionType.
 |
| toString() | String representation of RevisionType.
 |
##### INSERTION
```
public static final RevisionType INSERTION
```

Represents a type when new content was inserted in the document.

##### DELETION
```
public static final RevisionType DELETION
```

Represents a type when content was removed from the document.

##### FORMAT_CHANGE
```
public static final RevisionType FORMAT_CHANGE
```

Represents a type when change of formatting was applied to the parent node.

##### STYLE_DEFINITION_CHANGE
```
public static final RevisionType STYLE_DEFINITION_CHANGE
```

Represents a type when change of formatting was applied to the parent style.

##### MOVING
```
public static final RevisionType MOVING
```

Represents a type when content was moved in the document.

##### values()
```
public static RevisionType[] values()
```

**Returns:**
com.groupdocs.comparison.words.revision.RevisionType[]
##### valueOf(String name)
```
public static RevisionType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
RevisionType
##### fromInt(int toIntValue)
```
public static RevisionType fromInt(int toIntValue)
```

Creates new constant of enum RevisionType using provided numeric value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toIntValue | int | The numeric representation of RevisionType
 |

**Returns:**
RevisionType - RevisionType enum constant associated with numeric value

##### fromString(String toStringValue)
```
public static RevisionType fromString(String toStringValue)
```

Parses string representation of RevisionType to get the enum constant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| toStringValue | java.lang.String | The string representation of RevisionType
 |

**Returns:**
RevisionType - RevisionType enum constant associated with input string

##### toInt()
```
public int toInt()
```

Numeric representation of RevisionType.

**Returns:**
int - numeric value of enum constant

##### toString()
```
public String toString()
```

String representation of RevisionType.

**Returns:**
java.lang.String - string value of enum constant

### com.groupdocs.comparison
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison.md

The package provides classes to compare documents for all popular document formats.

The Main classes in this package are:

* Comparer is the entry point for comparing documents.
* Document provides details about a document.
* ComparerSettings defines settings for customizing logging behaviour.

The main class of this namespace is Comparer. This class provides methods for adding documents, obtaining changes, comparing documents etc.

#### Classes

| Class | Description |
| --- | --- |
| Comparer | The Comparer class provides functionality for comparing documents and generating comparison results. |
| ComparerSettings | Defines settings for customizing the behavior of the Comparer class. |
| Document | Represents a document for comparison process. |

### Comparer
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison/comparer.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IDisposable, java.io.Closeable
```
public class Comparer implements System.IDisposable, Closeable
```

The Comparer class provides functionality for comparing documents and generating comparison results.

It allows you to compare various types of documents, such as PDF, Word, Excel, PowerPoint, and more.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     CompareOptions compareOptions = new CompareOptions();
     compareOptions.setDetectStyleChanges(true);

     comparer.compare(resultFile, compareOptions);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Comparer(String filePath) | Initializes new instance of Comparer class with the specified source file path.
 |
| Comparer(String filePath, CompareOptions compareOptions) | Initializes a new instance of the Comparer class with the specified folder path and compare options.
 |
| Comparer(Path filePath) | Initializes new instance of Comparer class with the specified source file path.
 |
| Comparer(String filePath, LoadOptions loadOptions) | Initializes new instance of Comparer with the specified source file path and LoadOptions.
 |
| Comparer(Path filePath, LoadOptions loadOptions) | Initializes new instance of Comparer with the specified source file path and LoadOptions.
 |
| Comparer(Path filePath, CompareOptions compareOptions) | Initializes new instance of Comparer with the specified source file path and LoadOptions.
 |
| Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings) | Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
 |
| Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions) | Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
 |
| Comparer(String filePath, ComparerSettings settings) | Initializes new instance of Comparer class with the specified source file path and ComparerSettings.
 |
| Comparer(Path filePath, ComparerSettings settings) | Initializes new instance of Comparer class with the specified source file path and ComparerSettings.
 |
| Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings) | Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
 |
| Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions) | Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
 |
| Comparer(InputStream document) | Initializes new instance of Comparer class with the specified source document stream.
 |
| Comparer(InputStream document, LoadOptions loadOptions) | Initializes new instance of Comparer with the specified source document stream and LoadOptions.
 |
| Comparer(InputStream document, ComparerSettings settings) | Initializes new instance of Comparer class with the specified source document stream and ComparerSettings.
 |
| Comparer(InputStream document, LoadOptions loadOptions, ComparerSettings settings) | Initializes new instance of Comparer class with the specified document stream, LoadOptions and ComparerSettings.
 |
| Comparer(ComparerSettings settings) | Initializes new instance of Comparer class with the specified ComparerSettings.
 |
#### Fields

| Field | Description |
| --- | --- |
| FILE_PATH |  |
#### Methods

| Method | Description |
| --- | --- |
| getSource() | Gets the source document that is being compared.
 |
| getTargets() | List of target documents to compare with source file.
 |
| compare() | Compares the specified file with the target documents without saving result with default options.
 |
| compare(String filePath) | Compares the specified file with the target documents and generates a comparison result.
 |
| compare(Path filePath) | Compares the specified file with the target documents and generates a comparison result.
 |
| compare(OutputStream outputStream) | Compares the specified file with the target documents and writes a comparison result to the output stream.
 |
| compare(String filePath, CompareOptions compareOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| compare(Path filePath, CompareOptions compareOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| compare(OutputStream stream, CompareOptions compareOptions) | Compares the specified file with the target documents and writes a comparison result to the output stream.
 |
| compare(SaveOptions saveOptions, CompareOptions compareOptions) | Compares the specified file with the target documents without saving result.
 |
| compare(String filePath, SaveOptions saveOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| compare(Path filePath, SaveOptions saveOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| compare(OutputStream stream, SaveOptions saveOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| compare(CompareOptions compareOptions) | Compares the specified file with the target documents without saving result.
 |
| compare(OutputStream outputStream, SaveOptions saveOptions, CompareOptions compareOptions) | Compares the specified file with the target documents and writes a comparison result to the provided output stream.
 |
| compare(String filePath, SaveOptions saveOptions, CompareOptions compareOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| compareDirectory(String filePath, CompareOptions compareOptions) | Compares the specified directory with the target directory and saves the comparison result to the provided file path.
 |
| compareDirectory(Path filePath, CompareOptions compareOptions) | Compares the specified directory with the target directory and saves the comparison result to the provided file path.
 |
| compare(Path filePath, SaveOptions saveOptions, CompareOptions compareOptions) | Compares the specified file with the target documents and writes a comparison result to the provided file path.
 |
| add(String filePath) | Adds the specified target document to the comparison process.
 |
| add(String filePath, CompareOptions compareOptions) | Adds the specified target document or folder to the comparison process.
 |
| add(Path filePath) | Adds the specified target document to the comparison process.
 |
| add(String[] filePaths) | Adds the specified target documents to the comparison process.
 |
| add(Path[] filePaths) | Adds the specified target documents to the comparison process.
 |
| add(String filePath, LoadOptions loadOptions) | Adds the specified target document to the comparison process with loading options specified.
 |
| add(Path filePath, LoadOptions loadOptions) | Adds the specified target document to the comparison process with loading options specified.
 |
| add(Path filePath, CompareOptions compareOptions) | Adds the specified target document to the comparison process with loading options specified.
 |
| add(InputStream document) | Adds the specified target document to the comparison process.
 |
| add(InputStream[] documents) | Adds the specified target documents to the comparison process.
 |
| add(InputStream document, LoadOptions loadOptions) | Adds the specified target document to the comparison process with loading options specified.
 |
| getChanges() | Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.
 |
| getChanges(GetChangeOptions getChangeOptions) | Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.
 |
| applyChanges(String filePath, ApplyChangeOptions applyChangeOptions) | Accepts or rejects changes and applies them to result document.
 |
| applyChanges(Path filePath, ApplyChangeOptions applyChangeOptions) | Accepts or rejects changes and applies them to resultant document.
 |
| applyChanges(OutputStream document, ApplyChangeOptions applyChangeOptions) | Accepts or rejects changes and applies them to resultant document.
 |
| applyChanges(String filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions) | Accepts or rejects changes and applies them to resultant document.
 |
| applyChanges(Path filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions) | Accepts or rejects changes and applies them to resultant document.
 |
| applyChanges(OutputStream document, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions) | Accepts or rejects changes and applies them to resultant document.
 |
| getResultString() | Gets result string after comparison (For Text Comparison only).
 |
| getSourceFolder() | Returns the source folder that is being compared.
 |
| getTargetFolder() | Returns the target folder that is being compared.
 |
| selfComparisonCheck(Document source, Document target) | Self-comparison check (e498c23).
 |
| close() | Releases resources.
 |
##### Comparer(String filePath)
```
public Comparer(String filePath)
```

Initializes new instance of Comparer class with the specified source file path.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the source document
 |

##### Comparer(String filePath, CompareOptions compareOptions)
```
public Comparer(String filePath, CompareOptions compareOptions)
```

Initializes a new instance of the Comparer class with the specified folder path and compare options.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the source document or folder
 |
| compareOptions | CompareOptions | The compare options for folder comparison
 |

##### Comparer(Path filePath)
```
public Comparer(Path filePath)
```

Initializes new instance of Comparer class with the specified source file path.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the source document
 |

##### Comparer(String filePath, LoadOptions loadOptions)
```
public Comparer(String filePath, LoadOptions loadOptions)
```

Initializes new instance of Comparer with the specified source file path and LoadOptions.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the source document
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |

##### Comparer(Path filePath, LoadOptions loadOptions)
```
public Comparer(Path filePath, LoadOptions loadOptions)
```

Initializes new instance of Comparer with the specified source file path and LoadOptions.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the source document
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |

##### Comparer(Path filePath, CompareOptions compareOptions)
```
public Comparer(Path filePath, CompareOptions compareOptions)
```

Initializes new instance of Comparer with the specified source file path and LoadOptions.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the source document
 |
| compareOptions | CompareOptions | The compare options for folder comparison
 |

##### Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings)
```
public Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the source document
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |

##### Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions)
```
public Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions)
```

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the source document or folder or text to be compared
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |
| compareOptions | CompareOptions | The compare options for folder comparison
 |

##### Comparer(String filePath, ComparerSettings settings)
```
public Comparer(String filePath, ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified source file path and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the source document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |

##### Comparer(Path filePath, ComparerSettings settings)
```
public Comparer(Path filePath, ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified source file path and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the source document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |

##### Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings)
```
public Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the source document
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |

##### Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions)
```
public Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions)
```

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the source document or folder
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |
| compareOptions | CompareOptions | The compare options for folder comparison
 |

##### Comparer(InputStream document)
```
public Comparer(InputStream document)
```

Initializes new instance of Comparer class with the specified source document stream.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The input stream of the source document
 |

##### Comparer(InputStream document, LoadOptions loadOptions)
```
public Comparer(InputStream document, LoadOptions loadOptions)
```

Initializes new instance of Comparer with the specified source document stream and LoadOptions.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The input stream of the source document
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |

##### Comparer(InputStream document, ComparerSettings settings)
```
public Comparer(InputStream document, ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified source document stream and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The input stream of the source document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |

##### Comparer(InputStream document, LoadOptions loadOptions, ComparerSettings settings)
```
public Comparer(InputStream document, LoadOptions loadOptions, ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified document stream, LoadOptions and ComparerSettings.

* More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
* More about GroupDocs.Comparison for Java features: Developer Guide
* More about how to open and compare password-protected documents: Open and compare password-protected documents
* More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream with data of a document to be compared
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |
| settings | ComparerSettings | The comparer settings to be used for the comparison process
 |

##### Comparer(ComparerSettings settings)
```
public Comparer(ComparerSettings settings)
```

Initializes new instance of Comparer class with the specified ComparerSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| settings | ComparerSettings | the settings
 |

##### FILE_PATH
```
public static final String FILE_PATH
```

##### getSource()
```
public final Document getSource()
```

Gets the source document that is being compared.

**Returns:**
Document - the source document

##### getTargets()
```
public final List<Document> getTargets()
```

List of target documents to compare with source file.

**Returns:**
java.util.List<com.groupdocs.comparison.Document> - the target documents

##### compare()
```
public final Path compare()
```

Compares the specified file with the target documents without saving result with default options.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Returns:**
java.nio.file.Path - the path of result document or null

##### compare(String filePath)
```
public final Path compare(String filePath)
```

Compares the specified file with the target documents and generates a comparison result.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Result document path
 |

**Returns:**
java.nio.file.Path - result file path or null. In some situations it's extension can be changed

##### compare(Path filePath)
```
public final Path compare(Path filePath)
```

Compares the specified file with the target documents and generates a comparison result.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Result document path
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### compare(OutputStream outputStream)
```
public final Path compare(OutputStream outputStream)
```

Compares the specified file with the target documents and writes a comparison result to the output stream.

Note: In cases when return value is null, use data that was written into outputStream

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | java.io.OutputStream | Result document stream
 |

**Returns:**
java.nio.file.Path - result file path or null when data from  outputStream  must be used. In some situations result file's extension can be changed

##### compare(String filePath, CompareOptions compareOptions)
```
public final Path compare(String filePath, CompareOptions compareOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Result document file path
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### compare(Path filePath, CompareOptions compareOptions)
```
public final Path compare(Path filePath, CompareOptions compareOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Result document file path
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### compare(OutputStream stream, CompareOptions compareOptions)
```
public final Path compare(OutputStream stream, CompareOptions compareOptions)
```

Compares the specified file with the target documents and writes a comparison result to the output stream.

Note: In case return value is null, use data that was written into outputStream.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | Result document stream
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - result file path or null when data from  outputStream  must be used. In some situations result file's extension can be changed

##### compare(SaveOptions saveOptions, CompareOptions compareOptions)
```
public final Path compare(SaveOptions saveOptions, CompareOptions compareOptions)
```

Compares the specified file with the target documents without saving result.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparison options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | SaveOptions | Save options
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - the path of the result document or null

##### compare(String filePath, SaveOptions saveOptions)
```
public final Path compare(String filePath, SaveOptions saveOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Result document file path
 |
| saveOptions | SaveOptions | Save options
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### compare(Path filePath, SaveOptions saveOptions)
```
public final Path compare(Path filePath, SaveOptions saveOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Result document file path
 |
| saveOptions | SaveOptions | Save options
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### compare(OutputStream stream, SaveOptions saveOptions)
```
public final Path compare(OutputStream stream, SaveOptions saveOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

Note: In case return value is null, use data that was written into outputStream

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | Result document stream
 |
| saveOptions | SaveOptions | Save options
 |

**Returns:**
java.nio.file.Path - result file path or null when data from  outputStream  must be used. In some situations result file's extension can be changed

##### compare(CompareOptions compareOptions)
```
public final Path compare(CompareOptions compareOptions)
```

Compares the specified file with the target documents without saving result.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - the path to the result file or null

##### compare(OutputStream outputStream, SaveOptions saveOptions, CompareOptions compareOptions)
```
public final Path compare(OutputStream outputStream, SaveOptions saveOptions, CompareOptions compareOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided output stream.

Note: In case return value is null, use data that was written into outputStream

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | java.io.OutputStream | Result document stream
 |
| saveOptions | SaveOptions | The save options to be used for the saving the result document
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - result file path or null when data from  outputStream  must be used. In some situations result file's extension can be changed

##### compare(String filePath, SaveOptions saveOptions, CompareOptions compareOptions)
```
public final Path compare(String filePath, SaveOptions saveOptions, CompareOptions compareOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparison options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Result document file path
 |
| saveOptions | SaveOptions | The save options to be used for the saving the result document
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### compareDirectory(String filePath, CompareOptions compareOptions)
```
public void compareDirectory(String filePath, CompareOptions compareOptions)
```

Compares the specified directory with the target directory and saves the comparison result to the provided file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path where the comparison result will be saved.
 |
| compareOptions | CompareOptions | The options to be used for the directory comparison process.
 |

##### compareDirectory(Path filePath, CompareOptions compareOptions)
```
public void compareDirectory(Path filePath, CompareOptions compareOptions)
```

Compares the specified directory with the target directory and saves the comparison result to the provided file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The file path where the comparison result will be saved.
 |
| compareOptions | CompareOptions | The options to be used for the directory comparison process.
 |

##### compare(Path filePath, SaveOptions saveOptions, CompareOptions compareOptions)
```
public final Path compare(Path filePath, SaveOptions saveOptions, CompareOptions compareOptions)
```

Compares the specified file with the target documents and writes a comparison result to the provided file path.

* More about how to compare documents: How to compare documents in Java
* More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
* More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Result document file path
 |
| saveOptions | SaveOptions | The save options to be used for the saving the result document
 |
| compareOptions | CompareOptions | The compare options to be used for the comparison process
 |

**Returns:**
java.nio.file.Path - result file path, in some situations it's extension can be changed

##### add(String filePath)
```
public final void add(String filePath)
```

Adds the specified target document to the comparison process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the target document to be added
 |

##### add(String filePath, CompareOptions compareOptions)
```
public void add(String filePath, CompareOptions compareOptions)
```

Adds the specified target document or folder to the comparison process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the target document or folder to be added
 |
| compareOptions | CompareOptions | The options for the comparison
 |

##### add(Path filePath)
```
public final void add(Path filePath)
```

Adds the specified target document to the comparison process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the target document to be added
 |

##### add(String[] filePaths)
```
public final void add(String[] filePaths)
```

Adds the specified target documents to the comparison process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePaths | java.lang.String[] | Paths to the target documents to be added
 |

##### add(Path[] filePaths)
```
public final void add(Path[] filePaths)
```

Adds the specified target documents to the comparison process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePaths | java.nio.file.Path[] | Paths to the target documents to be added
 |

##### add(String filePath, LoadOptions loadOptions)
```
public final void add(String filePath, LoadOptions loadOptions)
```

Adds the specified target document to the comparison process with loading options specified.

* More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
* More about how to open and compare documents stored at local disk: How to open and compare files by file path
* More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Path to the target document to be added
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |

##### add(Path filePath, LoadOptions loadOptions)
```
public final void add(Path filePath, LoadOptions loadOptions)
```

Adds the specified target document to the comparison process with loading options specified.

* More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
* More about how to open and compare documents stored at local disk: How to open and compare files by file path
* More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Path to the target document to be added
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |

##### add(Path filePath, CompareOptions compareOptions)
```
public final void add(Path filePath, CompareOptions compareOptions)
```

Adds the specified target document to the comparison process with loading options specified.

* More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
* More about how to open and compare documents stored at local disk: How to open and compare files by file path
* More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the target document or folder to be added
 |
| compareOptions | CompareOptions | The options for the comparison
 |

##### add(InputStream document)
```
public final void add(InputStream document)
```

Adds the specified target document to the comparison process.

* More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
* More about how to open and compare documents stored at local disk: How to open and compare files by file path
* More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream with data of a document to be compared
 |

##### add(InputStream[] documents)
```
public final void add(InputStream[] documents)
```

Adds the specified target documents to the comparison process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documents | java.io.InputStream[] | Streams with data of documents to be compared
 |

##### add(InputStream document, LoadOptions loadOptions)
```
public final void add(InputStream document, LoadOptions loadOptions)
```

Adds the specified target document to the comparison process with loading options specified.

* More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
* More about how to open and compare documents stored at local disk: How to open and compare files by file path
* More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream with data of a document to be compared
 |
| loadOptions | LoadOptions | The custom load options to be applied to the document
 |

##### getChanges()
```
public final ChangeInfo[] getChanges()
```

Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.

Use this method to get detailed information about the changes between the source document and the target document(s).
Each ChangeInfo object contains information such as the type of change, the affected area,
and the content before and after the change.

* More about how to obtain collection of detected differences between compared documents in Java: How to get list of changes between documents in Java
* More about how to get changes coordinates at pages image preview when comparing documents using GroupDocs.Comparison for Java: How to get changes coordinates programmatically

**Returns:**
com.groupdocs.comparison.result.ChangeInfo[] - an array of ChangeInfo objects representing the changes detected during the comparison process

##### getChanges(GetChangeOptions getChangeOptions)
```
public final ChangeInfo[] getChanges(GetChangeOptions getChangeOptions)
```

Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.

Use this method to get detailed information about the changes between the source document and the target document(s).
Each ChangeInfo object contains information such as the type of change, the affected area,
and the content before and after the change.

Parameter GetChangeOptions allows to filter changes in different way.

* More about how to obtain collection of detected differences between compared documents in Java: How to get list of changes between documents in Java
* More about how to get changes coordinates at pages image preview when comparing documents using GroupDocs.Comparison for Java: How to get changes coordinates programmatically

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| getChangeOptions | GetChangeOptions | The object that allows to filter changes
 |

**Returns:**
com.groupdocs.comparison.result.ChangeInfo[] - an array of ChangeInfo objects representing the changes detected during the comparison process

##### applyChanges(String filePath, ApplyChangeOptions applyChangeOptions)
```
public final void applyChanges(String filePath, ApplyChangeOptions applyChangeOptions)
```

Accepts or rejects changes and applies them to result document.

* More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Result document file path
 |
| applyChangeOptions | ApplyChangeOptions | The custom apply change options to configure process of applying changes
 |

##### applyChanges(Path filePath, ApplyChangeOptions applyChangeOptions)
```
public final void applyChanges(Path filePath, ApplyChangeOptions applyChangeOptions)
```

Accepts or rejects changes and applies them to resultant document.

* More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Result document file path
 |
| applyChangeOptions | ApplyChangeOptions | The custom apply change options to configure process of applying changes
 |

##### applyChanges(OutputStream document, ApplyChangeOptions applyChangeOptions)
```
public final void applyChanges(OutputStream document, ApplyChangeOptions applyChangeOptions)
```

Accepts or rejects changes and applies them to resultant document.

* More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | Result document output stream
 |
| applyChangeOptions | ApplyChangeOptions | The custom apply change options to configure process of applying changes
 |

##### applyChanges(String filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions)
```
public final void applyChanges(String filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions)
```

Accepts or rejects changes and applies them to resultant document.

* More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Result document file path
 |
| saveOptions | SaveOptions | The save options to configure saving result document
 |
| applyChangeOptions | ApplyChangeOptions | The custom apply change options to configure process of applying changes
 |

##### applyChanges(Path filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions)
```
public final void applyChanges(Path filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions)
```

Accepts or rejects changes and applies them to resultant document.

* More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Result document file path
 |
| saveOptions | SaveOptions | The save options to configure saving result document
 |
| applyChangeOptions | ApplyChangeOptions | The custom apply change options to configure process of applying changes
 |

##### applyChanges(OutputStream document, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions)
```
public final void applyChanges(OutputStream document, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions)
```

Accepts or rejects changes and applies them to resultant document.

* More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | Result document output stream
 |
| saveOptions | SaveOptions | The save options to configure saving result document
 |
| applyChangeOptions | ApplyChangeOptions | The custom apply change options to configure process of applying changes
 |

##### getResultString()
```
public String getResultString()
```

Gets result string after comparison (For Text Comparison only).

**Returns:**
java.lang.String - the result string

##### getSourceFolder()
```
public String getSourceFolder()
```

Returns the source folder that is being compared.

**Returns:**
java.lang.String - the source folder

##### getTargetFolder()
```
public String getTargetFolder()
```

Returns the target folder that is being compared.

**Returns:**
java.lang.String - the target folder

##### selfComparisonCheck(Document source, Document target)
```
public static void selfComparisonCheck(Document source, Document target)
```

Self-comparison check (e498c23). C# 7a7668c internal; kept public so core.common tests can call.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | Document |  |
| target | Document |  |

##### close()
```
public void close()
```

Releases resources.

### ComparerSettings
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison/comparersettings.md

**Inheritance:**
java.lang.Object
```
public class ComparerSettings
```

Defines settings for customizing the behavior of the Comparer class.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     final ComparerSettings comparerSettings = new ComparerSettings();
     comparerSettings.setLogger(new ConsoleLogger(false, false, true, true));

     comparer.compare(resultFile, comparerSettings);
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| ComparerSettings() | Instantiates new instance of ComparerSettings class.
 |
| ComparerSettings(ILogger logger) | Instantiates new instance of ComparerSettings class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | Gets the logger implementation used for logging.
 |
| setLogger(ILogger value) | Sets the logger implementation for logging.
 |
##### ComparerSettings()
```
public ComparerSettings()
```

Instantiates new instance of ComparerSettings class.

##### ComparerSettings(ILogger logger)
```
public ComparerSettings(ILogger logger)
```

Instantiates new instance of ComparerSettings class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | logger to be used
 |

##### getLogger()
```
public final ILogger getLogger()
```

Gets the logger implementation used for logging.

**Returns:**
com.groupdocs.foundation.logging.ILogger - the logger

##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

Sets the logger implementation for logging.

Use com.groupdocs.foundation.logging.NullLogger#NULL_LOGGER.NULL_LOGGER to disable logging.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.groupdocs.foundation.logging.ILogger | the logger implementation to set
 |

### Document
Path: https://reference.groupdocs.com/comparison/java/com.groupdocs.comparison/document.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Document implements Closeable
```

Represents a document for comparison process.

The Document class provides methods to load, generate preview images, and manipulate documents during the comparison process.

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     try (IDocumentInfo info = comparer.getSource().getDocumentInfo()) {
         System.out.println("File type: " + info.getFileType());
         System.out.println("Number of pages: " + info.getPageCount());
         System.out.println("Document size: " + info.getSize());
     }
 }
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Document(InputStream stream) | Initializes new instance of Document class with the specified document stream.
 |
| Document(String filePath) | Initializes new instance of Document class with the specified document path.
 |
| Document(Path filePath) | Initializes new instance of Document class with the specified document path.
 |
| Document(Path filePath, String password) | Initializes new instance of Document class with the specified document path and a password.
 |
| Document(Path filePath, LoadOptions loadOptions) | Initializes new instance of Document class with the specified document path and load options.
 |
| Document(String filePath, String password) | Initializes new instance of Document class with the specified document path and a password.
 |
| Document(String filePath, LoadOptions loadOptions) | Initializes new instance of Document class with the specified document path and load options.
 |
| Document(InputStream stream, String password) | Initializes new instance of Document class with the specified document stream and a password.
 |
| Document(String filePathOrTextContent, boolean isLoadText) | Initializes new instance of Document class with the specified document path or text content and a flag that indicates what was passed.
 |
| Document(InputStream inputStream, LoadOptions loadOptions) | Initializes new instance of Document class with the specified document stream and load options.
 |
#### Methods

| Method | Description |
| --- | --- |
| getChanges() | Gets a list of ChangeInfo objects representing the changes detected during the comparison process.
 |
| setChanges(List<ChangeInfo> value) | Sets a list of ChangeInfo objects representing the changes detected during the comparison process.
 |
| getName() | Gets the name of the document.
 |
| setName(String value) | Sets the name of the document.
 |
| getFileType() | Gets the type of the document.
 |
| setFileType(FileType fileType) | Sets the type of the document.
 |
| createStream() | Creates new stream with document content.
 |
| getStreamLength() | Gets the size of the document
 |
| getPassword() | Gets the password of the document
 |
| generatePreview(PreviewOptions previewOptions) | Generates document previews based on the provided PreviewOptions.
 |
| getDocumentInfo() | Gets information about the document, including document type, page count, page sizes, and more.
 |
| close() |  |
##### Document(InputStream stream)
```
public Document(InputStream stream)
```

Initializes new instance of Document class with the specified document stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | Document stream
 |

##### Document(String filePath)
```
public Document(String filePath)
```

Initializes new instance of Document class with the specified document path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Document path
 |

##### Document(Path filePath)
```
public Document(Path filePath)
```

Initializes new instance of Document class with the specified document path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Document path
 |

##### Document(Path filePath, String password)
```
public Document(Path filePath, String password)
```

Initializes new instance of Document class with the specified document path and a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Document path
 |
| password | java.lang.String | Document password
 |

##### Document(Path filePath, LoadOptions loadOptions)
```
public Document(Path filePath, LoadOptions loadOptions)
```

Initializes new instance of Document class with the specified document path and load options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | Document path
 |
| loadOptions | LoadOptions | Load options
 |

##### Document(String filePath, String password)
```
public Document(String filePath, String password)
```

Initializes new instance of Document class with the specified document path and a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Document path
 |
| password | java.lang.String | Document password
 |

##### Document(String filePath, LoadOptions loadOptions)
```
public Document(String filePath, LoadOptions loadOptions)
```

Initializes new instance of Document class with the specified document path and load options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Document path
 |
| loadOptions | LoadOptions | Load options
 |

##### Document(InputStream stream, String password)
```
public Document(InputStream stream, String password)
```

Initializes new instance of Document class with the specified document stream and a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | Document stream
 |
| password | java.lang.String | Document password
 |

##### Document(String filePathOrTextContent, boolean isLoadText)
```
public Document(String filePathOrTextContent, boolean isLoadText)
```

Initializes new instance of Document class with the specified document path or text content and a flag that indicates what was passed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathOrTextContent | java.lang.String | the file path
 |
| isLoadText | boolean | the is load text
 |

##### Document(InputStream inputStream, LoadOptions loadOptions)
```
public Document(InputStream inputStream, LoadOptions loadOptions)
```

Initializes new instance of Document class with the specified document stream and load options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | Document stream
 |
| loadOptions | LoadOptions | Load options
 |

##### getChanges()
```
public final List<ChangeInfo> getChanges()
```

Gets a list of ChangeInfo objects representing the changes detected during the comparison process.

Use this method to get detailed information about the changes between the source document and the target document(s).
Each ChangeInfo object contains information such as the type of change, the affected area,
and the content before and after the change.

**Returns:**
java.util.List<com.groupdocs.comparison.result.ChangeInfo> - a list of ChangeInfo objects representing the changes detected during the comparison process

##### setChanges(List<ChangeInfo> value)
```
public final void setChanges(List<ChangeInfo> value)
```

Sets a list of ChangeInfo objects representing the changes detected during the comparison process.

Use this method to get detailed information about the changes between the source document and the target document(s).
Each ChangeInfo object contains information such as the type of change, the affected area,
and the content before and after the change.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.comparison.result.ChangeInfo> | a list of ChangeInfo objects representing the changes detected during the comparison process
 |

##### getName()
```
public final String getName()
```

Gets the name of the document.

**Returns:**
java.lang.String - the name of the document

##### setName(String value)
```
public final void setName(String value)
```

Sets the name of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | the name of the document
 |

##### getFileType()
```
public FileType getFileType()
```

Gets the type of the document.

**Returns:**
FileType - the type of the document

##### setFileType(FileType fileType)
```
public void setFileType(FileType fileType)
```

Sets the type of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | the type of the document
 |

##### createStream()
```
public InputStream createStream()
```

Creates new stream with document content.

**Returns:**
java.io.InputStream - the stream with document content

##### getStreamLength()
```
public long getStreamLength()
```

Gets the size of the document

**Returns:**
long - the size of the document

##### getPassword()
```
public String getPassword()
```

Gets the password of the document

**Returns:**
java.lang.String - the password of the document

##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Generates document previews based on the provided PreviewOptions.

This method generates previews of the document pages according to the specified options, such as preview format,
page numbers, and output stream provider. The generated previews can be saved or further processed as needed.

* Learn more about how to generate previews for document pages: How to generate document pages preview using GroupDocs.Comparison

Example usage:

````

 try (Comparer comparer = new Comparer(sourceFile)) {
     PreviewOptions previewOptions = new PreviewOptions(
             pageNumber -> Files.newOutputStream(Paths.get("preview-image-page-" + pageNumber + ".png"))
     );
     previewOptions.setPreviewFormat(PreviewFormats.PNG);
     previewOptions.setPageNumbers(new int[]{1, 2});
     comparer.getSource().generatePreview(previewOptions);
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The preview options specifying the format, page numbers and so on
 |

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets information about the document, including document type, page count, page sizes, and more.

* Learn more about document file type, page count, size, and other format-specific properties: How to get document info using GroupDocs.Comparison

**Returns:**
IDocumentInfo - the document information

##### close()
```
public void close()
```

## .NET

### GroupDocs.Comparison for .NET
Path: https://reference.groupdocs.com/comparison/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Comparison | The namespace provides classes to compare documents for all popular document formats. |
| GroupDocs.Comparison.Cells.Style | The namespace provides classes for working with component styles in Cells format file. |
| GroupDocs.Comparison.Common.Delegates | The namespace provides classes for creating and releasing streams used by `PreviewOptions`. |
| GroupDocs.Comparison.Common.Exceptions | The namespace provides different exception classes. |
| GroupDocs.Comparison.Interfaces | The namespace provides interfaces to instantiate output objects. |
| GroupDocs.Comparison.Localization | The namespace provides classes checking supported locales. |
| GroupDocs.Comparison.Logging | The namespace provides classes for working with integrated or your own logger. |
| GroupDocs.Comparison.Options | The namespace provides classes that allows to specify additional options for documents comparison process. |
| GroupDocs.Comparison.Result | The namespace provides classes which represents the comparison results. |
| GroupDocs.Comparison.Words.Revision | The namespace provides classes for working with revisions in WORD format file. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### GroupDocs.Comparison.Cells.Style
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.cells.style.md

The namespace provides classes for working with component styles in Cells format file.

#### Enumeration

| Enumeration | Description |
| --- | --- |
| MergeType | Enumerates the type of cell merge. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### MergeType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.cells.style/mergetype.md

#### MergeType enumeration

Enumerates the type of cell merge.

```csharp
public enum MergeType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Cell does not merge. |
| Horizontal | `1` | Cell merges along row. |
| Vertical | `2` | Cell merges along column. |
| Range | `3` | Cell merges along row and column creating area. |

### GroupDocs.Comparison.Common.Delegates
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.delegates.md

The namespace provides classes for creating and releasing streams used by `PreviewOptions`.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Delegate which defines method to create output page preview stream used by `PreviewOptions`. |
| ReleasePageStream | Delegate which defines method to release output page preview stream used by `PreviewOptions`. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### CreatePageStream
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.delegates/createpagestream.md

#### CreatePageStream delegate

Delegate which defines method to create output page preview stream used by `PreviewOptions`.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of previewed page. |

##### Return Value

Stream of image

### ReleasePageStream
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.delegates/releasepagestream.md

#### ReleasePageStream delegate

Delegate which defines method to release output page preview stream used by `PreviewOptions`.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of previewed page. |
| pageStream | Stream | The page stream to release. |

### GroupDocs.Comparison.Common.Exceptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions.md

The namespace provides different exception classes.

#### Classes

| Class | Description |
| --- | --- |
| ComparisonException | Base class for all comparison process exceptions. |
| DocumentComparisonException | The exception that is thrown when an error occurs while comparing documents. |
| FileFormatException | The exception that is thrown when comparing files with different formats. |
| InvalidPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordProtectedFileException | The exception that is thrown when the document is protected by password. |
| UnsupportedFileFormatException | The exception that is thrown when file of this format doesn't support comparison. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### ComparisonException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/comparisonexception.md

#### ComparisonException class

Base class for all comparison process exceptions.

```csharp
public class ComparisonException : ApplicationException
```

#### Constructors

| Name | Description |
| --- | --- |
| ComparisonException() | Initializes a new instance of the `ComparisonException` class. |
| ComparisonException(string) | Initializes a new instance of the `ComparisonException` class with a specified error message. |
| ComparisonException(string, Exception) | Initializes a new instance of the `ComparisonException` class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### ComparisonException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/comparisonexception/comparisonexception.md

#### ComparisonException()

Initializes a new instance of the `ComparisonException` class.

```csharp
public ComparisonException()
```

#### ComparisonException(string)

Initializes a new instance of the `ComparisonException` class with a specified error message.

```csharp
public ComparisonException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The exception message |

#### ComparisonException(string, Exception)

Initializes a new instance of the `ComparisonException` class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public ComparisonException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The exception message |
| innerException | Exception | The inner exception |

### DocumentComparisonException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/documentcomparisonexception.md

#### DocumentComparisonException class

The exception that is thrown when an error occurs while comparing documents.

```csharp
public class DocumentComparisonException : ComparisonException
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentComparisonException(string) | Initializes a new instance of `DocumentComparisonException` class. |

### DocumentComparisonException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/documentcomparisonexception/documentcomparisonexception.md

#### DocumentComparisonException constructor

Initializes a new instance of `DocumentComparisonException` class.

```csharp
public DocumentComparisonException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String |  |

### FileFormatException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/fileformatexception.md

#### FileFormatException class

The exception that is thrown when comparing files with different formats.

```csharp
public class FileFormatException : ComparisonException
```

#### Constructors

| Name | Description |
| --- | --- |
| FileFormatException(string, string) | Initializes a new instance of `FileFormatException` class. |

### FileFormatException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/fileformatexception/fileformatexception.md

#### FileFormatException constructor

Initializes a new instance of `FileFormatException` class.

```csharp
public FileFormatException(string sourcePath, string targetPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The source file path |
| targetPath | String | The target file path |

### InvalidPasswordException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/invalidpasswordexception.md

#### InvalidPasswordException class

The exception that is thrown when specified password is incorrect.

```csharp
public class InvalidPasswordException : ComparisonException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidPasswordException() | Initializes a new instance of `InvalidPasswordException` class. |

### InvalidPasswordException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/invalidpasswordexception/invalidpasswordexception.md

#### InvalidPasswordException constructor

Initializes a new instance of `InvalidPasswordException` class.

```csharp
public InvalidPasswordException()
```

### PasswordProtectedFileException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/passwordprotectedfileexception.md

#### PasswordProtectedFileException class

The exception that is thrown when the document is protected by password.

```csharp
public class PasswordProtectedFileException : ComparisonException
```

#### Constructors

| Name | Description |
| --- | --- |
| PasswordProtectedFileException() | Initializes a new instance of `PasswordProtectedFileException` class. |

### PasswordProtectedFileException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/passwordprotectedfileexception/passwordprotectedfileexception.md

#### PasswordProtectedFileException constructor

Initializes a new instance of `PasswordProtectedFileException` class.

```csharp
public PasswordProtectedFileException()
```

### UnsupportedFileFormatException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/unsupportedfileformatexception.md

#### UnsupportedFileFormatException class

The exception that is thrown when file of this format doesn't support comparison.

```csharp
public class UnsupportedFileFormatException : ComparisonException
```

#### Constructors

| Name | Description |
| --- | --- |
| UnsupportedFileFormatException() | Initializes a new instance of `UnsupportedFileFormatException` class. |
| UnsupportedFileFormatException(string) | Initializes a new instance of `UnsupportedFileFormatException` class. |

### UnsupportedFileFormatException
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.common.exceptions/unsupportedfileformatexception/unsupportedfileformatexception.md

#### UnsupportedFileFormatException()

Initializes a new instance of `UnsupportedFileFormatException` class.

```csharp
public UnsupportedFileFormatException()
```

#### UnsupportedFileFormatException(string)

Initializes a new instance of `UnsupportedFileFormatException` class.

```csharp
public UnsupportedFileFormatException(string pathFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pathFile | String |  |

### GroupDocs.Comparison.Interfaces
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.interfaces.md

The namespace provides interfaces to instantiate output objects.

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines document description properties. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### IDocumentInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.interfaces/idocumentinfo.md

#### IDocumentInfo interface

Defines document description properties.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | Represents file type. Provides methods to obtain list of all file types supported by GroupDocs.Comparison, detect file type by extension etc. |
| PageCount { get; set; } | Number of pages in document. |
| PagesInfo { get; set; } | Pages Information (Page Number, Width, Height). |
| Size { get; set; } | File size. |

### FileType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.interfaces/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

Represents file type. Provides methods to obtain list of all file types supported by GroupDocs.Comparison, detect file type by extension etc.

```csharp
public FileType FileType { get; set; }
```

### PageCount
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.interfaces/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Number of pages in document.

```csharp
public int PageCount { get; set; }
```

### PagesInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.interfaces/idocumentinfo/pagesinfo.md

#### IDocumentInfo.PagesInfo property

Pages Information (Page Number, Width, Height).

```csharp
public List<PageInfo> PagesInfo { get; set; }
```

### Size
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.interfaces/idocumentinfo/size.md

#### IDocumentInfo.Size property

File size.

```csharp
public long Size { get; set; }
```

### GroupDocs.Comparison.Localization
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.localization.md

The namespace provides classes checking supported locales.

#### Classes

| Class | Description |
| --- | --- |
| SupportedLocales | Class that provides methods for checking supported locales of GroupDocs.Comparison. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### SupportedLocales
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.localization/supportedlocales.md

#### SupportedLocales class

Class that provides methods for checking supported locales of GroupDocs.Comparison.

```csharp
public static class SupportedLocales
```

#### Methods

| Name | Description |
| --- | --- |
| static IsLocaleSupported(CultureInfo) | Determines whether the locale is supported. |
| static IsLocaleSupported(string) | Determines whether the locale is supported. |

### IsLocaleSupported
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.localization/supportedlocales/islocalesupported.md

#### IsLocaleSupported(string)

Determines whether the locale is supported.

```csharp
public static bool IsLocaleSupported(string culture)
```

| Parameter | Type | Description |
| --- | --- | --- |
| culture | String | The culture. |

#### IsLocaleSupported(CultureInfo)

Determines whether the locale is supported.

```csharp
public static bool IsLocaleSupported(CultureInfo culture)
```

| Parameter | Type | Description |
| --- | --- | --- |
| culture | CultureInfo | The culture. |

### GroupDocs.Comparison.Logging
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging.md

The namespace provides classes for working with integrated or your own logger.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Represents logger implementation which sends all messages to console. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Logger interface. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### ConsoleLogger
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/consolelogger.md

#### ConsoleLogger class

Represents logger implementation which sends all messages to console.

```csharp
public sealed class ConsoleLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| ConsoleLogger() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Logs error message. |
| Trace(string) | Logs the process of comparison. |
| Warning(string) | Logs warning message. |

### ConsoleLogger
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

The default constructor.

```csharp
public ConsoleLogger()
```

### Error
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/consolelogger/error.md

#### ConsoleLogger.Error method

Logs error message.

```csharp
public void Error(string message, Exception ex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Error message |
| ex | Exception | Exception object |

### Trace
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/consolelogger/trace.md

#### ConsoleLogger.Trace method

Logs the process of comparison.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Log message |

### Warning
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/consolelogger/warning.md

#### ConsoleLogger.Warning method

Logs warning message.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Warning message |

### ILogger
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/ilogger.md

#### ILogger interface

Logger interface.

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Error message. |
| Trace(string) | Trace message. |
| Warning(string) | Warning message. |

### Error
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/ilogger/error.md

#### ILogger.Error method

Error message.

```csharp
public void Error(string message, Exception ex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message |
| ex | Exception | The exception message |

### Trace
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/ilogger/trace.md

#### ILogger.Trace method

Trace message.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### Warning
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.logging/ilogger/warning.md

#### ILogger.Warning method

Warning message.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message |

### GroupDocs.Comparison.Options
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options.md

The namespace provides classes that allows to specify additional options for documents comparison process.

#### Classes

| Class | Description |
| --- | --- |
| ApplyChangeOptions | Allows to update the list of changes before applying them to the resulting document. |
| CompareOptions | Allows to set different compare options. |
| DiagramMasterSetting | Diagram master settings. |
| FileAuthorMetadata | Information about document's author metadata. |
| GetChangeOptions | The option allows to filter changes by type. |
| IgnoreChangeSensitivitySettings | The option allows to ignore changes by similarity percentage. |
| LoadOptions | Allows to specify additional options when loading a document. |
| OriginalSize | Represents original page size. Used only for comparing image with different formats. |
| PagesSetup | Specifies which pages to include in the comparison. |
| PdfCompareOptions | PDF document specific compare options. Inherits common options from `CompareOptions`. |
| PreviewOptions | Represents document preview options. |
| PreviewResolution | Represents resolution settings for document preview generation. |
| SaveOptions | Allows to specify additional options (such as password) when saving a document. |
| Size | Document size. |
| StyleSettings | Style settings. Allows to define style rules for changes. Used in `CompareOptions` class. |
| WordCompareOptions | Word document specific compare options. Inherits common options from `CompareOptions`. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| CalculateCoordinatesModeEnumeration | Enumerates the type of coordinates calculation. |
| ChangeType | Specifies change type. |
| PdfCompareOptions.ComparisonDisplayMode | Controls how Pdf comparison result document is laid out. |
| WordCompareOptions.ComparisonDisplayMode | Defines how Word comparison results are displayed for `WordCompareOptions`. |
| DetalisationLevel | Specifies the level of comparison details. |
| FolderComparisonExtension | Folder extensions. |
| ImagesInheritance | Source of images inheritance when image comparison is disabled. |
| MetadataType | Determines from where result document will take metadata information |
| PaperSize | The option to set the Paper size of the result document after comparison. |
| PasswordSaveOption | Specifies the password save option. |
| PreviewFormats | Document preview supported formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### ApplyChangeOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/applychangeoptions.md

#### ApplyChangeOptions class

Allows to update the list of changes before applying them to the resulting document.

```csharp
public class ApplyChangeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ApplyChangeOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Changes { get; set; } | List of changes that must be applied to the resulting document. |
| SaveOriginalState { get; set; } | After applying the changes, keep the original state of the compared result. |

### ApplyChangeOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/applychangeoptions/applychangeoptions.md

#### ApplyChangeOptions constructor

The default constructor.

```csharp
public ApplyChangeOptions()
```

### Changes
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/applychangeoptions/changes.md

#### ApplyChangeOptions.Changes property

List of changes that must be applied to the resulting document.

```csharp
public ChangeInfo[] Changes { get; set; }
```

### SaveOriginalState
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/applychangeoptions/saveoriginalstate.md

#### ApplyChangeOptions.SaveOriginalState property

After applying the changes, keep the original state of the compared result.

```csharp
public bool SaveOriginalState { get; set; }
```

### CalculateCoordinatesModeEnumeration
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/calculatecoordinatesmodeenumeration.md

#### CalculateCoordinatesModeEnumeration enumeration

Enumerates the type of coordinates calculation.

```csharp
public enum CalculateCoordinatesModeEnumeration
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Source | `0` | Calculate coordinates of source elements. |
| Target | `1` | Calculate coordinates of target elements. |
| Result | `2` | Calculate coordinates of result elements (default). |

### ChangeType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/changetype.md

#### ChangeType enumeration

Specifies change type.

```csharp
public enum ChangeType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | The none. |
| Modified | `1` | The modified. |
| Inserted | `2` | The inserted. |
| Deleted | `3` | The deleted. |
| Added | `4` | The added. |
| NotModified | `5` | The not modified. |
| StyleChanged | `6` | Style changed. |
| Resized | `7` | Resized. |
| Moved | `8` | Moved. |
| MovedAndResized | `9` | The moved and resized. |
| ShiftedAndResized | `10` | The shifted and resized. |

### CompareOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions.md

#### CompareOptions class

Allows to set different compare options.

```csharp
public class CompareOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CompareOptions() | Initializes a new instance of the `CompareOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CalculateCoordinates { get; set; } | Indicates whether to calculate coordinates for changed components. |
| CalculateCoordinatesMode { get; set; } | Specifies the coordinate calculation for changed components mode. |
| ChangedItemStyle { get; set; } | Describes style for changed components. |
| DeletedItemStyle { get; set; } | Describes style for deleted components. |
| DetalisationLevel { get; set; } | Gets or sets the comparison detail level. |
| DetectStyleChanges { get; set; } | Indicates whether to detect style changes or not. |
| DiagramMasterSetting { get; set; } | Gets or sets the path value for master or use compare without path of master. This option only for Diagram. |
| DirectoryCompare { get; set; } | Control to turn on comparison of folders. |
| ExtendedSummaryPage { get; set; } | Indicates whether to add extended file comparison information to the summary page or not. |
| FolderComparisonExtension { get; set; } | Gets or sets the format of the resulting folder comparison file. |
| GenerateSummaryPage { get; set; } | Indicates whether to add summary page with detected changes statistics to resultant document or not. |
| HeaderFootersComparison { get; set; } | Control to turn on comparison of header/footer contents. |
| IgnoreChangeSettings { get; set; } | Gets or sets settings to ignore changes based on similarity. |
| InsertedItemStyle { get; set; } | Describes style for inserted components. |
| MarkChangedContent { get; set; } | Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents. |
| MarkNestedContent { get; set; } | Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted. |
| OriginalSize { get; set; } | Get or sets the original sizes of compared documents. |
| PaperSize { get; set; } | Gets or sets the result document paper size. |
| PasswordSaveOption { get; set; } | Gets or sets the password save option. |
| SensitivityOfComparison { get; set; } | Gets or sets a sensitivity of comparison. |
| SensitivityOfComparisonForTables { get; set; } | Gets or sets a sensitivity of comparison for tables. |
| ShowDeletedContent { get; set; } | Indicates whether to show deleted components in resultant document or not. |
| ShowInsertedContent { get; set; } | Indicates whether to show inserted components in resultant document or not. |
| ShowOnlyChanged { get; set; } | Controls to enable the display of only changed items. |
| ShowOnlySummaryPage { get; set; } | Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not. |
| UserMasterPath { get; set; } | Path to user master's template for Diagrams. |
| WordsSeparatorChars { set; } | Gets or sets an array of delimiters to split text into words. |

### CalculateCoordinates
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/calculatecoordinates.md

#### CompareOptions.CalculateCoordinates property

Indicates whether to calculate coordinates for changed components.

```csharp
public bool CalculateCoordinates { get; set; }
```

### CalculateCoordinatesMode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/calculatecoordinatesmode.md

#### CompareOptions.CalculateCoordinatesMode property

Specifies the coordinate calculation for changed components mode.

```csharp
public CalculateCoordinatesModeEnumeration CalculateCoordinatesMode { get; set; }
```

### ChangedItemStyle
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/changeditemstyle.md

#### CompareOptions.ChangedItemStyle property

Describes style for changed components.

```csharp
public StyleSettings ChangedItemStyle { get; set; }
```

### CompareOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/compareoptions.md

#### CompareOptions constructor

Initializes a new instance of the `CompareOptions` class.

```csharp
public CompareOptions()
```

### DeletedItemStyle
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/deleteditemstyle.md

#### CompareOptions.DeletedItemStyle property

Describes style for deleted components.

```csharp
public StyleSettings DeletedItemStyle { get; set; }
```

### DetalisationLevel
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/detalisationlevel.md

#### CompareOptions.DetalisationLevel property

Gets or sets the comparison detail level.

```csharp
public DetalisationLevel DetalisationLevel { get; set; }
```

### DetectStyleChanges
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/detectstylechanges.md

#### CompareOptions.DetectStyleChanges property

Indicates whether to detect style changes or not.

```csharp
public bool DetectStyleChanges { get; set; }
```

### DiagramMasterSetting
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/diagrammastersetting.md

#### CompareOptions.DiagramMasterSetting property

Gets or sets the path value for master or use compare without path of master. This option only for Diagram.

```csharp
public DiagramMasterSetting DiagramMasterSetting { get; set; }
```

##### Property Value

The master option for Diagram.

### DirectoryCompare
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/directorycompare.md

#### CompareOptions.DirectoryCompare property

Control to turn on comparison of folders.

```csharp
public bool DirectoryCompare { get; set; }
```

### ExtendedSummaryPage
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/extendedsummarypage.md

#### CompareOptions.ExtendedSummaryPage property

Indicates whether to add extended file comparison information to the summary page or not.

```csharp
public bool ExtendedSummaryPage { get; set; }
```

### FolderComparisonExtension
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/foldercomparisonextension.md

#### CompareOptions.FolderComparisonExtension property

Gets or sets the format of the resulting folder comparison file.

```csharp
public FolderComparisonExtension FolderComparisonExtension { get; set; }
```

### GenerateSummaryPage
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/generatesummarypage.md

#### CompareOptions.GenerateSummaryPage property

Indicates whether to add summary page with detected changes statistics to resultant document or not.

```csharp
public bool GenerateSummaryPage { get; set; }
```

### HeaderFootersComparison
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/headerfooterscomparison.md

#### CompareOptions.HeaderFootersComparison property

Control to turn on comparison of header/footer contents.

```csharp
public bool HeaderFootersComparison { get; set; }
```

### IgnoreChangeSettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/ignorechangesettings.md

#### CompareOptions.IgnoreChangeSettings property

Gets or sets settings to ignore changes based on similarity.

```csharp
public IgnoreChangeSensitivitySettings IgnoreChangeSettings { get; set; }
```

##### Property Value

Settings to ignore changes.

### InsertedItemStyle
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/inserteditemstyle.md

#### CompareOptions.InsertedItemStyle property

Describes style for inserted components.

```csharp
public StyleSettings InsertedItemStyle { get; set; }
```

### MarkChangedContent
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/markchangedcontent.md

#### CompareOptions.MarkChangedContent property

Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.

```csharp
public bool MarkChangedContent { get; set; }
```

### MarkNestedContent
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/marknestedcontent.md

#### CompareOptions.MarkNestedContent property

Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted.

```csharp
public bool MarkNestedContent { get; set; }
```

### OriginalSize
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/originalsize.md

#### CompareOptions.OriginalSize property

Get or sets the original sizes of compared documents.

```csharp
public OriginalSize OriginalSize { get; set; }
```

### PaperSize
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/papersize.md

#### CompareOptions.PaperSize property

Gets or sets the result document paper size.

```csharp
public PaperSize PaperSize { get; set; }
```

### PasswordSaveOption
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/passwordsaveoption.md

#### CompareOptions.PasswordSaveOption property

Gets or sets the password save option.

```csharp
public PasswordSaveOption PasswordSaveOption { get; set; }
```

##### Property Value

The password save option.

### SensitivityOfComparison
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/sensitivityofcomparison.md

#### CompareOptions.SensitivityOfComparison property

Gets or sets a sensitivity of comparison.

```csharp
public int SensitivityOfComparison { get; set; }
```

##### Property Value

The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects. if this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted. Min value - 0% =&gt; The comparison doesn't occur for any length of the common subsequence of two compared object. Default value - 75% =&gt; Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75. Max value - 100% =&gt; The comparison occurs at any length of the common subsequence of two compared objects.

### SensitivityOfComparisonForTables
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/sensitivityofcomparisonfortables.md

#### CompareOptions.SensitivityOfComparisonForTables property

Gets or sets a sensitivity of comparison for tables.

```csharp
public int? SensitivityOfComparisonForTables { get; set; }
```

##### Property Value

If the value is null, SensitivityOfComparison is used instead. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects. if this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted. Min value - 0% =&gt; The comparison doesn't occur for any length of the common subsequence of two compared object. Default value - 75% =&gt; Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75. Max value - 100% =&gt; The comparison occurs at any length of the common subsequence of two compared objects.

### ShowDeletedContent
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/showdeletedcontent.md

#### CompareOptions.ShowDeletedContent property

Indicates whether to show deleted components in resultant document or not.

```csharp
public bool ShowDeletedContent { get; set; }
```

### ShowInsertedContent
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/showinsertedcontent.md

#### CompareOptions.ShowInsertedContent property

Indicates whether to show inserted components in resultant document or not.

```csharp
public bool ShowInsertedContent { get; set; }
```

### ShowOnlyChanged
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/showonlychanged.md

#### CompareOptions.ShowOnlyChanged property

Controls to enable the display of only changed items.

```csharp
public bool ShowOnlyChanged { get; set; }
```

### ShowOnlySummaryPage
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/showonlysummarypage.md

#### CompareOptions.ShowOnlySummaryPage property

Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not.

```csharp
public bool ShowOnlySummaryPage { get; set; }
```

### UserMasterPath
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/usermasterpath.md

#### CompareOptions.UserMasterPath property

Path to user master's template for Diagrams.

```csharp
public string UserMasterPath { get; set; }
```

### WordsSeparatorChars
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/compareoptions/wordsseparatorchars.md

#### CompareOptions.WordsSeparatorChars property

Gets or sets an array of delimiters to split text into words.

```csharp
public char[] WordsSeparatorChars { set; }
```

##### Property Value

The words separator chars.

### DetalisationLevel
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/detalisationlevel.md

#### DetalisationLevel enumeration

Specifies the level of comparison details.

```csharp
public enum DetalisationLevel
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Low | `0` | Low level. Provides the best speed comparison sacrificing comparison quality. Comparison is perfromed per-word. |
| Middle | `1` | Middle level. A reasonable compromise between comparison speed and quality. Comparison is perfromed per-character, but ignoring character case and spaces count. |
| High | `2` | High level. The best comparison quality, but the lowest speed. Comparison is perfromed per-character considering character case and spaces count. |

### DiagramMasterSetting
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/diagrammastersetting.md

#### DiagramMasterSetting class

Diagram master settings.

```csharp
public class DiagramMasterSetting
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramMasterSetting() | Initializes a new instance of the `DiagramMasterSetting` class. |

#### Properties

| Name | Description |
| --- | --- |
| MasterPath { get; set; } | Path for Master. Set this value or use default Comparison Master. MasterPath is needed to create a document result from a set of default shapes. |
| UseSourceMaster { get; set; } | Set true for use master with source document or use false value for use Master with Path . |

### DiagramMasterSetting
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/diagrammastersetting/diagrammastersetting.md

#### DiagramMasterSetting constructor

Initializes a new instance of the `DiagramMasterSetting` class.

```csharp
public DiagramMasterSetting()
```

### MasterPath
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/diagrammastersetting/masterpath.md

#### DiagramMasterSetting.MasterPath property

Path for Master. Set this value or use default Comparison Master. MasterPath is needed to create a document result from a set of default shapes.

```csharp
public string MasterPath { get; set; }
```

### UseSourceMaster
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/diagrammastersetting/usesourcemaster.md

#### DiagramMasterSetting.UseSourceMaster property

Set true for use master with source document or use false value for use Master with Path .

```csharp
public bool UseSourceMaster { get; set; }
```

### FileAuthorMetadata
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/fileauthormetadata.md

#### FileAuthorMetadata class

Information about document's author metadata.

```csharp
public class FileAuthorMetadata
```

#### Constructors

| Name | Description |
| --- | --- |
| FileAuthorMetadata() | Initializes a new instance of the `FileAuthorMetadata` class. |

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the author. |
| Company { get; set; } | Gets or sets the company. |
| LastSaveBy { get; set; } | Gets or sets the last save by. |

### Author
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/fileauthormetadata/author.md

#### FileAuthorMetadata.Author property

Gets or sets the author.

```csharp
public string Author { get; set; }
```

### Company
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/fileauthormetadata/company.md

#### FileAuthorMetadata.Company property

Gets or sets the company.

```csharp
public string Company { get; set; }
```

### FileAuthorMetadata
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/fileauthormetadata/fileauthormetadata.md

#### FileAuthorMetadata constructor

Initializes a new instance of the `FileAuthorMetadata` class.

```csharp
public FileAuthorMetadata()
```

### LastSaveBy
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/fileauthormetadata/lastsaveby.md

#### FileAuthorMetadata.LastSaveBy property

Gets or sets the last save by.

```csharp
public string LastSaveBy { get; set; }
```

### FolderComparisonExtension
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/foldercomparisonextension.md

#### FolderComparisonExtension enumeration

Folder extensions.

```csharp
public enum FolderComparisonExtension
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| HTML | `0` | HTML. |
| TXT | `1` | TXT. |

### GetChangeOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/getchangeoptions.md

#### GetChangeOptions class

The option allows to filter changes by type.

```csharp
public class GetChangeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GetChangeOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Filter { get; set; } | Type of changes. |

### Filter
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/getchangeoptions/filter.md

#### GetChangeOptions.Filter property

Type of changes.

```csharp
public ChangeType Filter { get; set; }
```

### GetChangeOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/getchangeoptions/getchangeoptions.md

#### GetChangeOptions constructor

The default constructor.

```csharp
public GetChangeOptions()
```

### IgnoreChangeSensitivitySettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/ignorechangesensitivitysettings.md

#### IgnoreChangeSensitivitySettings class

The option allows to ignore changes by similarity percentage.

```csharp
public class IgnoreChangeSensitivitySettings
```

#### Constructors

| Name | Description |
| --- | --- |
| IgnoreChangeSensitivitySettings() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Ignore { get; set; } | Set ignore option to true or false. |
| IgnorePercent { get; set; } | Gets or sets a sensitivity for ignoring changes. Ignores the change if the similarity is less than the specified value. |

### Ignore
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/ignorechangesensitivitysettings/ignore.md

#### IgnoreChangeSensitivitySettings.Ignore property

Set ignore option to true or false.

```csharp
public bool Ignore { get; set; }
```

### IgnoreChangeSensitivitySettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/ignorechangesensitivitysettings/ignorechangesensitivitysettings.md

#### IgnoreChangeSensitivitySettings constructor

The default constructor.

```csharp
public IgnoreChangeSensitivitySettings()
```

### IgnorePercent
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/ignorechangesensitivitysettings/ignorepercent.md

#### IgnoreChangeSensitivitySettings.IgnorePercent property

Gets or sets a sensitivity for ignoring changes. Ignores the change if the similarity is less than the specified value.

```csharp
public int IgnorePercent { get; set; }
```

### ImagesInheritance
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/imagesinheritance.md

#### ImagesInheritance enumeration

Source of images inheritance when image comparison is disabled.

```csharp
public enum ImagesInheritance
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Source | `0` | Inherit images from source document. |
| Target | `1` | Inherit images from target document. |

### LoadOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/loadoptions.md

#### LoadOptions class

Allows to specify additional options when loading a document.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | Manually set the file type for comparison to override automatic file type detection. |
| FontDirectories { get; set; } | List of font directories to load. |
| LoadText { get; set; } | Indicates that the strings passed are comparison text, not file paths (For Text Comparison only). |
| Password { get; set; } | Password of document. |

### FileType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/loadoptions/filetype.md

#### LoadOptions.FileType property

Manually set the file type for comparison to override automatic file type detection.

```csharp
public FileType FileType { get; set; }
```

### FontDirectories
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/loadoptions/fontdirectories.md

#### LoadOptions.FontDirectories property

List of font directories to load.

```csharp
public List<string> FontDirectories { get; set; }
```

### LoadOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/loadoptions/loadoptions.md

#### LoadOptions constructor

The default constructor.

```csharp
public LoadOptions()
```

### LoadText
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/loadoptions/loadtext.md

#### LoadOptions.LoadText property

Indicates that the strings passed are comparison text, not file paths (For Text Comparison only).

```csharp
public bool LoadText { get; set; }
```

### Password
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/loadoptions/password.md

#### LoadOptions.Password property

Password of document.

```csharp
public string Password { get; set; }
```

### MetadataType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/metadatatype.md

#### MetadataType enumeration

Determines from where result document will take metadata information

```csharp
public enum MetadataType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | Default |
| Source | `1` | Metedata takes from source document |
| Target | `2` | Metadata takes from target document |
| FileAuthor | `3` | Metadata sets by user |

### OriginalSize
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/originalsize.md

#### OriginalSize class

Represents original page size. Used only for comparing image with different formats.

```csharp
public class OriginalSize
```

#### Constructors

| Name | Description |
| --- | --- |
| OriginalSize() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Height of original document |
| Width { get; set; } | Width of original document |

### Height
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/originalsize/height.md

#### OriginalSize.Height property

Height of original document

```csharp
public int Height { get; set; }
```

### OriginalSize
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/originalsize/originalsize.md

#### OriginalSize constructor

The default constructor.

```csharp
public OriginalSize()
```

### Width
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/originalsize/width.md

#### OriginalSize.Width property

Width of original document

```csharp
public int Width { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pagessetup.md

#### PagesSetup class

Specifies which pages to include in the comparison.

```csharp
public class PagesSetup
```

#### Constructors

| Name | Description |
| --- | --- |
| PagesSetup() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| EndPage { get; set; } | Gets or sets the 1-based end page number (inclusive). When null, comparison goes to the last page. |
| StartPage { get; set; } | Gets or sets the 1-based start page number. When null, comparison starts from the first page. |

### EndPage
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pagessetup/endpage.md

#### PagesSetup.EndPage property

Gets or sets the 1-based end page number (inclusive). When null, comparison goes to the last page.

```csharp
public int? EndPage { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pagessetup/pagessetup.md

#### PagesSetup constructor

The default constructor.

```csharp
public PagesSetup()
```

### StartPage
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pagessetup/startpage.md

#### PagesSetup.StartPage property

Gets or sets the 1-based start page number. When null, comparison starts from the first page.

```csharp
public int? StartPage { get; set; }
```

### PaperSize
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/papersize.md

#### PaperSize enumeration

The option to set the Paper size of the result document after comparison.

```csharp
public enum PaperSize
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | Default |
| A0 | `1` | A0 |
| A1 | `2` | A1 |
| A2 | `3` | A2 |
| A3 | `4` | A3 |
| A4 | `5` | A4 |
| A5 | `6` | A5 |
| A6 | `7` | A6 |
| A7 | `8` | A7 |
| A8 | `9` | A8 |

### PasswordSaveOption
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/passwordsaveoption.md

#### PasswordSaveOption enumeration

Specifies the password save option.

```csharp
public enum PasswordSaveOption
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default password. |
| Source | `1` | Source password. |
| Target | `2` | Target password. |
| User | `3` | The user password. |

### PdfCompareOptions.ComparisonDisplayMode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions.comparisondisplaymode.md

#### PdfCompareOptions.ComparisonDisplayMode enumeration

Controls how Pdf comparison result document is laid out.

```csharp
public enum ComparisonDisplayMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Inline | `0` | Default mode. Produces a single merged PDF document where deleted content is highlighted in one color and inserted content in another. Both source and target content coexist on the same pages, which may cause overlap when the documents differ significantly. |
| SideBySide | `1` | Each result page shows a source page and its corresponding target page side by side. Deletions appear on the left (source side) and insertions on the right (target side). Content from the two documents never overlaps, making this mode suitable when the documents differ heavily. |
| Interleaved | `2` | Produces a document with alternating pages: odd-numbered pages come from the source document (showing deletions) and even-numbered pages come from the target document (showing insertions). Open the result in a PDF viewer with "Two Page View" enabled to see each source/target pair side by side on screen. Like SideBySide, this mode prevents content overlap and is best suited for heavily differing documents. |

### PdfCompareOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions.md

#### PdfCompareOptions class

PDF document specific compare options. Inherits common options from `CompareOptions`.

```csharp
public class PdfCompareOptions : CompareOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfCompareOptions() | Initializes a new instance of the `PdfCompareOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AnnotationAuthorName { get; set; } | Gets or sets the author name used for annotations when `DisplayMode` is set to Interleaved. |
| CalculateCoordinates { get; set; } | Indicates whether to calculate coordinates for changed components. |
| CalculateCoordinatesMode { get; set; } | Specifies the coordinate calculation for changed components mode. |
| ChangedItemStyle { get; set; } | Describes style for changed components. |
| CompareImagesPdf { get; set; } | Gets or sets a value indicating whether to compare images in PDF documents. |
| DeletedItemStyle { get; set; } | Describes style for deleted components. |
| DetalisationLevel { get; set; } | Gets or sets the comparison detail level. |
| DetectStyleChanges { get; set; } | Indicates whether to detect style changes or not. |
| DiagramMasterSetting { get; set; } | Gets or sets the path value for master or use compare without path of master. This option only for Diagram. |
| DirectoryCompare { get; set; } | Control to turn on comparison of folders. |
| DisplayMode { get; set; } | Gets or sets how the comparison result document is laid out. The default value is Inline. |
| ExtendedSummaryPage { get; set; } | Indicates whether to add extended file comparison information to the summary page or not. |
| FolderComparisonExtension { get; set; } | Gets or sets the format of the resulting folder comparison file. |
| GenerateSummaryPage { get; set; } | Indicates whether to add summary page with detected changes statistics to resultant document or not. |
| HeaderFootersComparison { get; set; } | Control to turn on comparison of header/footer contents. |
| IgnoreChangeSettings { get; set; } | Gets or sets settings to ignore changes based on similarity. |
| ImagesInheritanceMode { get; set; } | Specifies the source of images inheritance when image comparison is disabled. |
| InsertedItemStyle { get; set; } | Describes style for inserted components. |
| MarkChangedContent { get; set; } | Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents. |
| MarkNestedContent { get; set; } | Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted. |
| OriginalSize { get; set; } | Get or sets the original sizes of compared documents. |
| PagesSetup { get; set; } | Gets or sets the page range to compare. When null, all pages are compared. |
| PaperSize { get; set; } | Gets or sets the result document paper size. |
| PasswordSaveOption { get; set; } | Gets or sets the password save option. |
| SensitivityOfComparison { get; set; } | Gets or sets a sensitivity of comparison. |
| SensitivityOfComparisonForTables { get; set; } | Gets or sets a sensitivity of comparison for tables. |
| ShowDeletedContent { get; set; } | Indicates whether to show deleted components in resultant document or not. |
| ShowInsertedContent { get; set; } | Indicates whether to show inserted components in resultant document or not. |
| ShowOnlyChanged { get; set; } | Controls to enable the display of only changed items. |
| ShowOnlySummaryPage { get; set; } | Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not. |
| UserMasterPath { get; set; } | Path to user master's template for Diagrams. |
| WordsSeparatorChars { set; } | Gets or sets an array of delimiters to split text into words. |

### AnnotationAuthorName
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions/annotationauthorname.md

#### PdfCompareOptions.AnnotationAuthorName property

Gets or sets the author name used for annotations when `DisplayMode` is set to Interleaved.

```csharp
public string AnnotationAuthorName { get; set; }
```

### CompareImagesPdf
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions/compareimagespdf.md

#### PdfCompareOptions.CompareImagesPdf property

Gets or sets a value indicating whether to compare images in PDF documents.

```csharp
public bool CompareImagesPdf { get; set; }
```

### DisplayMode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions/displaymode.md

#### PdfCompareOptions.DisplayMode property

Gets or sets how the comparison result document is laid out. The default value is Inline.

```csharp
public ComparisonDisplayMode DisplayMode { get; set; }
```

### ImagesInheritanceMode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions/imagesinheritancemode.md

#### PdfCompareOptions.ImagesInheritanceMode property

Specifies the source of images inheritance when image comparison is disabled.

```csharp
public ImagesInheritance ImagesInheritanceMode { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions/pagessetup.md

#### PdfCompareOptions.PagesSetup property

Gets or sets the page range to compare. When null, all pages are compared.

```csharp
public PagesSetup PagesSetup { get; set; }
```

### PdfCompareOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/pdfcompareoptions/pdfcompareoptions.md

#### PdfCompareOptions constructor

Initializes a new instance of the `PdfCompareOptions` class.

```csharp
public PdfCompareOptions()
```

### PreviewFormats
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewformats.md

#### PreviewFormats enumeration

Document preview supported formats.

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | Png (by default), can be take a lot of disc space / traffic if page contains a lot of color graphics. |
| JPEG | `1` | Jpeg - faster processing, small disc space using / traffic, but can be worst quality. |
| BMP | `2` | BMP - slow processing, high disc space usage / traffic, but best quality. |

### PreviewOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions.md

#### PreviewOptions class

Represents document preview options.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream) | Initializes a new instance of `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PreviewOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Delegate which defines method to create output page preview stream. |
| Height { get; set; } | Preview height. |
| PageNumbers { get; set; } | Page numbers that will be previewed. |
| PreviewFormat { get; set; } | Preview image format. |
| ReleasePageStream { get; set; } | Delegate which defines method to remove output page preview stream. |
| Resolution { get; set; } | Resolution settings for preview generation. |
| Width { get; set; } | Preview width. |

### CreatePageStream
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/createpagestream.md

#### PreviewOptions.CreatePageStream property

Delegate which defines method to create output page preview stream.

```csharp
public CreatePageStream CreatePageStream { get; set; }
```

### Height
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/height.md

#### PreviewOptions.Height property

Preview height.

```csharp
public int Height { get; set; }
```

### PageNumbers
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Page numbers that will be previewed.

```csharp
public int[] PageNumbers { get; set; }
```

### PreviewFormat
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Preview image format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream)

Initializes a new instance of `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |

#### PreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |
| releasePageStream | ReleasePageStream | Delegate which defines method to release output page preview stream. |

### ReleasePageStream
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/releasepagestream.md

#### PreviewOptions.ReleasePageStream property

Delegate which defines method to remove output page preview stream.

```csharp
public ReleasePageStream ReleasePageStream { get; set; }
```

### Resolution
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/resolution.md

#### PreviewOptions.Resolution property

Resolution settings for preview generation.

```csharp
public PreviewResolution Resolution { get; set; }
```

### Width
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewoptions/width.md

#### PreviewOptions.Width property

Preview width.

```csharp
public int Width { get; set; }
```

### PreviewResolution
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewresolution.md

#### PreviewResolution class

Represents resolution settings for document preview generation.

```csharp
public class PreviewResolution
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewResolution() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| HorizontalResolution { get; set; } | Horizontal resolution in DPI (dots per inch). |
| VerticalResolution { get; set; } | Vertical resolution in DPI (dots per inch). |

### HorizontalResolution
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewresolution/horizontalresolution.md

#### PreviewResolution.HorizontalResolution property

Horizontal resolution in DPI (dots per inch).

```csharp
public float HorizontalResolution { get; set; }
```

### PreviewResolution
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewresolution/previewresolution.md

#### PreviewResolution constructor

The default constructor.

```csharp
public PreviewResolution()
```

### VerticalResolution
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/previewresolution/verticalresolution.md

#### PreviewResolution.VerticalResolution property

Vertical resolution in DPI (dots per inch).

```csharp
public float VerticalResolution { get; set; }
```

### SaveOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/saveoptions.md

#### SaveOptions class

Allows to specify additional options (such as password) when saving a document.

```csharp
public class SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of the `SaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CloneMetadataType { get; set; } | Gets or sets a value indicating whether to clone metadata to target document or not. |
| FileAuthorMetadata { get; set; } | Used when MetadataType is set to FileAuthor. |
| FolderPath { get; set; } | Gets or sets the folder path for saving result images(For Imaging Comparison only). |
| Password { get; set; } | Gets or sets the password for result document. |

### CloneMetadataType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/saveoptions/clonemetadatatype.md

#### SaveOptions.CloneMetadataType property

Gets or sets a value indicating whether to clone metadata to target document or not.

```csharp
public MetadataType CloneMetadataType { get; set; }
```

### FileAuthorMetadata
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/saveoptions/fileauthormetadata.md

#### SaveOptions.FileAuthorMetadata property

Used when MetadataType is set to FileAuthor.

```csharp
public FileAuthorMetadata FileAuthorMetadata { get; set; }
```

### FolderPath
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/saveoptions/folderpath.md

#### SaveOptions.FolderPath property

Gets or sets the folder path for saving result images(For Imaging Comparison only).

```csharp
public string FolderPath { get; set; }
```

### Password
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/saveoptions/password.md

#### SaveOptions.Password property

Gets or sets the password for result document.

```csharp
public string Password { get; set; }
```

### SaveOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/saveoptions/saveoptions.md

#### SaveOptions constructor

Initializes a new instance of the `SaveOptions` class.

```csharp
public SaveOptions()
```

### Size
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/size.md

#### Size class

Document size.

```csharp
public class Size
```

#### Constructors

| Name | Description |
| --- | --- |
| Size() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Height of original document. |
| Width { get; set; } | Width of original document. |

### Height
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/size/height.md

#### Size.Height property

Height of original document.

```csharp
public int Height { get; set; }
```

### Size
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/size/size.md

#### Size constructor

The default constructor.

```csharp
public Size()
```

### Width
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/size/width.md

#### Size.Width property

Width of original document.

```csharp
public int Width { get; set; }
```

### StyleSettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings.md

#### StyleSettings class

Style settings. Allows to define style rules for changes. Used in `CompareOptions` class.

```csharp
public class StyleSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| StyleSettings() | Initializes a new instance of the `StyleSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| BoarderColor { get; set; } | Gets or sets the boarder color. If not set, then the FontColor color is used. |
| EndStringSeparator { get; set; } | Gets or sets the end separator string. |
| FontColor { get; set; } | Gets or sets the font color. |
| HighlightColor { get; set; } | Gets or sets the highlight color. |
| IsBold { get; set; } | Gets or sets a value indicating whether this is bold. |
| IsItalic { get; set; } | Gets or sets a value indicating whether this is italic. |
| IsStrikethrough { get; set; } | Gets or sets a value indicating whether strike through. |
| IsUnderline { get; set; } | Gets or sets a value indicating whether this is underline. |
| OriginalSize { get; set; } | Get or sets the original sizes of comparing documents. |
| ShapeColor { get; set; } | Gets or sets the shape color. If not set, then the FontColor color is used. |
| StartStringSeparator { get; set; } | Gets or sets the begin separator string. |
| WordsSeparators { get; set; } | Gets or sets the words separator chars. |

### BoarderColor
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/boardercolor.md

#### StyleSettings.BoarderColor property

Gets or sets the boarder color. If not set, then the FontColor color is used.

```csharp
public Color BoarderColor { get; set; }
```

### EndStringSeparator
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/endstringseparator.md

#### StyleSettings.EndStringSeparator property

Gets or sets the end separator string.

```csharp
public string EndStringSeparator { get; set; }
```

### FontColor
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/fontcolor.md

#### StyleSettings.FontColor property

Gets or sets the font color.

```csharp
public Color FontColor { get; set; }
```

### HighlightColor
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/highlightcolor.md

#### StyleSettings.HighlightColor property

Gets or sets the highlight color.

```csharp
public Color HighlightColor { get; set; }
```

### IsBold
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/isbold.md

#### StyleSettings.IsBold property

Gets or sets a value indicating whether this is bold.

```csharp
public bool IsBold { get; set; }
```

### IsItalic
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/isitalic.md

#### StyleSettings.IsItalic property

Gets or sets a value indicating whether this is italic.

```csharp
public bool IsItalic { get; set; }
```

### IsStrikethrough
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/isstrikethrough.md

#### StyleSettings.IsStrikethrough property

Gets or sets a value indicating whether strike through.

```csharp
public bool IsStrikethrough { get; set; }
```

### IsUnderline
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/isunderline.md

#### StyleSettings.IsUnderline property

Gets or sets a value indicating whether this is underline.

```csharp
public bool IsUnderline { get; set; }
```

### OriginalSize
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/originalsize.md

#### StyleSettings.OriginalSize property

Get or sets the original sizes of comparing documents.

```csharp
public Size OriginalSize { get; set; }
```

### ShapeColor
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/shapecolor.md

#### StyleSettings.ShapeColor property

Gets or sets the shape color. If not set, then the FontColor color is used.

```csharp
public Color ShapeColor { get; set; }
```

### StartStringSeparator
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/startstringseparator.md

#### StyleSettings.StartStringSeparator property

Gets or sets the begin separator string.

```csharp
public string StartStringSeparator { get; set; }
```

### StyleSettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/stylesettings.md

#### StyleSettings constructor

Initializes a new instance of the `StyleSettings` class.

```csharp
public StyleSettings()
```

### WordsSeparators
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/stylesettings/wordsseparators.md

#### StyleSettings.WordsSeparators property

Gets or sets the words separator chars.

```csharp
public char[] WordsSeparators { get; set; }
```

### WordCompareOptions.ComparisonDisplayMode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions.comparisondisplaymode.md

#### WordCompareOptions.ComparisonDisplayMode enumeration

Defines how Word comparison results are displayed for `WordCompareOptions`.

```csharp
public enum ComparisonDisplayMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Revisions | `0` | Default behavior: use Word's built-in Track Changes mode and show differences as revisions. |
| Highlight | `1` | Render differences as highlighted content directly in the document instead of using Track Changes. |

### WordCompareOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions.md

#### WordCompareOptions class

Word document specific compare options. Inherits common options from `CompareOptions`.

```csharp
public class WordCompareOptions : CompareOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordCompareOptions() | Initializes a new instance of the `WordCompareOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CalculateCoordinates { get; set; } | Indicates whether to calculate coordinates for changed components. |
| CalculateCoordinatesMode { get; set; } | Specifies the coordinate calculation for changed components mode. |
| ChangedItemStyle { get; set; } | Describes style for changed components. |
| CompareBookmarks { get; set; } | Gets or sets whether bookmarks in the source and target documents are compared and differences included in the result. |
| CompareDocumentProperty { get; set; } | Gets or sets whether built-in and custom document properties are compared and differences included in the result (e.g. on the properties summary page). |
| CompareVariableProperty { get; set; } | Gets or sets whether document variable properties (e.g. DOCVARIABLE fields) are compared and differences included in the result. |
| DeletedItemStyle { get; set; } | Describes style for deleted components. |
| DetalisationLevel { get; set; } | Gets or sets the comparison detail level. |
| DetectStyleChanges { get; set; } | Indicates whether to detect style changes or not. |
| DiagramMasterSetting { get; set; } | Gets or sets the path value for master or use compare without path of master. This option only for Diagram. |
| DirectoryCompare { get; set; } | Control to turn on comparison of folders. |
| DisplayMode { get; set; } | Gets or sets how comparison results are displayed: as Word revisions in Track Changes mode (Revisions) or as highlighted changes rendered directly into the document (Highlight). |
| ExtendedSummaryPage { get; set; } | Indicates whether to add extended file comparison information to the summary page or not. |
| FolderComparisonExtension { get; set; } | Gets or sets the format of the resulting folder comparison file. |
| GenerateSummaryPage { get; set; } | Indicates whether to add summary page with detected changes statistics to resultant document or not. |
| HeaderFootersComparison { get; set; } | Control to turn on comparison of header/footer contents. |
| IgnoreChangeSettings { get; set; } | Gets or sets settings to ignore changes based on similarity. |
| InsertedItemStyle { get; set; } | Describes style for inserted components. |
| LeaveGaps { get; set; } | Gets or sets whether empty lines are left in place of inserted or deleted content to preserve layout and line count; used with `ShowInsertedContent` and `ShowDeletedContent`. |
| MarkChangedContent { get; set; } | Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents. |
| MarkLineBreaks { get; set; } | Gets or sets whether paragraph (line) breaks that differ between documents are visually marked in the result. |
| MarkNestedContent { get; set; } | Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted. |
| OriginalSize { get; set; } | Get or sets the original sizes of compared documents. |
| PaperSize { get; set; } | Gets or sets the result document paper size. |
| PasswordSaveOption { get; set; } | Gets or sets the password save option. |
| RevisionAuthorName { get; set; } | Gets or sets the author name used for revisions when !:WordTrackChanges is enabled. If set, this name is applied to revision markup in the result document. |
| SensitivityOfComparison { get; set; } | Gets or sets a sensitivity of comparison. |
| SensitivityOfComparisonForTables { get; set; } | Gets or sets a sensitivity of comparison for tables. |
| ShowDeletedContent { get; set; } | Indicates whether to show deleted components in resultant document or not. |
| ShowInsertedContent { get; set; } | Indicates whether to show inserted components in resultant document or not. |
| ShowOnlyChanged { get; set; } | Controls to enable the display of only changed items. |
| ShowOnlySummaryPage { get; set; } | Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not. |
| ShowRevisions { get; set; } | Gets or sets whether the result document keeps revision markup visible. If false, all revisions are accepted and the result appears as final text. This setting is meaningful only when `DisplayMode` is set to Highlight. The default value is true. |
| UserMasterPath { get; set; } | Path to user master's template for Diagrams. |
| WordsSeparatorChars { set; } | Gets or sets an array of delimiters to split text into words. |

### CompareBookmarks
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/comparebookmarks.md

#### WordCompareOptions.CompareBookmarks property

Gets or sets whether bookmarks in the source and target documents are compared and differences included in the result.

```csharp
public bool CompareBookmarks { get; set; }
```

### CompareDocumentProperty
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/comparedocumentproperty.md

#### WordCompareOptions.CompareDocumentProperty property

Gets or sets whether built-in and custom document properties are compared and differences included in the result (e.g. on the properties summary page).

```csharp
public bool CompareDocumentProperty { get; set; }
```

### CompareVariableProperty
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/comparevariableproperty.md

#### WordCompareOptions.CompareVariableProperty property

Gets or sets whether document variable properties (e.g. DOCVARIABLE fields) are compared and differences included in the result.

```csharp
public bool CompareVariableProperty { get; set; }
```

### DisplayMode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/displaymode.md

#### WordCompareOptions.DisplayMode property

Gets or sets how comparison results are displayed: as Word revisions in Track Changes mode (Revisions) or as highlighted changes rendered directly into the document (Highlight).

```csharp
public ComparisonDisplayMode DisplayMode { get; set; }
```

### LeaveGaps
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/leavegaps.md

#### WordCompareOptions.LeaveGaps property

Gets or sets whether empty lines are left in place of inserted or deleted content to preserve layout and line count; used with `ShowInsertedContent` and `ShowDeletedContent`.

```csharp
public bool LeaveGaps { get; set; }
```

### MarkLineBreaks
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/marklinebreaks.md

#### WordCompareOptions.MarkLineBreaks property

Gets or sets whether paragraph (line) breaks that differ between documents are visually marked in the result.

```csharp
public bool MarkLineBreaks { get; set; }
```

### RevisionAuthorName
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/revisionauthorname.md

#### WordCompareOptions.RevisionAuthorName property

Gets or sets the author name used for revisions when !:WordTrackChanges is enabled. If set, this name is applied to revision markup in the result document.

```csharp
public string RevisionAuthorName { get; set; }
```

### ShowRevisions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/showrevisions.md

#### WordCompareOptions.ShowRevisions property

Gets or sets whether the result document keeps revision markup visible. If false, all revisions are accepted and the result appears as final text. This setting is meaningful only when `DisplayMode` is set to Highlight. The default value is true.

```csharp
public bool ShowRevisions { get; set; }
```

### WordCompareOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.options/wordcompareoptions/wordcompareoptions.md

#### WordCompareOptions constructor

Initializes a new instance of the `WordCompareOptions` class.

```csharp
public WordCompareOptions()
```

### GroupDocs.Comparison.Result
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result.md

The namespace provides classes which represents the comparison results.

#### Classes

| Class | Description |
| --- | --- |
| ChangeInfo | Represents information about change. |
| FileType | Represents file type. Provides methods to obtain list of all file types supported by GroupDocs.Comparison, detect file type by extension etc. |
| PageInfo | Represents information about page's size and number. |
| StyleChangeInfo | Represents information about style change. |
#### Structures

| Structure | Description |
| --- | --- |
| Rectangle | Rectangle model. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ComparisonAction | An action that can be applied to change. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### ChangeInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo.md

#### ChangeInfo class

Represents information about change.

```csharp
public class ChangeInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| ChangeInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Authors { get; set; } | List of Authors. |
| Box { get; set; } | Coordinates of changed element. |
| Column { get; set; } | Zero-based column index of the changed cell. Populated for Cells comparer (XLSX, CSV, ODS, etc.), null otherwise. |
| ColumnHeader { get; set; } | Column header text taken from the first row of the worksheet for the corresponding column. Populated for Cells comparer when the first row contains header values, null otherwise. |
| ComparisonAction { get; set; } | Action (accept or reject). This field tells comparison what to do with this change. |
| ComponentType { get; set; } | Type of changed component. |
| Id { get; set; } | Id of change. |
| PageInfo { get; set; } | Page where current change is placed. |
| Row { get; set; } | Zero-based row index of the changed cell. Populated for Cells comparer (XLSX, CSV, ODS, etc.), null otherwise. |
| SourceText { get; set; } | Changed text of source document. |
| StyleChanges { get; set; } | Array of style changes. |
| TargetText { get; set; } | Changed text of target document. |
| Text { get; set; } | Text value of change. |
| Type { get; } | Type of change. |

### Authors
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/authors.md

#### ChangeInfo.Authors property

List of Authors.

```csharp
public List<string> Authors { get; set; }
```

### Box
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/box.md

#### ChangeInfo.Box property

Coordinates of changed element.

```csharp
public Rectangle Box { get; set; }
```

### ChangeInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/changeinfo.md

#### ChangeInfo constructor

The default constructor.

```csharp
public ChangeInfo()
```

### Column
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/column.md

#### ChangeInfo.Column property

Zero-based column index of the changed cell. Populated for Cells comparer (XLSX, CSV, ODS, etc.), null otherwise.

```csharp
public int? Column { get; set; }
```

### ColumnHeader
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/columnheader.md

#### ChangeInfo.ColumnHeader property

Column header text taken from the first row of the worksheet for the corresponding column. Populated for Cells comparer when the first row contains header values, null otherwise.

```csharp
public string ColumnHeader { get; set; }
```

### ComparisonAction
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/comparisonaction.md

#### ChangeInfo.ComparisonAction property

Action (accept or reject). This field tells comparison what to do with this change.

```csharp
public ComparisonAction ComparisonAction { get; set; }
```

### ComponentType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/componenttype.md

#### ChangeInfo.ComponentType property

Type of changed component.

```csharp
public string ComponentType { get; set; }
```

### Id
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/id.md

#### ChangeInfo.Id property

Id of change.

```csharp
public int Id { get; set; }
```

### PageInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/pageinfo.md

#### ChangeInfo.PageInfo property

Page where current change is placed.

```csharp
public PageInfo PageInfo { get; set; }
```

### Row
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/row.md

#### ChangeInfo.Row property

Zero-based row index of the changed cell. Populated for Cells comparer (XLSX, CSV, ODS, etc.), null otherwise.

```csharp
public int? Row { get; set; }
```

### SourceText
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/sourcetext.md

#### ChangeInfo.SourceText property

Changed text of source document.

```csharp
public string SourceText { get; set; }
```

### StyleChanges
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/stylechanges.md

#### ChangeInfo.StyleChanges property

Array of style changes.

```csharp
public StyleChangeInfo[] StyleChanges { get; set; }
```

### TargetText
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/targettext.md

#### ChangeInfo.TargetText property

Changed text of target document.

```csharp
public string TargetText { get; set; }
```

### Text
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/text.md

#### ChangeInfo.Text property

Text value of change.

```csharp
public string Text { get; set; }
```

### Type
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/changeinfo/type.md

#### ChangeInfo.Type property

Type of change.

```csharp
public ChangeType Type { get; }
```

### ComparisonAction
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/comparisonaction.md

#### ComparisonAction enumeration

An action that can be applied to change.

```csharp
public enum ComparisonAction
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Nothing to do |
| Accept | `1` | Change will be visible on result file |
| Reject | `2` | Reject will be invisible on result file |

### FileType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype.md

#### FileType class

Represents file type. Provides methods to obtain list of all file types supported by GroupDocs.Comparison, detect file type by extension etc.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | File extention |
| FileFormat { get; } | File format |

#### Methods

| Name | Description |
| --- | --- |
| static FromFileNameOrExtension(string) | Return FileType based on file name or extension |
| Equals(FileType) | File type equivalence check |
| override Equals(object) | Equivalence check with object |
| override GetHashCode() | Get hash code |
| override ToString() | ToString |
| static GetSupportedFileTypes() | Get supported file types enumeration |
| operator == | Operator overload |
| operator != | Operator overload |

#### Fields

| Name | Description |
| --- | --- |
| static readonly AS | ActionScript Programming Language format |
| static readonly AS3 | ActionScript Programming Language format |
| static readonly ASM | ASM format |
| static readonly BASH | Type of interpreter that processes shell commands |
| static readonly BASHRC | File determines the behavior of interactive shells |
| static readonly BAT | Script file in DOS, OS/2 and Microsoft Windows |
| static readonly BMP | Bitmap Picture |
| static readonly BOWERRC | Configuration file for package control on the server-side |
| static readonly C | C-Based Programming Language format |
| static readonly CAD | CAD file format |
| static readonly CAKE | CSharp cross-platform build automation system format |
| static readonly CC | C-Based Programming Language format |
| static readonly CFG | Configuration file used for storing settings |
| static readonly CMAKE | Tool for managing the build process of software |
| static readonly CMD | Script file in DOS, OS/2 and Microsoft Windows |
| static readonly CONF | Configuration file used on Unix and Linux based systems |
| static readonly CPP | C-Based Programming Language format |
| static readonly CPY | Controller Python Script format |
| static readonly CS | CSharp Programming Language format |
| static readonly CSV | Comma Separated Values File |
| static readonly CSX | CSharp script file format |
| static readonly CTP | CakePHP Template format |
| static readonly CXX | C-Based Programming Language format |
| static readonly DCM | Digital Imaging and Communications in Medicine |
| static readonly DIFF | Data comparison tool format |
| static readonly DIR | Directory is a location for storing files on computer |
| static readonly DJVU | Deja Vu format |
| static readonly DOC | Microsoft Word 97-2003 Document |
| static readonly DOCM | Microsoft Word Macro-Enabled Document |
| static readonly DOCX | Microsoft Word Document |
| static readonly DOT | Microsoft Word 97-2003 Template |
| static readonly DOTM | Microsoft Word Macro-Enabled Template |
| static readonly DOTX | Microsoft Word Template |
| static readonly DSQL | Dynamic Structured Query Language format |
| static readonly DWG | Autodesk Design Data Formats |
| static readonly DXF | AutoCAD Drawing Interchange |
| static readonly EBUILD | Specialized bash script which automates compilation and installation procedures for software packages |
| static readonly EML | E-mail Message |
| static readonly EMLX | Apple Mail E-mail File |
| static readonly ERB | Ruby Programming Language format |
| static readonly ES6 | JavaScript standardised scripting language format |
| static readonly GEMSPEC | Developer file that specifies the attributes of a RubyGems |
| static readonly GIF | Graphics Interchange Format |
| static readonly GRADLE | Build-automation system format |
| static readonly GROOVY | Source code file written in Groovy format |
| static readonly GVY | Source code file written in Groovy format |
| static readonly GYP | Build automation tool format |
| static readonly GYPI | Build automation tool format |
| static readonly H | C-Based header files contain definitions of Functions and Variables |
| static readonly HAML | Markup language for simplified HTML generation |
| static readonly HAR | The HTTP Archive format |
| static readonly HH | Header information referenced by a C++ source code file |
| static readonly HPP | Header Files that are written in the C++ programming language |
| static readonly HTML | HyperText Markup Language |
| static readonly HXX | Header Files that are written in the C++ programming language |
| static readonly IPY | IPython Script format |
| static readonly JAVA | Java Programming Language format |
| static readonly JPEG | Joint Photographic Experts Group |
| static readonly JS | JavaScript Programming Language format |
| static readonly JSCSRC | JavaScript configuration file format |
| static readonly JSHINTRC | JavaScript code quality tool |
| static readonly JSMAP | JSON file that contains information on how to translate code back to source code |
| static readonly JSON | Lightweight format for storing and transporting data |
| static readonly LESS | Dynamic preprocessor style sheet language format |
| static readonly LOG | Logging keeps a registry of events, processes, messages and communication |
| static readonly MAKE | Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal |
| static readonly MARKDN | Markdown Language format |
| static readonly MARKDOWN | Markdown Language format |
| static readonly MD | Markdown Language format |
| static readonly MDOWN | Markdown Language format |
| static readonly MDTEXT | Markdown Language format |
| static readonly MDTXT | Markdown Language format |
| static readonly MDWN | Markdown Language format |
| static readonly MHTML | Mime HTML |
| static readonly MJS | Extension for EcmaScript (ES) module files |
| static readonly MK | Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal |
| static readonly MKD | Markdown Language format |
| static readonly ML | Caml Programming Language format |
| static readonly MLI | Caml Programming Language format |
| static readonly MOBI | Mobipocket e-book format |
| static readonly MSG | Microsoft Outlook E-mail Message |
| static readonly NQP | Intermediate language used to build the Rakudo Perl 6 compiler |
| static readonly OBJC | Objective-C Programming Language format |
| static readonly OBJCP | Objective-C++ Programming Language format |
| static readonly ODP | OpenDocument Presentation |
| static readonly ODS | OpenDocument Spreadsheet |
| static readonly ODT | OpenDocument Text |
| static readonly ONE | Microsoft OneNote Document |
| static readonly OTP | OpenDocument Presentation Template |
| static readonly OTT | OpenDocument Text Template |
| static readonly P6 | Perl Programming Language format |
| static readonly PAC | Proxy Auto-Configuration file for JavaScript function format |
| static readonly PATCH | List of differences format |
| static readonly PDF | Adobe Portable Document format |
| static readonly PHP | PHP Programming Language format |
| static readonly PHP4 | PHP Programming Language format |
| static readonly PHP5 | PHP Programming Language format |
| static readonly PHTML | Standard file extension for PHP 2 programs format |
| static readonly PL | Perl Programming Language format |
| static readonly PL6 | Perl Programming Language format |
| static readonly PM | Perl module format |
| static readonly PM6 | Perl module format |
| static readonly PNG | Portable Network Graphics |
| static readonly POD | Perl lightweight markup language format |
| static readonly PODSPEC | Ruby build settings format |
| static readonly POT | Microsoft PowerPoint template |
| static readonly POTX | Microsoft PowerPoint Template |
| static readonly PPS | Microsoft PowerPoint 97-2003 Slide Show |
| static readonly PPSX | Microsoft PowerPoint Slide Show |
| static readonly PPT | Microsoft PowerPoint 97-2003 Presentation |
| static readonly PPTX | Microsoft PowerPoint Presentation |
| static readonly PROP | Properties file format |
| static readonly PSGI | Interface between web servers and web applications and frameworks written in the Perl programming |
| static readonly PY | Python Programming Language format |
| static readonly PYI | Python Interface file format |
| static readonly PYW | Files used in Windows to indicate a script needs to be run |
| static readonly RAKE | Ruby build automation tool |
| static readonly RB | Ruby Programming Language format |
| static readonly RBI | Ruby Interface file format |
| static readonly REJ | Rejected files format |
| static readonly RJS | Ruby Programming Language format |
| static readonly RPY | Python-based file engine to create and run games |
| static readonly RST | Lightweight markup language |
| static readonly RTF | Rich Text Document |
| static readonly RU | Rack configuration file format |
| static readonly SASS | Style sheet language format |
| static readonly SBT | SBT build tool for Scala format |
| static readonly SC | Scala worksheet format |
| static readonly SCALA | Scala Programming Language format |
| static readonly SCSS | Style sheet language format |
| static readonly SH | Script programmed for bash format |
| static readonly SQL | Structured Query Language format |
| static readonly SVG | Scalar Vector Graphics |
| static readonly T | Perl test file format |
| static readonly TXT | Plain Text Document |
| static readonly UNKNOWN | Unknown type |
| static readonly VDX | Microsoft Visio 2003-2010 XML Drawing |
| static readonly VIM | Vim source code file format |
| static readonly VSD | Microsoft Visio 2003-2010 Drawing |
| static readonly VSDX | Microsoft Visio Drawing |
| static readonly VSS | Microsoft Visio 2003-2010 Stencil |
| static readonly VST | Microsoft Visio 2003-2010 Template |
| static readonly WEBMANIFEST | Manifest file includes information about the app |
| static readonly XLS | Microsoft Excel 97-2003 Worksheet |
| static readonly XLSB | Microsoft Excel Binary Worksheet |
| static readonly XLSM | Microsoft Excel Macro-Enabled Worksheet |
| static readonly XLSX | Microsoft Excel Worksheet |
| static readonly XLT | Microsoft Excel template |
| static readonly XLTM | Microsoft Excel macro-enabled template |
| static readonly YAML | Human-readable data-serialization language format |
| static readonly YML | Human-readable data-serialization language format |

### AS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/as.md

#### FileType.AS field

ActionScript Programming Language format

```csharp
public static readonly FileType AS;
```

### AS3
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/as3.md

#### FileType.AS3 field

ActionScript Programming Language format

```csharp
public static readonly FileType AS3;
```

### ASM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/asm.md

#### FileType.ASM field

ASM format

```csharp
public static readonly FileType ASM;
```

### BASH
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/bash.md

#### FileType.BASH field

Type of interpreter that processes shell commands

```csharp
public static readonly FileType BASH;
```

### BASHRC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/bashrc.md

#### FileType.BASHRC field

File determines the behavior of interactive shells

```csharp
public static readonly FileType BASHRC;
```

### BAT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/bat.md

#### FileType.BAT field

Script file in DOS, OS/2 and Microsoft Windows

```csharp
public static readonly FileType BAT;
```

### BMP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/bmp.md

#### FileType.BMP field

Bitmap Picture

```csharp
public static readonly FileType BMP;
```

### BOWERRC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/bowerrc.md

#### FileType.BOWERRC field

Configuration file for package control on the server-side

```csharp
public static readonly FileType BOWERRC;
```

### C
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/c.md

#### FileType.C field

C-Based Programming Language format

```csharp
public static readonly FileType C;
```

### CAD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cad.md

#### FileType.CAD field

CAD file format

```csharp
public static readonly FileType CAD;
```

### CAKE
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cake.md

#### FileType.CAKE field

CSharp cross-platform build automation system format

```csharp
public static readonly FileType CAKE;
```

### CC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cc.md

#### FileType.CC field

C-Based Programming Language format

```csharp
public static readonly FileType CC;
```

### CFG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cfg.md

#### FileType.CFG field

Configuration file used for storing settings

```csharp
public static readonly FileType CFG;
```

### CMAKE
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cmake.md

#### FileType.CMAKE field

Tool for managing the build process of software

```csharp
public static readonly FileType CMAKE;
```

### CMD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cmd.md

#### FileType.CMD field

Script file in DOS, OS/2 and Microsoft Windows

```csharp
public static readonly FileType CMD;
```

### CONF
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/conf.md

#### FileType.CONF field

Configuration file used on Unix and Linux based systems

```csharp
public static readonly FileType CONF;
```

### CPP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cpp.md

#### FileType.CPP field

C-Based Programming Language format

```csharp
public static readonly FileType CPP;
```

### CPY
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cpy.md

#### FileType.CPY field

Controller Python Script format

```csharp
public static readonly FileType CPY;
```

### CS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cs.md

#### FileType.CS field

CSharp Programming Language format

```csharp
public static readonly FileType CS;
```

### CSV
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/csv.md

#### FileType.CSV field

Comma Separated Values File

```csharp
public static readonly FileType CSV;
```

### CSX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/csx.md

#### FileType.CSX field

CSharp script file format

```csharp
public static readonly FileType CSX;
```

### CTP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ctp.md

#### FileType.CTP field

CakePHP Template format

```csharp
public static readonly FileType CTP;
```

### CXX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/cxx.md

#### FileType.CXX field

C-Based Programming Language format

```csharp
public static readonly FileType CXX;
```

### DCM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dcm.md

#### FileType.DCM field

Digital Imaging and Communications in Medicine

```csharp
public static readonly FileType DCM;
```

### DIFF
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/diff.md

#### FileType.DIFF field

Data comparison tool format

```csharp
public static readonly FileType DIFF;
```

### DIR
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dir.md

#### FileType.DIR field

Directory is a location for storing files on computer

```csharp
public static readonly FileType DIR;
```

### DJVU
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/djvu.md

#### FileType.DJVU field

Deja Vu format

```csharp
public static readonly FileType DJVU;
```

### DOC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/doc.md

#### FileType.DOC field

Microsoft Word 97-2003 Document

```csharp
public static readonly FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/docm.md

#### FileType.DOCM field

Microsoft Word Macro-Enabled Document

```csharp
public static readonly FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/docx.md

#### FileType.DOCX field

Microsoft Word Document

```csharp
public static readonly FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dot.md

#### FileType.DOT field

Microsoft Word 97-2003 Template

```csharp
public static readonly FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dotm.md

#### FileType.DOTM field

Microsoft Word Macro-Enabled Template

```csharp
public static readonly FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dotx.md

#### FileType.DOTX field

Microsoft Word Template

```csharp
public static readonly FileType DOTX;
```

### DSQL
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dsql.md

#### FileType.DSQL field

Dynamic Structured Query Language format

```csharp
public static readonly FileType DSQL;
```

### DWG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dwg.md

#### FileType.DWG field

Autodesk Design Data Formats

```csharp
public static readonly FileType DWG;
```

### DXF
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/dxf.md

#### FileType.DXF field

AutoCAD Drawing Interchange

```csharp
public static readonly FileType DXF;
```

### EBUILD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ebuild.md

#### FileType.EBUILD field

Specialized bash script which automates compilation and installation procedures for software packages

```csharp
public static readonly FileType EBUILD;
```

### EML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/eml.md

#### FileType.EML field

E-mail Message

```csharp
public static readonly FileType EML;
```

### EMLX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/emlx.md

#### FileType.EMLX field

Apple Mail E-mail File

```csharp
public static readonly FileType EMLX;
```

### Equals
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/equals.md

#### Equals(FileType)

File type equivalence check

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | FileType object |

##### Return Value

True if file types are equivalent, false if not

#### Equals(object)

Equivalence check with object

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Any object |

##### Return Value

True if file types is equivalent, false if not

### ERB
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/erb.md

#### FileType.ERB field

Ruby Programming Language format

```csharp
public static readonly FileType ERB;
```

### ES6
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/es6.md

#### FileType.ES6 field

JavaScript standardised scripting language format

```csharp
public static readonly FileType ES6;
```

### Extension
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/extension.md

#### FileType.Extension property

File extention

```csharp
public string Extension { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/fileformat.md

#### FileType.FileFormat property

File format

```csharp
public string FileFormat { get; }
```

### FromFileNameOrExtension
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/fromfilenameorextension.md

#### FileType.FromFileNameOrExtension method

Return FileType based on file name or extension

```csharp
public static FileType FromFileNameOrExtension(string fileNameOrExtension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileNameOrExtension | String | File name or extension |

### GEMSPEC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gemspec.md

#### FileType.GEMSPEC field

Developer file that specifies the attributes of a RubyGems

```csharp
public static readonly FileType GEMSPEC;
```

### GetHashCode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gethashcode.md

#### FileType.GetHashCode method

Get hash code

```csharp
public override int GetHashCode()
```

##### Return Value

Hash code

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Get supported file types enumeration

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Enumeration of FileType

### GIF
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gif.md

#### FileType.GIF field

Graphics Interchange Format

```csharp
public static readonly FileType GIF;
```

### GRADLE
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gradle.md

#### FileType.GRADLE field

Build-automation system format

```csharp
public static readonly FileType GRADLE;
```

### GROOVY
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/groovy.md

#### FileType.GROOVY field

Source code file written in Groovy format

```csharp
public static readonly FileType GROOVY;
```

### GVY
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gvy.md

#### FileType.GVY field

Source code file written in Groovy format

```csharp
public static readonly FileType GVY;
```

### GYP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gyp.md

#### FileType.GYP field

Build automation tool format

```csharp
public static readonly FileType GYP;
```

### GYPI
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/gypi.md

#### FileType.GYPI field

Build automation tool format

```csharp
public static readonly FileType GYPI;
```

### H
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/h.md

#### FileType.H field

C-Based header files contain definitions of Functions and Variables

```csharp
public static readonly FileType H;
```

### HAML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/haml.md

#### FileType.HAML field

Markup language for simplified HTML generation

```csharp
public static readonly FileType HAML;
```

### HAR
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/har.md

#### FileType.HAR field

The HTTP Archive format

```csharp
public static readonly FileType HAR;
```

### HH
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/hh.md

#### FileType.HH field

Header information referenced by a C++ source code file

```csharp
public static readonly FileType HH;
```

### HPP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/hpp.md

#### FileType.HPP field

Header Files that are written in the C++ programming language

```csharp
public static readonly FileType HPP;
```

### HTML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/html.md

#### FileType.HTML field

HyperText Markup Language

```csharp
public static readonly FileType HTML;
```

### HXX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/hxx.md

#### FileType.HXX field

Header Files that are written in the C++ programming language

```csharp
public static readonly FileType HXX;
```

### IPY
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ipy.md

#### FileType.IPY field

IPython Script format

```csharp
public static readonly FileType IPY;
```

### JAVA
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/java.md

#### FileType.JAVA field

Java Programming Language format

```csharp
public static readonly FileType JAVA;
```

### JPEG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/jpeg.md

#### FileType.JPEG field

Joint Photographic Experts Group

```csharp
public static readonly FileType JPEG;
```

### JS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/js.md

#### FileType.JS field

JavaScript Programming Language format

```csharp
public static readonly FileType JS;
```

### JSCSRC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/jscsrc.md

#### FileType.JSCSRC field

JavaScript configuration file format

```csharp
public static readonly FileType JSCSRC;
```

### JSHINTRC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/jshintrc.md

#### FileType.JSHINTRC field

JavaScript code quality tool

```csharp
public static readonly FileType JSHINTRC;
```

### JSMAP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/jsmap.md

#### FileType.JSMAP field

JSON file that contains information on how to translate code back to source code

```csharp
public static readonly FileType JSMAP;
```

### JSON
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/json.md

#### FileType.JSON field

Lightweight format for storing and transporting data

```csharp
public static readonly FileType JSON;
```

### LESS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/less.md

#### FileType.LESS field

Dynamic preprocessor style sheet language format

```csharp
public static readonly FileType LESS;
```

### LOG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/log.md

#### FileType.LOG field

Logging keeps a registry of events, processes, messages and communication

```csharp
public static readonly FileType LOG;
```

### MAKE
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/make.md

#### FileType.MAKE field

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

```csharp
public static readonly FileType MAKE;
```

### MARKDN
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/markdn.md

#### FileType.MARKDN field

Markdown Language format

```csharp
public static readonly FileType MARKDN;
```

### MARKDOWN
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/markdown.md

#### FileType.MARKDOWN field

Markdown Language format

```csharp
public static readonly FileType MARKDOWN;
```

### MD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/md.md

#### FileType.MD field

Markdown Language format

```csharp
public static readonly FileType MD;
```

### MDOWN
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mdown.md

#### FileType.MDOWN field

Markdown Language format

```csharp
public static readonly FileType MDOWN;
```

### MDTEXT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mdtext.md

#### FileType.MDTEXT field

Markdown Language format

```csharp
public static readonly FileType MDTEXT;
```

### MDTXT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mdtxt.md

#### FileType.MDTXT field

Markdown Language format

```csharp
public static readonly FileType MDTXT;
```

### MDWN
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mdwn.md

#### FileType.MDWN field

Markdown Language format

```csharp
public static readonly FileType MDWN;
```

### MHTML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mhtml.md

#### FileType.MHTML field

Mime HTML

```csharp
public static readonly FileType MHTML;
```

### MJS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mjs.md

#### FileType.MJS field

Extension for EcmaScript (ES) module files

```csharp
public static readonly FileType MJS;
```

### MK
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mk.md

#### FileType.MK field

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

```csharp
public static readonly FileType MK;
```

### MKD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mkd.md

#### FileType.MKD field

Markdown Language format

```csharp
public static readonly FileType MKD;
```

### ML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ml.md

#### FileType.ML field

Caml Programming Language format

```csharp
public static readonly FileType ML;
```

### MLI
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mli.md

#### FileType.MLI field

Caml Programming Language format

```csharp
public static readonly FileType MLI;
```

### MOBI
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/mobi.md

#### FileType.MOBI field

Mobipocket e-book format

```csharp
public static readonly FileType MOBI;
```

### MSG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/msg.md

#### FileType.MSG field

Microsoft Outlook E-mail Message

```csharp
public static readonly FileType MSG;
```

### NQP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/nqp.md

#### FileType.NQP field

Intermediate language used to build the Rakudo Perl 6 compiler

```csharp
public static readonly FileType NQP;
```

### OBJC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/objc.md

#### FileType.OBJC field

Objective-C Programming Language format

```csharp
public static readonly FileType OBJC;
```

### OBJCP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/objcp.md

#### FileType.OBJCP field

Objective-C++ Programming Language format

```csharp
public static readonly FileType OBJCP;
```

### ODP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/odp.md

#### FileType.ODP field

OpenDocument Presentation

```csharp
public static readonly FileType ODP;
```

### ODS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ods.md

#### FileType.ODS field

OpenDocument Spreadsheet

```csharp
public static readonly FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/odt.md

#### FileType.ODT field

OpenDocument Text

```csharp
public static readonly FileType ODT;
```

### ONE
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/one.md

#### FileType.ONE field

Microsoft OneNote Document

```csharp
public static readonly FileType ONE;
```

### op_Equality
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/op_equality.md

#### FileType Equality operator

Operator overload

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

### op_Inequality
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/op_inequality.md

#### FileType Inequality operator

Operator overload

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

### OTP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/otp.md

#### FileType.OTP field

OpenDocument Presentation Template

```csharp
public static readonly FileType OTP;
```

### OTT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ott.md

#### FileType.OTT field

OpenDocument Text Template

```csharp
public static readonly FileType OTT;
```

### P6
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/p6.md

#### FileType.P6 field

Perl Programming Language format

```csharp
public static readonly FileType P6;
```

### PAC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pac.md

#### FileType.PAC field

Proxy Auto-Configuration file for JavaScript function format

```csharp
public static readonly FileType PAC;
```

### PATCH
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/patch.md

#### FileType.PATCH field

List of differences format

```csharp
public static readonly FileType PATCH;
```

### PDF
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pdf.md

#### FileType.PDF field

Adobe Portable Document format

```csharp
public static readonly FileType PDF;
```

### PHP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/php.md

#### FileType.PHP field

PHP Programming Language format

```csharp
public static readonly FileType PHP;
```

### PHP4
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/php4.md

#### FileType.PHP4 field

PHP Programming Language format

```csharp
public static readonly FileType PHP4;
```

### PHP5
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/php5.md

#### FileType.PHP5 field

PHP Programming Language format

```csharp
public static readonly FileType PHP5;
```

### PHTML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/phtml.md

#### FileType.PHTML field

Standard file extension for PHP 2 programs format

```csharp
public static readonly FileType PHTML;
```

### PL
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pl.md

#### FileType.PL field

Perl Programming Language format

```csharp
public static readonly FileType PL;
```

### PL6
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pl6.md

#### FileType.PL6 field

Perl Programming Language format

```csharp
public static readonly FileType PL6;
```

### PM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pm.md

#### FileType.PM field

Perl module format

```csharp
public static readonly FileType PM;
```

### PM6
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pm6.md

#### FileType.PM6 field

Perl module format

```csharp
public static readonly FileType PM6;
```

### PNG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/png.md

#### FileType.PNG field

Portable Network Graphics

```csharp
public static readonly FileType PNG;
```

### POD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pod.md

#### FileType.POD field

Perl lightweight markup language format

```csharp
public static readonly FileType POD;
```

### PODSPEC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/podspec.md

#### FileType.PODSPEC field

Ruby build settings format

```csharp
public static readonly FileType PODSPEC;
```

### POT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pot.md

#### FileType.POT field

Microsoft PowerPoint template

```csharp
public static readonly FileType POT;
```

### POTX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/potx.md

#### FileType.POTX field

Microsoft PowerPoint Template

```csharp
public static readonly FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pps.md

#### FileType.PPS field

Microsoft PowerPoint 97-2003 Slide Show

```csharp
public static readonly FileType PPS;
```

### PPSX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ppsx.md

#### FileType.PPSX field

Microsoft PowerPoint Slide Show

```csharp
public static readonly FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ppt.md

#### FileType.PPT field

Microsoft PowerPoint 97-2003 Presentation

```csharp
public static readonly FileType PPT;
```

### PPTX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pptx.md

#### FileType.PPTX field

Microsoft PowerPoint Presentation

```csharp
public static readonly FileType PPTX;
```

### PROP
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/prop.md

#### FileType.PROP field

Properties file format

```csharp
public static readonly FileType PROP;
```

### PSGI
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/psgi.md

#### FileType.PSGI field

Interface between web servers and web applications and frameworks written in the Perl programming

```csharp
public static readonly FileType PSGI;
```

### PY
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/py.md

#### FileType.PY field

Python Programming Language format

```csharp
public static readonly FileType PY;
```

### PYI
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pyi.md

#### FileType.PYI field

Python Interface file format

```csharp
public static readonly FileType PYI;
```

### PYW
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/pyw.md

#### FileType.PYW field

Files used in Windows to indicate a script needs to be run

```csharp
public static readonly FileType PYW;
```

### RAKE
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rake.md

#### FileType.RAKE field

Ruby build automation tool

```csharp
public static readonly FileType RAKE;
```

### RB
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rb.md

#### FileType.RB field

Ruby Programming Language format

```csharp
public static readonly FileType RB;
```

### RBI
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rbi.md

#### FileType.RBI field

Ruby Interface file format

```csharp
public static readonly FileType RBI;
```

### REJ
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rej.md

#### FileType.REJ field

Rejected files format

```csharp
public static readonly FileType REJ;
```

### RJS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rjs.md

#### FileType.RJS field

Ruby Programming Language format

```csharp
public static readonly FileType RJS;
```

### RPY
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rpy.md

#### FileType.RPY field

Python-based file engine to create and run games

```csharp
public static readonly FileType RPY;
```

### RST
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rst.md

#### FileType.RST field

Lightweight markup language

```csharp
public static readonly FileType RST;
```

### RTF
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/rtf.md

#### FileType.RTF field

Rich Text Document

```csharp
public static readonly FileType RTF;
```

### RU
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/ru.md

#### FileType.RU field

Rack configuration file format

```csharp
public static readonly FileType RU;
```

### SASS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/sass.md

#### FileType.SASS field

Style sheet language format

```csharp
public static readonly FileType SASS;
```

### SBT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/sbt.md

#### FileType.SBT field

SBT build tool for Scala format

```csharp
public static readonly FileType SBT;
```

### SC
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/sc.md

#### FileType.SC field

Scala worksheet format

```csharp
public static readonly FileType SC;
```

### SCALA
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/scala.md

#### FileType.SCALA field

Scala Programming Language format

```csharp
public static readonly FileType SCALA;
```

### SCSS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/scss.md

#### FileType.SCSS field

Style sheet language format

```csharp
public static readonly FileType SCSS;
```

### SH
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/sh.md

#### FileType.SH field

Script programmed for bash format

```csharp
public static readonly FileType SH;
```

### SQL
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/sql.md

#### FileType.SQL field

Structured Query Language format

```csharp
public static readonly FileType SQL;
```

### SVG
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/svg.md

#### FileType.SVG field

Scalar Vector Graphics

```csharp
public static readonly FileType SVG;
```

### T
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/t.md

#### FileType.T field

Perl test file format

```csharp
public static readonly FileType T;
```

### ToString
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/tostring.md

#### FileType.ToString method

ToString

```csharp
public override string ToString()
```

### TXT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/txt.md

#### FileType.TXT field

Plain Text Document

```csharp
public static readonly FileType TXT;
```

### UNKNOWN
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/unknown.md

#### FileType.UNKNOWN field

Unknown type

```csharp
public static readonly FileType UNKNOWN;
```

### VDX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/vdx.md

#### FileType.VDX field

Microsoft Visio 2003-2010 XML Drawing

```csharp
public static readonly FileType VDX;
```

### VIM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/vim.md

#### FileType.VIM field

Vim source code file format

```csharp
public static readonly FileType VIM;
```

### VSD
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/vsd.md

#### FileType.VSD field

Microsoft Visio 2003-2010 Drawing

```csharp
public static readonly FileType VSD;
```

### VSDX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/vsdx.md

#### FileType.VSDX field

Microsoft Visio Drawing

```csharp
public static readonly FileType VSDX;
```

### VSS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/vss.md

#### FileType.VSS field

Microsoft Visio 2003-2010 Stencil

```csharp
public static readonly FileType VSS;
```

### VST
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/vst.md

#### FileType.VST field

Microsoft Visio 2003-2010 Template

```csharp
public static readonly FileType VST;
```

### WEBMANIFEST
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/webmanifest.md

#### FileType.WEBMANIFEST field

Manifest file includes information about the app

```csharp
public static readonly FileType WEBMANIFEST;
```

### XLS
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/xls.md

#### FileType.XLS field

Microsoft Excel 97-2003 Worksheet

```csharp
public static readonly FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/xlsb.md

#### FileType.XLSB field

Microsoft Excel Binary Worksheet

```csharp
public static readonly FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/xlsm.md

#### FileType.XLSM field

Microsoft Excel Macro-Enabled Worksheet

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/xlsx.md

#### FileType.XLSX field

Microsoft Excel Worksheet

```csharp
public static readonly FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/xlt.md

#### FileType.XLT field

Microsoft Excel template

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/xltm.md

#### FileType.XLTM field

Microsoft Excel macro-enabled template

```csharp
public static readonly FileType XLTM;
```

### YAML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/yaml.md

#### FileType.YAML field

Human-readable data-serialization language format

```csharp
public static readonly FileType YAML;
```

### YML
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/filetype/yml.md

#### FileType.YML field

Human-readable data-serialization language format

```csharp
public static readonly FileType YML;
```

### PageInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/pageinfo.md

#### PageInfo class

Represents information about page's size and number.

```csharp
public class PageInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| PageInfo(int, int, int) | Create new Instance of PageInfo |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Page height |
| PageNumber { get; set; } | Page number |
| Width { get; set; } | Page width |

### Height
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/pageinfo/height.md

#### PageInfo.Height property

Page height

```csharp
public int Height { get; set; }
```

### PageInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/pageinfo/pageinfo.md

#### PageInfo constructor

Create new Instance of PageInfo

```csharp
public PageInfo(int pageNumber, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The Page Number |
| width | Int32 | Width of Page |
| height | Int32 | Height of Page |

### PageNumber
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Page number

```csharp
public int PageNumber { get; set; }
```

### Width
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/pageinfo/width.md

#### PageInfo.Width property

Page width

```csharp
public int Width { get; set; }
```

### Rectangle
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/rectangle.md

#### Rectangle structure

Rectangle model.

```csharp
public struct Rectangle
```

#### Constructors

| Name | Description |
| --- | --- |
| Rectangle(float, float, float, float) | Creates a new instance of Rectangle |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Height |
| Width { get; set; } | Width |
| X { get; set; } | X coordinate |
| Y { get; set; } | Y coordinate |

### Height
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/rectangle/height.md

#### Rectangle.Height property

Height

```csharp
public float Height { get; set; }
```

### Rectangle
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/rectangle/rectangle.md

#### Rectangle constructor

Creates a new instance of Rectangle

```csharp
public Rectangle(float x, float y, float width, float height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | Single | X position of rectangle |
| y | Single | Y position of Rectangle |
| width | Single | Width of Rectangle |
| height | Single | Height of Rectangle |

### Width
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/rectangle/width.md

#### Rectangle.Width property

Width

```csharp
public float Width { get; set; }
```

### X
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/rectangle/x.md

#### Rectangle.X property

X coordinate

```csharp
public float X { get; set; }
```

### Y
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/rectangle/y.md

#### Rectangle.Y property

Y coordinate

```csharp
public float Y { get; set; }
```

### StyleChangeInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo.md

#### StyleChangeInfo class

Represents information about style change.

```csharp
public sealed class StyleChangeInfo : IEquatable<StyleChangeInfo>
```

#### Constructors

| Name | Description |
| --- | --- |
| StyleChangeInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| NewValue { get; set; } | Gets or Sets the new value of property. |
| OldValue { get; set; } | Gets or Sets the old value of property. |
| PropertyName { get; set; } | Gets or Sets the name of the property that was changed. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equivalence check with object. |
| Equals(StyleChangeInfo) | Style change equivalence check. |
| override GetHashCode() | Generates a hash code for the current StyleChangeInfo instance. |

### Equals
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo/equals.md

#### Equals(object)

Equivalence check with object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Any object |

##### Return Value

True if file types is equivalent, false if not

#### Equals(StyleChangeInfo)

Style change equivalence check.

```csharp
public bool Equals(StyleChangeInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | StyleChangeInfo | StyleChangeInfo object |

### GetHashCode
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo/gethashcode.md

#### StyleChangeInfo.GetHashCode method

Generates a hash code for the current StyleChangeInfo instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code representing the current object.

### NewValue
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo/newvalue.md

#### StyleChangeInfo.NewValue property

Gets or Sets the new value of property.

```csharp
public object NewValue { get; set; }
```

### OldValue
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo/oldvalue.md

#### StyleChangeInfo.OldValue property

Gets or Sets the old value of property.

```csharp
public object OldValue { get; set; }
```

### PropertyName
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo/propertyname.md

#### StyleChangeInfo.PropertyName property

Gets or Sets the name of the property that was changed.

```csharp
public string PropertyName { get; set; }
```

### StyleChangeInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.result/stylechangeinfo/stylechangeinfo.md

#### StyleChangeInfo constructor

The default constructor.

```csharp
public StyleChangeInfo()
```

### GroupDocs.Comparison.Words.Revision
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision.md

The namespace provides classes for working with revisions in WORD format file.

#### Classes

| Class | Description |
| --- | --- |
| ApplyRevisionOptions | Allows you to update the state of revisions before they are applied to the final document. |
| RevisionHandler | Represents the main class that controls revision handling. |
| RevisionInfo | Provides information about one revision. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| RevisionAction | Action that can be applied to a revision. |
| RevisionType | Specifies the type of change being tracked. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### ApplyRevisionOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/applyrevisionoptions.md

#### ApplyRevisionOptions class

Allows you to update the state of revisions before they are applied to the final document.

```csharp
public class ApplyRevisionOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ApplyRevisionOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Changes { get; set; } | The list of revisions processed, which will be applied to the resulting document. |
| CommonHandler { get; set; } | Indicates whether to apply one action for all revisions |

### ApplyRevisionOptions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/applyrevisionoptions/applyrevisionoptions.md

#### ApplyRevisionOptions constructor

The default constructor.

```csharp
public ApplyRevisionOptions()
```

### Changes
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/applyrevisionoptions/changes.md

#### ApplyRevisionOptions.Changes property

The list of revisions processed, which will be applied to the resulting document.

```csharp
public List<RevisionInfo> Changes { get; set; }
```

### CommonHandler
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/applyrevisionoptions/commonhandler.md

#### ApplyRevisionOptions.CommonHandler property

Indicates whether to apply one action for all revisions

```csharp
public RevisionAction CommonHandler { get; set; }
```

### RevisionAction
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisionaction.md

#### RevisionAction enumeration

Action that can be applied to a revision.

```csharp
public enum RevisionAction
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Nothing to do. |
| Accept | `1` | The revision will be displayed if it is of type INSERTION or will be removed if the type is DELETION. |
| Reject | `2` | The revision will be removed if it is of type INSERTION or will be displayed if the type is DELETION. |

### RevisionHandler
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisionhandler.md

#### RevisionHandler class

Represents the main class that controls revision handling.

```csharp
public sealed class RevisionHandler : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| RevisionHandler(Stream) | Initializes new instance of `RevisionHandler` class with a file stream with revisions. |
| RevisionHandler(string) | Initializes new instance of `RevisionHandler` class with the path to the file with revisions. |
| RevisionHandler(Stream, bool) | Initializes new instance of `RevisionHandler` class with a file stream with revisions and explicit stream-ownership control. |

#### Methods

| Name | Description |
| --- | --- |
| ApplyRevisionChanges(ApplyRevisionOptions) | Processes changes in revisions and applies them to the same file from which the revisions were taken. |
| ApplyRevisionChanges(Stream, ApplyRevisionOptions) | Processes changes in revisions and the result is written to the document stream. |
| ApplyRevisionChanges(string, ApplyRevisionOptions) | Processes changes in revisions, and the result is written to the specified file by path. |
| Dispose() | Releases resources. |
| GetRevisions() | Gets list of all revisions. |

### ApplyRevisionChanges
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisionhandler/applyrevisionchanges.md

#### ApplyRevisionChanges(ApplyRevisionOptions)

Processes changes in revisions and applies them to the same file from which the revisions were taken.

```csharp
public void ApplyRevisionChanges(ApplyRevisionOptions changes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| changes | ApplyRevisionOptions | List of changed revisions |

#### ApplyRevisionChanges(string, ApplyRevisionOptions)

Processes changes in revisions, and the result is written to the specified file by path.

```csharp
public void ApplyRevisionChanges(string filePath, ApplyRevisionOptions changes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result file path |
| changes | ApplyRevisionOptions | List of changed revisions |

#### ApplyRevisionChanges(Stream, ApplyRevisionOptions)

Processes changes in revisions and the result is written to the document stream.

```csharp
public void ApplyRevisionChanges(Stream document, ApplyRevisionOptions changes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Result document |
| changes | ApplyRevisionOptions | List of changed revisions |

### Dispose
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisionhandler/dispose.md

#### RevisionHandler.Dispose method

Releases resources.

```csharp
public void Dispose()
```

### GetRevisions
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisionhandler/getrevisions.md

#### RevisionHandler.GetRevisions method

Gets list of all revisions.

```csharp
public List<RevisionInfo> GetRevisions()
```

### RevisionHandler
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisionhandler/revisionhandler.md

#### RevisionHandler(string)

Initializes new instance of `RevisionHandler` class with the path to the file with revisions.

```csharp
public RevisionHandler(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |

#### RevisionHandler(Stream)

Initializes new instance of `RevisionHandler` class with a file stream with revisions.

```csharp
public RevisionHandler(Stream file)
```

| Parameter | Type | Description |
| --- | --- | --- |
| file | Stream | Source document stream |

#### RevisionHandler(Stream, bool)

Initializes new instance of `RevisionHandler` class with a file stream with revisions and explicit stream-ownership control.

```csharp
public RevisionHandler(Stream file, bool leaveOpen)
```

| Parameter | Type | Description |
| --- | --- | --- |
| file | Stream | Source document stream |
| leaveOpen | Boolean | When true, the caller retains ownership of *file* and is responsible for disposing it. When false (default), `Dispose` closes the stream. |

### RevisionInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisioninfo.md

#### RevisionInfo class

Provides information about one revision.

```csharp
public class RevisionInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| RevisionInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Action { get; set; } | Action (accept or reject). This field allows you to influence the display of the revision. |
| Author { get; } | Author of revision. |
| Text { get; } | The text that is in revision. |
| Type { get; } | RevisionHandler type, depending on the type the Action (accept or reject) logic changes. |

### Action
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisioninfo/action.md

#### RevisionInfo.Action property

Action (accept or reject). This field allows you to influence the display of the revision.

```csharp
public RevisionAction Action { get; set; }
```

### Author
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisioninfo/author.md

#### RevisionInfo.Author property

Author of revision.

```csharp
public string Author { get; }
```

### RevisionInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisioninfo/revisioninfo.md

#### RevisionInfo constructor

The default constructor.

```csharp
public RevisionInfo()
```

### Text
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisioninfo/text.md

#### RevisionInfo.Text property

The text that is in revision.

```csharp
public string Text { get; }
```

### Type
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisioninfo/type.md

#### RevisionInfo.Type property

RevisionHandler type, depending on the type the Action (accept or reject) logic changes.

```csharp
public RevisionType Type { get; }
```

### RevisionType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.words.revision/revisiontype.md

#### RevisionType enumeration

Specifies the type of change being tracked.

```csharp
public enum RevisionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Insertion | `0` | New content was inserted in the document. |
| Deletion | `1` | Content was removed from the document. |
| FormatChange | `2` | Change of formatting was applied to the parent node. |
| StyleDefinitionChange | `3` | Change of formatting was applied to the parent style. |
| Moving | `4` | Content was moved in the document. |

### GroupDocs.Comparison
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison.md

The namespace provides classes to compare documents for all popular document formats.

#### Classes

| Class | Description |
| --- | --- |
| Comparer | Represents main class that controls the documents comparison process. |
| ComparerSettings | Defines settings for customizing `Comparer` behaviour. |
| Document | Represents compared document. |
| License | Provides methods to license the component. |
| Metered | Provides methods for applying Metered license. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Comparison.dll -->

### Comparer
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer.md

#### Comparer class

Represents main class that controls the documents comparison process.

```csharp
public sealed class Comparer : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Comparer(Stream) | Initializes new instance of `Comparer` class with source document stream. |
| Comparer(string) | Initializes new instance of `Comparer` class with source file path. |
| Comparer(Stream, ComparerSettings) | Initializes new instance of `Comparer` class with source document stream and `ComparerSettings`. |
| Comparer(Stream, LoadOptions) | Initializes new instance of `Comparer` with source document stream and `LoadOptions`. |
| Comparer(string, CompareOptions) | Initializes new instance of `Comparer` with source folder path and `CompareOptions`. |
| Comparer(string, ComparerSettings) | Initializes new instance of `Comparer` class with source file path and `ComparerSettings`. |
| Comparer(string, LoadOptions) | Initializes new instance of `Comparer` with source file path and `LoadOptions`. |
| Comparer(Stream, LoadOptions, ComparerSettings) | Initializes new instance of `Comparer` class with document stream, `LoadOptions` and `ComparerSettings`. |
| Comparer(string, LoadOptions, ComparerSettings) | Initializes new instance of `Comparer` class with source file path, `LoadOptions` and `ComparerSettings`. |

#### Properties

| Name | Description |
| --- | --- |
| Result { get; } | Result document. |
| Source { get; } | Source file that is being compared. |
| SourceFolder { get; } | Source folder that is being compared. |
| TargetFolder { get; set; } | Target folder that is being compared. |
| Targets { get; } | List of target files to compare with source file. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Stream) | Adds document stream to comparison. |
| Add(string) | Adds file to comparison. |
| Add(Stream, LoadOptions) | Adds document stream to comparison with loading options specified. |
| Add(string, CompareOptions) | Adds folder to comparison. |
| Add(string, LoadOptions) | Adds file to comparison with loading options specified. |
| ApplyChanges(Stream, ApplyChangeOptions) | Accepts or rejects changes and applies them to resultant document. |
| ApplyChanges(string, ApplyChangeOptions) | Accepts or rejects changes and applies them to resultant document. |
| ApplyChanges(Stream, SaveOptions, ApplyChangeOptions) | Accepts or rejects changes and applies them to resultant document. |
| ApplyChanges(string, SaveOptions, ApplyChangeOptions) | Accepts or rejects changes and applies them to resultant document. |
| Compare() | Compares documents without saving result with default options |
| Compare(CompareOptions) | Compares documents without saving result. |
| Compare(Stream) | Compares documents and saves result to file stream |
| Compare(string) | Compares documents and saves result to file path |
| Compare(SaveOptions, CompareOptions) | Compares documents without saving result. |
| Compare(Stream, CompareOptions) | Compares documents and saves result to file stream |
| Compare(Stream, SaveOptions) | Compares documents and save result to file stream |
| Compare(string, CompareOptions) | Compares documents and saves result to file path |
| Compare(string, SaveOptions) | Compares documents and save result to file path |
| Compare(Stream, SaveOptions, CompareOptions) | Compares documents and saves result to a stream. |
| Compare(string, SaveOptions, CompareOptions) | Compares documents and saves result to file path |
| CompareDirectory(string, CompareOptions) | Compares directory and saves result to file path |
| Dispose() | Releases resources. |
| GetChanges() | Gets list of changes between source and target file(s). |
| GetChanges(ChangeType) | Gets list of changes between source and target file(s). |
| GetChanges(GetChangeOptions) | Gets list of changes between source and target file(s). |
| GetResultDocumentStream() | Gets the stream of result document, returns null if stream does not exist |
| GetResultString() | Get result string after comparison (For Text Comparison only). |

### Add
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/add.md

#### Add(string)

Adds file to comparison.

```csharp
public void Add(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Compared file path |

#### Add(string, CompareOptions)

Adds folder to comparison.

```csharp
public void Add(string filePath, CompareOptions compareOptions)
```

#### Add(string, LoadOptions)

Adds file to comparison with loading options specified.

```csharp
public void Add(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Compared file path |
| loadOptions | LoadOptions | Load options |

#### Add(Stream)

Adds document stream to comparison.

```csharp
public void Add(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Compared document stream |

#### Add(Stream, LoadOptions)

Adds document stream to comparison with loading options specified.

```csharp
public void Add(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Compared document stream |
| loadOptions | LoadOptions | Load options |

### ApplyChanges
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/applychanges.md

#### ApplyChanges(string, ApplyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

```csharp
public void ApplyChanges(string filePath, ApplyChangeOptions applyChangeOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result file path |
| applyChangeOptions | ApplyChangeOptions | Apply change options |

#### ApplyChanges(Stream, ApplyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

```csharp
public void ApplyChanges(Stream stream, ApplyChangeOptions applyChangeOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Result document |
| applyChangeOptions | ApplyChangeOptions | Apply change options |

#### ApplyChanges(string, SaveOptions, ApplyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

```csharp
public void ApplyChanges(string filePath, SaveOptions saveOptions, 
    ApplyChangeOptions applyChangeOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result file path |
| saveOptions | SaveOptions | Save options |
| applyChangeOptions | ApplyChangeOptions | Apply change options |

#### ApplyChanges(Stream, SaveOptions, ApplyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

```csharp
public void ApplyChanges(Stream stream, SaveOptions saveOptions, 
    ApplyChangeOptions applyChangeOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Result document |
| saveOptions | SaveOptions | Save options |
| applyChangeOptions | ApplyChangeOptions | Apply change options |

### Compare
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/compare.md

#### Compare()

Compares documents without saving result with default options

```csharp
public Document Compare()
```

#### Compare(string)

Compares documents and saves result to file path

```csharp
public Document Compare(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result document path |

#### Compare(Stream)

Compares documents and saves result to file stream

```csharp
public Document Compare(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Result document stream |

#### Compare(string, CompareOptions)

Compares documents and saves result to file path

```csharp
public Document Compare(string filePath, CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result document file path |
| compareOptions | CompareOptions | Compare options |

#### Compare(Stream, CompareOptions)

Compares documents and saves result to file stream

```csharp
public Document Compare(Stream document, CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Result document stream |
| compareOptions | CompareOptions | Compare options |

#### Compare(SaveOptions, CompareOptions)

Compares documents without saving result.

```csharp
public Document Compare(SaveOptions saveOptions, CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | SaveOptions | Save options |
| compareOptions | CompareOptions | Compare options |

#### Compare(string, SaveOptions)

Compares documents and save result to file path

```csharp
public Document Compare(string filePath, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result document file path |
| saveOptions | SaveOptions | Save options |

#### Compare(Stream, SaveOptions)

Compares documents and save result to file stream

```csharp
public Document Compare(Stream document, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Result document stream |
| saveOptions | SaveOptions | Save options |

#### Compare(CompareOptions)

Compares documents without saving result.

```csharp
public Document Compare(CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| compareOptions | CompareOptions | Compare options |

#### Compare(Stream, SaveOptions, CompareOptions)

Compares documents and saves result to a stream.

```csharp
public Document Compare(Stream stream, SaveOptions saveOptions, CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Result document stream |
| saveOptions | SaveOptions | Save options |
| compareOptions | CompareOptions | Compare options |

#### Compare(string, SaveOptions, CompareOptions)

Compares documents and saves result to file path

```csharp
public Document Compare(string filePath, SaveOptions saveOptions, CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Result document file path |
| saveOptions | SaveOptions | Save options |
| compareOptions | CompareOptions | Compare options |

### CompareDirectory
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/comparedirectory.md

#### Comparer.CompareDirectory method

Compares directory and saves result to file path

```csharp
public void CompareDirectory(string filePath, CompareOptions compareOptions)
```

### Comparer
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/comparer.md

#### Comparer(string)

Initializes new instance of `Comparer` class with source file path.

```csharp
public Comparer(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |

#### Comparer(string, CompareOptions)

Initializes new instance of `Comparer` with source folder path and `CompareOptions`.

```csharp
public Comparer(string folderPath, CompareOptions compareOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | String | Folder path |
| compareOptions | CompareOptions | Compare options |

#### Comparer(string, LoadOptions)

Initializes new instance of `Comparer` with source file path and `LoadOptions`.

```csharp
public Comparer(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |
| loadOptions | LoadOptions | Load options |

#### Comparer(string, ComparerSettings)

Initializes new instance of `Comparer` class with source file path and `ComparerSettings`.

```csharp
public Comparer(string filePath, ComparerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |
| settings | ComparerSettings | Settings for comparison |

#### Comparer(string, LoadOptions, ComparerSettings)

Initializes new instance of `Comparer` class with source file path, `LoadOptions` and `ComparerSettings`.

```csharp
public Comparer(string filePath, LoadOptions loadOptions, ComparerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path |
| loadOptions | LoadOptions | Load options |
| settings | ComparerSettings | Settings for comparison |

#### Comparer(Stream)

Initializes new instance of `Comparer` class with source document stream.

```csharp
public Comparer(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source document stream |

#### Comparer(Stream, LoadOptions)

Initializes new instance of `Comparer` with source document stream and `LoadOptions`.

```csharp
public Comparer(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source document stream |
| loadOptions | LoadOptions | Load options |

#### Comparer(Stream, ComparerSettings)

Initializes new instance of `Comparer` class with source document stream and `ComparerSettings`.

```csharp
public Comparer(Stream document, ComparerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source document stream |
| settings | ComparerSettings | Settings for comparison |

#### Comparer(Stream, LoadOptions, ComparerSettings)

Initializes new instance of `Comparer` class with document stream, `LoadOptions` and `ComparerSettings`.

```csharp
public Comparer(Stream document, LoadOptions loadOptions, ComparerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source document stream |
| loadOptions | LoadOptions | Load options |
| settings | ComparerSettings | Settings for comparison |

### Dispose
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/dispose.md

#### Comparer.Dispose method

Releases resources.

```csharp
public void Dispose()
```

### GetChanges
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/getchanges.md

#### GetChanges()

Gets list of changes between source and target file(s).

```csharp
public ChangeInfo[] GetChanges()
```

#### GetChanges(GetChangeOptions)

Gets list of changes between source and target file(s).

```csharp
public ChangeInfo[] GetChanges(GetChangeOptions getChangeOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getChangeOptions | GetChangeOptions | Get change options |

#### GetChanges(ChangeType)

Gets list of changes between source and target file(s).

```csharp
public ChangeInfo[] GetChanges(ChangeType filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | ChangeType | Specifies change type |

### GetResultDocumentStream
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/getresultdocumentstream.md

#### Comparer.GetResultDocumentStream method

Gets the stream of result document, returns null if stream does not exist

```csharp
public Stream GetResultDocumentStream()
```

### GetResultString
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/getresultstring.md

#### Comparer.GetResultString method

Get result string after comparison (For Text Comparison only).

```csharp
public string GetResultString()
```

### Result
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/result.md

#### Comparer.Result property

Result document.

```csharp
public Document Result { get; }
```

### Source
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/source.md

#### Comparer.Source property

Source file that is being compared.

```csharp
public Document Source { get; }
```

### SourceFolder
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/sourcefolder.md

#### Comparer.SourceFolder property

Source folder that is being compared.

```csharp
public string SourceFolder { get; }
```

### TargetFolder
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/targetfolder.md

#### Comparer.TargetFolder property

Target folder that is being compared.

```csharp
public string TargetFolder { get; set; }
```

### Targets
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparer/targets.md

#### Comparer.Targets property

List of target files to compare with source file.

```csharp
public List<Document> Targets { get; }
```

### ComparerSettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparersettings.md

#### ComparerSettings class

Defines settings for customizing `Comparer` behaviour.

```csharp
public class ComparerSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| ComparerSettings() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Logger { get; set; } | Logger implementation. |

### ComparerSettings
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparersettings/comparersettings.md

#### ComparerSettings constructor

The default constructor.

```csharp
public ComparerSettings()
```

### Logger
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/comparersettings/logger.md

#### ComparerSettings.Logger property

Logger implementation.

```csharp
public ILogger Logger { get; set; }
```

### Document
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document.md

#### Document class

Represents compared document.

```csharp
public class Document
```

#### Constructors

| Name | Description |
| --- | --- |
| Document(Stream) | Initializes new instance of `Document` class. |
| Document(string) | Initializes new instance of `Document` class. |
| Document(Stream, string) | Initializes new instance of `Document` class. |
| Document(string, string) | Initializes new instance of `Document` class. |

#### Properties

| Name | Description |
| --- | --- |
| Changes { get; set; } | List of changes. Contains extensive description about change type, position, content etc. |
| FileType { get; } | Document file type. |
| Name { get; set; } | Document name. |
| Password { get; } | Document password. |
| Stream { get; } | Document stream. |

#### Methods

| Name | Description |
| --- | --- |
| GeneratePreview(PreviewOptions) | Generates document pages preview. |
| GetDocumentInfo() | Gets information about document - document type, pages count, page sizes etc. |

### Changes
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/changes.md

#### Document.Changes property

List of changes. Contains extensive description about change type, position, content etc.

```csharp
public List<ChangeInfo> Changes { get; set; }
```

### Document
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/document.md

#### Document(Stream)

Initializes new instance of `Document` class.

```csharp
public Document(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Document stream |

#### Document(string)

Initializes new instance of `Document` class.

```csharp
public Document(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Document path |

#### Document(string, string)

Initializes new instance of `Document` class.

```csharp
public Document(string filePath, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Document path |
| password | String | Document password |

#### Document(Stream, string)

Initializes new instance of `Document` class.

```csharp
public Document(Stream stream, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Document stream |
| password | String | Document password |

### FileType
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/filetype.md

#### Document.FileType property

Document file type.

```csharp
public FileType FileType { get; }
```

### GeneratePreview
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/generatepreview.md

#### Document.GeneratePreview method

Generates document pages preview.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The document preview options |

### GetDocumentInfo
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/getdocumentinfo.md

#### Document.GetDocumentInfo method

Gets information about document - document type, pages count, page sizes etc.

```csharp
public IDocumentInfo GetDocumentInfo()
```

### Name
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/name.md

#### Document.Name property

Document name.

```csharp
public string Name { get; set; }
```

### Password
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/password.md

#### Document.Password property

Document password.

```csharp
public string Password { get; }
```

### Stream
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/document/stream.md

#### Document.Stream property

Document stream.

```csharp
public Stream Stream { get; }
```

### License
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/license.md

#### License class

Provides methods to license the component.

```csharp
public class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component using license stream. |
| SetLicense(string) | Licenses the component using license path. |

### License
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/license/setlicense.md

#### SetLicense(Stream)

Licenses the component using license stream.

```csharp
public void SetLicense(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | The license stream. |

#### SetLicense(string)

Licenses the component using license path.

```csharp
public void SetLicense(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | The license path. |

### Metered
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/metered.md

#### Metered class

Provides methods for applying Metered license.

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | Initializes a new instance of the `Metered` class. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Sets metered public and private key |
| static GetConsumptionCredit() | Retrieves amount of used credits |
| static GetConsumptionQuantity() | Gets consumption quantity |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves amount of used credits

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

Number of already used credits

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Gets consumption quantity

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

consumption quantity

### Metered
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/metered/metered.md

#### Metered constructor

Initializes a new instance of the `Metered` class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/comparison/net/groupdocs.comparison/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Sets metered public and private key

```csharp
public void SetMeteredKey(string publicKey, string privateKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | String | public key |
| privateKey | String | private key |

## Python

### GroupDocs.Comparison for Python via .NET
Path: https://reference.groupdocs.com/comparison/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.comparison` | Main GroupDocs.Comparison namespace with top-level API classes. |
| `groupdocs.comparison.interfaces` | Types under `groupdocs.comparison.interfaces`. |
| `groupdocs.comparison.localization` | Types under `groupdocs.comparison.localization`. |
| `groupdocs.comparison.logging` | Logging hooks and listener interfaces. |
| `groupdocs.comparison.options` | Option classes for configuring conversions and operations. |
| `groupdocs.comparison.result` | Types under `groupdocs.comparison.result`. |

### groupdocs.comparison.cells.style
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.cells.style.md

The namespace provides classes for working with component styles in Cells format file.

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `MergeType` | Enumerates the type of cell merge. |

### MergeType enumeration
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.cells.style/mergetype.md

#### MergeType enumeration

Enumerates the type of cell merge.

The MergeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Cell does not merge. |
| HORIZONTAL | Cell merges along row. |
| VERTICAL | Cell merges along column. |
| RANGE | Cell merges along row and column creating area. |

### groupdocs.comparison.cells
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.cells.md

### groupdocs.comparison.common.exceptions
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions.md

The namespace provides different exception classes.

##### Classes
| Class | Description |
| :- | :- |
| `ComparisonException` | Base class for all comparison process exceptions. |
| `DocumentComparisonException` | The exception that is thrown when an error occurs while comparing documents. |
| `FileFormatException` | The exception that is thrown when comparing files with different formats. |
| `InvalidPasswordException` | The exception that is thrown when specified password is incorrect. |
| `PasswordProtectedFileException` | The exception that is thrown when the document is protected by password. |
| `UnsupportedFileFormatException` | The exception that is thrown when file of this format doesn't support comparison. |

### ComparisonException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/comparisonexception.md

#### ComparisonException class

Base class for all comparison process exceptions.

The ComparisonException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ComparisonException` class. |
| __init__ | Initializes a new instance of the `ComparisonException` class with a specified error message. |

### ComparisonException constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/comparisonexception/__init__.md

#### __init__

Initializes a new instance of the `ComparisonException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `ComparisonException` class with a specified error message.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The exception message |

### DocumentComparisonException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/documentcomparisonexception.md

#### DocumentComparisonException class

The exception that is thrown when an error occurs while comparing documents.

**Inheritance:** `DocumentComparisonException` →
`ComparisonException`

The DocumentComparisonException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `DocumentComparisonException` class. |

### DocumentComparisonException constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/documentcomparisonexception/__init__.md

#### __init__

Initializes a new instance of `DocumentComparisonException` class.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String |  |

### FileFormatException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/fileformatexception.md

#### FileFormatException class

The exception that is thrown when comparing files with different formats.

**Inheritance:** `FileFormatException` →
`ComparisonException`

The FileFormatException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `FileFormatException` class. |

### FileFormatException constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/fileformatexception/__init__.md

#### __init__

Initializes a new instance of `FileFormatException` class.

```python
def __init__(self, source_path, target_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | System.String | The source file path |
| target_path | System.String | The target file path |

### InvalidPasswordException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/invalidpasswordexception.md

#### InvalidPasswordException class

The exception that is thrown when specified password is incorrect.

**Inheritance:** `InvalidPasswordException` →
`ComparisonException`

The InvalidPasswordException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `InvalidPasswordException` class. |

### InvalidPasswordException constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/invalidpasswordexception/__init__.md

#### __init__

Initializes a new instance of `InvalidPasswordException` class.

```python
def __init__(self):
    ...
```

### PasswordProtectedFileException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/passwordprotectedfileexception.md

#### PasswordProtectedFileException class

The exception that is thrown when the document is protected by password.

**Inheritance:** `PasswordProtectedFileException` →
`ComparisonException`

The PasswordProtectedFileException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `PasswordProtectedFileException` class. |

### PasswordProtectedFileException constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/passwordprotectedfileexception/__init__.md

#### __init__

Initializes a new instance of `PasswordProtectedFileException` class.

```python
def __init__(self):
    ...
```

### UnsupportedFileFormatException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/unsupportedfileformatexception.md

#### UnsupportedFileFormatException class

The exception that is thrown when file of this format doesn't support comparison.

**Inheritance:** `UnsupportedFileFormatException` →
`ComparisonException`

The UnsupportedFileFormatException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `UnsupportedFileFormatException` class. |
| __init__ | Initializes a new instance of `UnsupportedFileFormatException` class. |

### UnsupportedFileFormatException constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.exceptions/unsupportedfileformatexception/__init__.md

#### __init__

Initializes a new instance of `UnsupportedFileFormatException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of `UnsupportedFileFormatException` class.

```python
def __init__(self, path_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| path_file | System.String |  |

### groupdocs.comparison.common
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.common.md

The namespace provides helpers classes.

### groupdocs.comparison.interfaces
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.interfaces.md

Types under `groupdocs.comparison.interfaces`.

##### Classes
| Class | Description |
| :- | :- |
| `IDocumentInfo` |  |

### IDocumentInfo class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.interfaces/idocumentinfo.md

#### IDocumentInfo class

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| page_count |  |
| pages_info |  |
| size |  |

### file_type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.interfaces/idocumentinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.interfaces/idocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
@page_count.setter
def page_count(self, value):
    ...
```

### pages_info property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.interfaces/idocumentinfo/pages_info.md

##### Definition:
```python
@property
def pages_info(self):
    ...
@pages_info.setter
def pages_info(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.interfaces/idocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### groupdocs.comparison.localization
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization.md

Types under `groupdocs.comparison.localization`.

##### Classes
| Class | Description |
| :- | :- |
| `SupportedLocales` |  |

### SupportedLocales class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales.md

#### SupportedLocales class

The SupportedLocales type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _is_locale_supported_culture_info |  |
| _is_locale_supported_string |  |
| is_locale_supported |  |
| is_locale_supported_culture_info |  |
| is_locale_supported_file |  |
| is_locale_supported_string |  |

### _is_locale_supported_culture_info method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales/_is_locale_supported_culture_info.md

#### _is_locale_supported_culture_info

```python
def _is_locale_supported_culture_info(cls, culture):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| culture | `CultureInfo` |  |

**Returns:** bool

### _is_locale_supported_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales/_is_locale_supported_string.md

#### _is_locale_supported_string

```python
def _is_locale_supported_string(cls, culture):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| culture | `str` |  |

**Returns:** bool

### is_locale_supported method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales/is_locale_supported.md

#### is_locale_supported

```python
def is_locale_supported(cls):
    ...
```

### is_locale_supported_culture_info method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales/is_locale_supported_culture_info.md

#### is_locale_supported_culture_info

```python
def is_locale_supported_culture_info(cls):
    ...
```

### is_locale_supported_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales/is_locale_supported_file.md

#### is_locale_supported_file

```python
def is_locale_supported_file(cls):
    ...
```

### is_locale_supported_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.localization/supportedlocales/is_locale_supported_string.md

#### is_locale_supported_string

```python
def is_locale_supported_string(cls):
    ...
```

### groupdocs.comparison.logging
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging.md

Logging hooks and listener interfaces.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` |  |
| `ILogger` |  |

### ConsoleLogger class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger.md

#### ConsoleLogger class

The ConsoleLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _error_string_exception |  |
| _init_noargs |  |
| _trace_string |  |
| _warning_string |  |
| error |  |
| error_file |  |
| error_string |  |
| trace |  |
| trace_file |  |
| trace_string |  |
| warning |  |
| warning_file |  |
| warning_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/_error_string_exception.md

#### _error_string_exception

```python
def _error_string_exception(self, message, ex):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |
| ex | `Exception` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _trace_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/_trace_string.md

#### _trace_string

```python
def _trace_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _warning_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/consolelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger.md

#### ILogger class

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _error_string_exception |  |
| _trace_string |  |
| _warning_string |  |
| error |  |
| error_file |  |
| error_string |  |
| trace |  |
| trace_file |  |
| trace_string |  |
| warning |  |
| warning_file |  |
| warning_string |  |

### _error_string_exception method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/_error_string_exception.md

#### _error_string_exception

```python
def _error_string_exception(self, message, ex):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |
| ex | `Exception` |  |

### _trace_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/_trace_string.md

#### _trace_string

```python
def _trace_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _warning_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.logging/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### groupdocs.comparison.options
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `ApplyChangeOptions` |  |
| `CompareOptions` |  |
| `DiagramMasterSetting` |  |
| `FileAuthorMetadata` |  |
| `GetChangeOptions` |  |
| `IgnoreChangeSensitivitySettings` |  |
| `LoadOptions` |  |
| `OriginalSize` |  |
| `PagesSetup` |  |
| `PdfCompareOptions` |  |
| `PreviewOptions` |  |
| `PreviewResolution` |  |
| `SaveOptions` |  |
| `Size` |  |
| `StyleSettings` |  |
| `WordCompareOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `CalculateCoordinatesModeEnumeration` |  |
| `ChangeType` |  |
| `ComparisonDisplayMode` |  |
| `DetalisationLevel` |  |
| `FolderComparisonExtension` |  |
| `ImagesInheritance` |  |
| `MetadataType` |  |
| `PaperSize` |  |
| `PasswordSaveOption` |  |
| `PreviewFormats` |  |

### ApplyChangeOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/applychangeoptions.md

#### ApplyChangeOptions class

The ApplyChangeOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| changes |  |
| save_original_state |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/applychangeoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/applychangeoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### changes property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/applychangeoptions/changes.md

##### Definition:
```python
@property
def changes(self):
    ...
@changes.setter
def changes(self, value):
    ...
```

### save_original_state property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/applychangeoptions/save_original_state.md

##### Definition:
```python
@property
def save_original_state(self):
    ...
@save_original_state.setter
def save_original_state(self, value):
    ...
```

### CalculateCoordinatesModeEnumeration class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/calculatecoordinatesmodeenumeration.md

#### CalculateCoordinatesModeEnumeration class

The CalculateCoordinatesModeEnumeration type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SOURCE |  |
| TARGET |  |
| RESULT |  |

### RESULT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/calculatecoordinatesmodeenumeration/result.md

##### Value
`2`

### SOURCE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/calculatecoordinatesmodeenumeration/source.md

##### Value
`0`

### TARGET field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/calculatecoordinatesmodeenumeration/target.md

##### Value
`1`

### ChangeType class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype.md

#### ChangeType class

The ChangeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| MODIFIED |  |
| INSERTED |  |
| DELETED |  |
| ADDED |  |
| NOT_MODIFIED |  |
| STYLE_CHANGED |  |
| RESIZED |  |
| MOVED |  |
| MOVED_AND_RESIZED |  |
| SHIFTED_AND_RESIZED |  |

### ADDED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/added.md

##### Value
`4`

### DELETED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/deleted.md

##### Value
`3`

### INSERTED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/inserted.md

##### Value
`2`

### MODIFIED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/modified.md

##### Value
`1`

### MOVED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/moved.md

##### Value
`8`

### MOVED_AND_RESIZED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/moved_and_resized.md

##### Value
`9`

### NONE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/none.md

##### Value
`0`

### NOT_MODIFIED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/not_modified.md

##### Value
`5`

### RESIZED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/resized.md

##### Value
`7`

### SHIFTED_AND_RESIZED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/shifted_and_resized.md

##### Value
`10`

### STYLE_CHANGED field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/changetype/style_changed.md

##### Value
`6`

### CompareOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions.md

#### CompareOptions class

The CompareOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| calculate_coordinates |  |
| calculate_coordinates_mode |  |
| changed_item_style |  |
| compare_bookmarks |  |
| compare_document_property |  |
| compare_images_pdf |  |
| compare_variable_property |  |
| deleted_item_style |  |
| detalisation_level |  |
| detect_style_changes |  |
| diagram_master_setting |  |
| directory_compare |  |
| extended_summary_page |  |
| folder_comparison_extension |  |
| generate_summary_page |  |
| header_footers_comparison |  |
| ignore_change_settings |  |
| images_inheritance_mode |  |
| inserted_item_style |  |
| leave_gaps |  |
| mark_changed_content |  |
| mark_line_breaks |  |
| mark_nested_content |  |
| original_size |  |
| paper_size |  |
| password_save_option |  |
| revision_author_name |  |
| sensitivity_of_comparison |  |
| sensitivity_of_comparison_for_tables |  |
| show_deleted_content |  |
| show_inserted_content |  |
| show_only_changed |  |
| show_only_summary_page |  |
| show_revisions |  |
| user_master_path |  |
| word_track_changes |  |
| words_separator_chars |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### calculate_coordinates property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/calculate_coordinates.md

##### Definition:
```python
@property
def calculate_coordinates(self):
    ...
@calculate_coordinates.setter
def calculate_coordinates(self, value):
    ...
```

### calculate_coordinates_mode property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/calculate_coordinates_mode.md

##### Definition:
```python
@property
def calculate_coordinates_mode(self):
    ...
@calculate_coordinates_mode.setter
def calculate_coordinates_mode(self, value):
    ...
```

### changed_item_style property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/changed_item_style.md

##### Definition:
```python
@property
def changed_item_style(self):
    ...
@changed_item_style.setter
def changed_item_style(self, value):
    ...
```

### compare_bookmarks property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/compare_bookmarks.md

##### Definition:
```python
@property
def compare_bookmarks(self):
    ...
@compare_bookmarks.setter
def compare_bookmarks(self, value):
    ...
```

### compare_document_property property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/compare_document_property.md

##### Definition:
```python
@property
def compare_document_property(self):
    ...
@compare_document_property.setter
def compare_document_property(self, value):
    ...
```

### compare_images_pdf property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/compare_images_pdf.md

##### Definition:
```python
@property
def compare_images_pdf(self):
    ...
@compare_images_pdf.setter
def compare_images_pdf(self, value):
    ...
```

### compare_variable_property property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/compare_variable_property.md

##### Definition:
```python
@property
def compare_variable_property(self):
    ...
@compare_variable_property.setter
def compare_variable_property(self, value):
    ...
```

### deleted_item_style property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/deleted_item_style.md

##### Definition:
```python
@property
def deleted_item_style(self):
    ...
@deleted_item_style.setter
def deleted_item_style(self, value):
    ...
```

### detalisation_level property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/detalisation_level.md

##### Definition:
```python
@property
def detalisation_level(self):
    ...
@detalisation_level.setter
def detalisation_level(self, value):
    ...
```

### detect_style_changes property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/detect_style_changes.md

##### Definition:
```python
@property
def detect_style_changes(self):
    ...
@detect_style_changes.setter
def detect_style_changes(self, value):
    ...
```

### diagram_master_setting property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/diagram_master_setting.md

##### Definition:
```python
@property
def diagram_master_setting(self):
    ...
@diagram_master_setting.setter
def diagram_master_setting(self, value):
    ...
```

### directory_compare property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/directory_compare.md

##### Definition:
```python
@property
def directory_compare(self):
    ...
@directory_compare.setter
def directory_compare(self, value):
    ...
```

### extended_summary_page property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/extended_summary_page.md

##### Definition:
```python
@property
def extended_summary_page(self):
    ...
@extended_summary_page.setter
def extended_summary_page(self, value):
    ...
```

### folder_comparison_extension property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/folder_comparison_extension.md

##### Definition:
```python
@property
def folder_comparison_extension(self):
    ...
@folder_comparison_extension.setter
def folder_comparison_extension(self, value):
    ...
```

### generate_summary_page property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/generate_summary_page.md

##### Definition:
```python
@property
def generate_summary_page(self):
    ...
@generate_summary_page.setter
def generate_summary_page(self, value):
    ...
```

### header_footers_comparison property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/header_footers_comparison.md

##### Definition:
```python
@property
def header_footers_comparison(self):
    ...
@header_footers_comparison.setter
def header_footers_comparison(self, value):
    ...
```

### ignore_change_settings property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/ignore_change_settings.md

##### Definition:
```python
@property
def ignore_change_settings(self):
    ...
@ignore_change_settings.setter
def ignore_change_settings(self, value):
    ...
```

### images_inheritance_mode property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/images_inheritance_mode.md

##### Definition:
```python
@property
def images_inheritance_mode(self):
    ...
@images_inheritance_mode.setter
def images_inheritance_mode(self, value):
    ...
```

### inserted_item_style property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/inserted_item_style.md

##### Definition:
```python
@property
def inserted_item_style(self):
    ...
@inserted_item_style.setter
def inserted_item_style(self, value):
    ...
```

### leave_gaps property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/leave_gaps.md

##### Definition:
```python
@property
def leave_gaps(self):
    ...
@leave_gaps.setter
def leave_gaps(self, value):
    ...
```

### mark_changed_content property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/mark_changed_content.md

##### Definition:
```python
@property
def mark_changed_content(self):
    ...
@mark_changed_content.setter
def mark_changed_content(self, value):
    ...
```

### mark_line_breaks property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/mark_line_breaks.md

##### Definition:
```python
@property
def mark_line_breaks(self):
    ...
@mark_line_breaks.setter
def mark_line_breaks(self, value):
    ...
```

### mark_nested_content property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/mark_nested_content.md

##### Definition:
```python
@property
def mark_nested_content(self):
    ...
@mark_nested_content.setter
def mark_nested_content(self, value):
    ...
```

### original_size property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/original_size.md

##### Definition:
```python
@property
def original_size(self):
    ...
@original_size.setter
def original_size(self, value):
    ...
```

### paper_size property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/paper_size.md

##### Definition:
```python
@property
def paper_size(self):
    ...
@paper_size.setter
def paper_size(self, value):
    ...
```

### password_save_option property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/password_save_option.md

##### Definition:
```python
@property
def password_save_option(self):
    ...
@password_save_option.setter
def password_save_option(self, value):
    ...
```

### revision_author_name property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/revision_author_name.md

##### Definition:
```python
@property
def revision_author_name(self):
    ...
@revision_author_name.setter
def revision_author_name(self, value):
    ...
```

### sensitivity_of_comparison property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/sensitivity_of_comparison.md

##### Definition:
```python
@property
def sensitivity_of_comparison(self):
    ...
@sensitivity_of_comparison.setter
def sensitivity_of_comparison(self, value):
    ...
```

### sensitivity_of_comparison_for_tables property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/sensitivity_of_comparison_for_tables.md

##### Definition:
```python
@property
def sensitivity_of_comparison_for_tables(self):
    ...
@sensitivity_of_comparison_for_tables.setter
def sensitivity_of_comparison_for_tables(self, value):
    ...
```

### show_deleted_content property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/show_deleted_content.md

##### Definition:
```python
@property
def show_deleted_content(self):
    ...
@show_deleted_content.setter
def show_deleted_content(self, value):
    ...
```

### show_inserted_content property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/show_inserted_content.md

##### Definition:
```python
@property
def show_inserted_content(self):
    ...
@show_inserted_content.setter
def show_inserted_content(self, value):
    ...
```

### show_only_changed property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/show_only_changed.md

##### Definition:
```python
@property
def show_only_changed(self):
    ...
@show_only_changed.setter
def show_only_changed(self, value):
    ...
```

### show_only_summary_page property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/show_only_summary_page.md

##### Definition:
```python
@property
def show_only_summary_page(self):
    ...
@show_only_summary_page.setter
def show_only_summary_page(self, value):
    ...
```

### show_revisions property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/show_revisions.md

##### Definition:
```python
@property
def show_revisions(self):
    ...
@show_revisions.setter
def show_revisions(self, value):
    ...
```

### user_master_path property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/user_master_path.md

##### Definition:
```python
@property
def user_master_path(self):
    ...
@user_master_path.setter
def user_master_path(self, value):
    ...
```

### word_track_changes property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/word_track_changes.md

##### Definition:
```python
@property
def word_track_changes(self):
    ...
@word_track_changes.setter
def word_track_changes(self, value):
    ...
```

### words_separator_chars property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/compareoptions/words_separator_chars.md

##### Definition:
```python
@property
def words_separator_chars(self):
    ...
@words_separator_chars.setter
def words_separator_chars(self, value):
    ...
```

### ComparisonDisplayMode class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/comparisondisplaymode.md

#### ComparisonDisplayMode class

The ComparisonDisplayMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| REVISIONS |  |
| HIGHLIGHT |  |

### HIGHLIGHT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/comparisondisplaymode/highlight.md

##### Value
`1`

### REVISIONS field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/comparisondisplaymode/revisions.md

##### Value
`0`

### DetalisationLevel class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/detalisationlevel.md

#### DetalisationLevel class

The DetalisationLevel type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LOW |  |
| MIDDLE |  |
| HIGH |  |

### HIGH field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/detalisationlevel/high.md

##### Value
`2`

### LOW field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/detalisationlevel/low.md

##### Value
`0`

### MIDDLE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/detalisationlevel/middle.md

##### Value
`1`

### DiagramMasterSetting class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/diagrammastersetting.md

#### DiagramMasterSetting class

The DiagramMasterSetting type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| master_path |  |
| use_source_master |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/diagrammastersetting/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/diagrammastersetting/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### master_path property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/diagrammastersetting/master_path.md

##### Definition:
```python
@property
def master_path(self):
    ...
@master_path.setter
def master_path(self, value):
    ...
```

### use_source_master property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/diagrammastersetting/use_source_master.md

##### Definition:
```python
@property
def use_source_master(self):
    ...
@use_source_master.setter
def use_source_master(self, value):
    ...
```

### FileAuthorMetadata class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/fileauthormetadata.md

#### FileAuthorMetadata class

The FileAuthorMetadata type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| author |  |
| company |  |
| last_save_by |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/fileauthormetadata/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/fileauthormetadata/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### author property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/fileauthormetadata/author.md

##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### company property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/fileauthormetadata/company.md

##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### last_save_by property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/fileauthormetadata/last_save_by.md

##### Definition:
```python
@property
def last_save_by(self):
    ...
@last_save_by.setter
def last_save_by(self, value):
    ...
```

### FolderComparisonExtension class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/foldercomparisonextension.md

#### FolderComparisonExtension class

The FolderComparisonExtension type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HTML |  |
| TXT |  |

### HTML field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/foldercomparisonextension/html.md

##### Value
`0`

### TXT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/foldercomparisonextension/txt.md

##### Value
`1`

### GetChangeOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/getchangeoptions.md

#### GetChangeOptions class

The GetChangeOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| filter |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/getchangeoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/getchangeoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### filter property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/getchangeoptions/filter.md

##### Definition:
```python
@property
def filter(self):
    ...
@filter.setter
def filter(self, value):
    ...
```

### IgnoreChangeSensitivitySettings class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/ignorechangesensitivitysettings.md

#### IgnoreChangeSensitivitySettings class

The IgnoreChangeSensitivitySettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| ignore |  |
| ignore_percent |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/ignorechangesensitivitysettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/ignorechangesensitivitysettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### ignore property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/ignorechangesensitivitysettings/ignore.md

##### Definition:
```python
@property
def ignore(self):
    ...
@ignore.setter
def ignore(self, value):
    ...
```

### ignore_percent property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/ignorechangesensitivitysettings/ignore_percent.md

##### Definition:
```python
@property
def ignore_percent(self):
    ...
@ignore_percent.setter
def ignore_percent(self, value):
    ...
```

### ImagesInheritance class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/imagesinheritance.md

#### ImagesInheritance class

The ImagesInheritance type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SOURCE |  |
| TARGET |  |

### SOURCE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/imagesinheritance/source.md

##### Value
`0`

### TARGET field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/imagesinheritance/target.md

##### Value
`1`

### LoadOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions.md

#### LoadOptions class

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| font_directories |  |
| load_text |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### font_directories property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions/font_directories.md

##### Definition:
```python
@property
def font_directories(self):
    ...
@font_directories.setter
def font_directories(self, value):
    ...
```

### load_text property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions/load_text.md

##### Definition:
```python
@property
def load_text(self):
    ...
@load_text.setter
def load_text(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/loadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### MetadataType class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/metadatatype.md

#### MetadataType class

The MetadataType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT |  |
| SOURCE |  |
| TARGET |  |
| FILE_AUTHOR |  |

### DEFAULT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/metadatatype/default.md

##### Value
`0`

### FILE_AUTHOR field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/metadatatype/file_author.md

##### Value
`3`

### SOURCE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/metadatatype/source.md

##### Value
`1`

### TARGET field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/metadatatype/target.md

##### Value
`2`

### OriginalSize class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/originalsize.md

#### OriginalSize class

The OriginalSize type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/originalsize/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/originalsize/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/originalsize/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/originalsize/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PagesSetup class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pagessetup.md

#### PagesSetup class

The PagesSetup type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| end_page |  |
| start_page |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pagessetup/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pagessetup/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### end_page property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pagessetup/end_page.md

##### Definition:
```python
@property
def end_page(self):
    ...
@end_page.setter
def end_page(self, value):
    ...
```

### start_page property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pagessetup/start_page.md

##### Definition:
```python
@property
def start_page(self):
    ...
@start_page.setter
def start_page(self, value):
    ...
```

### PaperSize class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize.md

#### PaperSize class

The PaperSize type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT |  |
| A0 |  |
| A1 |  |
| A2 |  |
| A3 |  |
| A4 |  |
| A5 |  |
| A6 |  |
| A7 |  |
| A8 |  |

### A0 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a0.md

##### Value
`1`

### A1 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a1.md

##### Value
`2`

### A2 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a2.md

##### Value
`3`

### A3 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a3.md

##### Value
`4`

### A4 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a4.md

##### Value
`5`

### A5 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a5.md

##### Value
`6`

### A6 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a6.md

##### Value
`7`

### A7 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a7.md

##### Value
`8`

### A8 field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/a8.md

##### Value
`9`

### DEFAULT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/papersize/default.md

##### Value
`0`

### PasswordSaveOption class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/passwordsaveoption.md

#### PasswordSaveOption class

The PasswordSaveOption type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| SOURCE |  |
| TARGET |  |
| USER |  |

### NONE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/passwordsaveoption/none.md

##### Value
`0`

### SOURCE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/passwordsaveoption/source.md

##### Value
`1`

### TARGET field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/passwordsaveoption/target.md

##### Value
`2`

### USER field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/passwordsaveoption/user.md

##### Value
`3`

### PdfCompareOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions.md

#### PdfCompareOptions class

The PdfCompareOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| annotation_author_name |  |
| compare_images_pdf |  |
| display_mode |  |
| images_inheritance_mode |  |
| pages_setup |  |
| calculate_coordinates |  (inherited from `CompareOptions`) |
| calculate_coordinates_mode |  (inherited from `CompareOptions`) |
| changed_item_style |  (inherited from `CompareOptions`) |
| compare_bookmarks |  (inherited from `CompareOptions`) |
| compare_document_property |  (inherited from `CompareOptions`) |
| compare_variable_property |  (inherited from `CompareOptions`) |
| deleted_item_style |  (inherited from `CompareOptions`) |
| detalisation_level |  (inherited from `CompareOptions`) |
| detect_style_changes |  (inherited from `CompareOptions`) |
| diagram_master_setting |  (inherited from `CompareOptions`) |
| directory_compare |  (inherited from `CompareOptions`) |
| extended_summary_page |  (inherited from `CompareOptions`) |
| folder_comparison_extension |  (inherited from `CompareOptions`) |
| generate_summary_page |  (inherited from `CompareOptions`) |
| header_footers_comparison |  (inherited from `CompareOptions`) |
| ignore_change_settings |  (inherited from `CompareOptions`) |
| inserted_item_style |  (inherited from `CompareOptions`) |
| leave_gaps |  (inherited from `CompareOptions`) |
| mark_changed_content |  (inherited from `CompareOptions`) |
| mark_line_breaks |  (inherited from `CompareOptions`) |
| mark_nested_content |  (inherited from `CompareOptions`) |
| original_size |  (inherited from `CompareOptions`) |
| paper_size |  (inherited from `CompareOptions`) |
| password_save_option |  (inherited from `CompareOptions`) |
| revision_author_name |  (inherited from `CompareOptions`) |
| sensitivity_of_comparison |  (inherited from `CompareOptions`) |
| sensitivity_of_comparison_for_tables |  (inherited from `CompareOptions`) |
| show_deleted_content |  (inherited from `CompareOptions`) |
| show_inserted_content |  (inherited from `CompareOptions`) |
| show_only_changed |  (inherited from `CompareOptions`) |
| show_only_summary_page |  (inherited from `CompareOptions`) |
| show_revisions |  (inherited from `CompareOptions`) |
| user_master_path |  (inherited from `CompareOptions`) |
| word_track_changes |  (inherited from `CompareOptions`) |
| words_separator_chars |  (inherited from `CompareOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### annotation_author_name property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/annotation_author_name.md

##### Definition:
```python
@property
def annotation_author_name(self):
    ...
@annotation_author_name.setter
def annotation_author_name(self, value):
    ...
```

### compare_images_pdf property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/compare_images_pdf.md

##### Definition:
```python
@property
def compare_images_pdf(self):
    ...
@compare_images_pdf.setter
def compare_images_pdf(self, value):
    ...
```

### display_mode property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/display_mode.md

##### Definition:
```python
@property
def display_mode(self):
    ...
@display_mode.setter
def display_mode(self, value):
    ...
```

### images_inheritance_mode property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/images_inheritance_mode.md

##### Definition:
```python
@property
def images_inheritance_mode(self):
    ...
@images_inheritance_mode.setter
def images_inheritance_mode(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/pdfcompareoptions/pages_setup.md

##### Definition:
```python
@property
def pages_setup(self):
    ...
@pages_setup.setter
def pages_setup(self, value):
    ...
```

### PreviewFormats class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewformats.md

#### PreviewFormats class

The PreviewFormats type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PNG |  |
| JPEG |  |
| BMP |  |

### BMP field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewformats/bmp.md

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewformats/jpeg.md

##### Value
`1`

### PNG field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewformats/png.md

##### Value
`0`

### PreviewOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions.md

#### PreviewOptions class

The PreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_create_page_stream |  |
| _init_create_page_stream_release_page_stream |  |

##### Properties
| Property | Description |
| :- | :- |
| create_page_stream |  |
| height |  |
| page_numbers |  |
| preview_format |  |
| release_page_stream |  |
| resolution |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_create_page_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/_init_create_page_stream.md

#### _init_create_page_stream

```python
def _init_create_page_stream(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |

### _init_create_page_stream_release_page_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/_init_create_page_stream_release_page_stream.md

#### _init_create_page_stream_release_page_stream

```python
def _init_create_page_stream_release_page_stream(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| release_page_stream | `ReleasePageStream` |  |

### create_page_stream property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/create_page_stream.md

##### Definition:
```python
@property
def create_page_stream(self):
    ...
@create_page_stream.setter
def create_page_stream(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/page_numbers.md

##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### preview_format property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/preview_format.md

##### Definition:
```python
@property
def preview_format(self):
    ...
@preview_format.setter
def preview_format(self, value):
    ...
```

### release_page_stream property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/release_page_stream.md

##### Definition:
```python
@property
def release_page_stream(self):
    ...
@release_page_stream.setter
def release_page_stream(self, value):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/resolution.md

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PreviewResolution class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewresolution.md

#### PreviewResolution class

The PreviewResolution type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| horizontal_resolution |  |
| vertical_resolution |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewresolution/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewresolution/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### horizontal_resolution property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewresolution/horizontal_resolution.md

##### Definition:
```python
@property
def horizontal_resolution(self):
    ...
@horizontal_resolution.setter
def horizontal_resolution(self, value):
    ...
```

### vertical_resolution property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/previewresolution/vertical_resolution.md

##### Definition:
```python
@property
def vertical_resolution(self):
    ...
@vertical_resolution.setter
def vertical_resolution(self, value):
    ...
```

### SaveOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions.md

#### SaveOptions class

The SaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| clone_metadata_type |  |
| file_author_metadata |  |
| folder_path |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone_metadata_type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions/clone_metadata_type.md

##### Definition:
```python
@property
def clone_metadata_type(self):
    ...
@clone_metadata_type.setter
def clone_metadata_type(self, value):
    ...
```

### file_author_metadata property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions/file_author_metadata.md

##### Definition:
```python
@property
def file_author_metadata(self):
    ...
@file_author_metadata.setter
def file_author_metadata(self, value):
    ...
```

### folder_path property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions/folder_path.md

##### Definition:
```python
@property
def folder_path(self):
    ...
@folder_path.setter
def folder_path(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/saveoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### Size class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/size.md

#### Size class

The Size type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/size/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/size/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/size/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/size/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### StyleSettings class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings.md

#### StyleSettings class

The StyleSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| boarder_color |  |
| end_string_separator |  |
| font_color |  |
| highlight_color |  |
| is_bold |  |
| is_italic |  |
| is_strikethrough |  |
| is_underline |  |
| original_size |  |
| shape_color |  |
| start_string_separator |  |
| words_separators |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### boarder_color property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/boarder_color.md

##### Definition:
```python
@property
def boarder_color(self):
    ...
@boarder_color.setter
def boarder_color(self, value):
    ...
```

### end_string_separator property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/end_string_separator.md

##### Definition:
```python
@property
def end_string_separator(self):
    ...
@end_string_separator.setter
def end_string_separator(self, value):
    ...
```

### font_color property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/font_color.md

##### Definition:
```python
@property
def font_color(self):
    ...
@font_color.setter
def font_color(self, value):
    ...
```

### highlight_color property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/highlight_color.md

##### Definition:
```python
@property
def highlight_color(self):
    ...
@highlight_color.setter
def highlight_color(self, value):
    ...
```

### is_bold property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/is_bold.md

##### Definition:
```python
@property
def is_bold(self):
    ...
@is_bold.setter
def is_bold(self, value):
    ...
```

### is_italic property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/is_italic.md

##### Definition:
```python
@property
def is_italic(self):
    ...
@is_italic.setter
def is_italic(self, value):
    ...
```

### is_strikethrough property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/is_strikethrough.md

##### Definition:
```python
@property
def is_strikethrough(self):
    ...
@is_strikethrough.setter
def is_strikethrough(self, value):
    ...
```

### is_underline property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/is_underline.md

##### Definition:
```python
@property
def is_underline(self):
    ...
@is_underline.setter
def is_underline(self, value):
    ...
```

### original_size property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/original_size.md

##### Definition:
```python
@property
def original_size(self):
    ...
@original_size.setter
def original_size(self, value):
    ...
```

### shape_color property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/shape_color.md

##### Definition:
```python
@property
def shape_color(self):
    ...
@shape_color.setter
def shape_color(self, value):
    ...
```

### start_string_separator property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/start_string_separator.md

##### Definition:
```python
@property
def start_string_separator(self):
    ...
@start_string_separator.setter
def start_string_separator(self, value):
    ...
```

### words_separators property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/stylesettings/words_separators.md

##### Definition:
```python
@property
def words_separators(self):
    ...
@words_separators.setter
def words_separators(self, value):
    ...
```

### WordCompareOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions.md

#### WordCompareOptions class

The WordCompareOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| compare_bookmarks |  |
| compare_document_property |  |
| compare_variable_property |  |
| display_mode |  |
| leave_gaps |  |
| mark_line_breaks |  |
| revision_author_name |  |
| show_revisions |  |
| calculate_coordinates |  (inherited from `CompareOptions`) |
| calculate_coordinates_mode |  (inherited from `CompareOptions`) |
| changed_item_style |  (inherited from `CompareOptions`) |
| compare_images_pdf |  (inherited from `CompareOptions`) |
| deleted_item_style |  (inherited from `CompareOptions`) |
| detalisation_level |  (inherited from `CompareOptions`) |
| detect_style_changes |  (inherited from `CompareOptions`) |
| diagram_master_setting |  (inherited from `CompareOptions`) |
| directory_compare |  (inherited from `CompareOptions`) |
| extended_summary_page |  (inherited from `CompareOptions`) |
| folder_comparison_extension |  (inherited from `CompareOptions`) |
| generate_summary_page |  (inherited from `CompareOptions`) |
| header_footers_comparison |  (inherited from `CompareOptions`) |
| ignore_change_settings |  (inherited from `CompareOptions`) |
| images_inheritance_mode |  (inherited from `CompareOptions`) |
| inserted_item_style |  (inherited from `CompareOptions`) |
| mark_changed_content |  (inherited from `CompareOptions`) |
| mark_nested_content |  (inherited from `CompareOptions`) |
| original_size |  (inherited from `CompareOptions`) |
| paper_size |  (inherited from `CompareOptions`) |
| password_save_option |  (inherited from `CompareOptions`) |
| sensitivity_of_comparison |  (inherited from `CompareOptions`) |
| sensitivity_of_comparison_for_tables |  (inherited from `CompareOptions`) |
| show_deleted_content |  (inherited from `CompareOptions`) |
| show_inserted_content |  (inherited from `CompareOptions`) |
| show_only_changed |  (inherited from `CompareOptions`) |
| show_only_summary_page |  (inherited from `CompareOptions`) |
| user_master_path |  (inherited from `CompareOptions`) |
| word_track_changes |  (inherited from `CompareOptions`) |
| words_separator_chars |  (inherited from `CompareOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_bookmarks property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/compare_bookmarks.md

##### Definition:
```python
@property
def compare_bookmarks(self):
    ...
@compare_bookmarks.setter
def compare_bookmarks(self, value):
    ...
```

### compare_document_property property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/compare_document_property.md

##### Definition:
```python
@property
def compare_document_property(self):
    ...
@compare_document_property.setter
def compare_document_property(self, value):
    ...
```

### compare_variable_property property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/compare_variable_property.md

##### Definition:
```python
@property
def compare_variable_property(self):
    ...
@compare_variable_property.setter
def compare_variable_property(self, value):
    ...
```

### display_mode property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/display_mode.md

##### Definition:
```python
@property
def display_mode(self):
    ...
@display_mode.setter
def display_mode(self, value):
    ...
```

### leave_gaps property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/leave_gaps.md

##### Definition:
```python
@property
def leave_gaps(self):
    ...
@leave_gaps.setter
def leave_gaps(self, value):
    ...
```

### mark_line_breaks property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/mark_line_breaks.md

##### Definition:
```python
@property
def mark_line_breaks(self):
    ...
@mark_line_breaks.setter
def mark_line_breaks(self, value):
    ...
```

### revision_author_name property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/revision_author_name.md

##### Definition:
```python
@property
def revision_author_name(self):
    ...
@revision_author_name.setter
def revision_author_name(self, value):
    ...
```

### show_revisions property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.options/wordcompareoptions/show_revisions.md

##### Definition:
```python
@property
def show_revisions(self):
    ...
@show_revisions.setter
def show_revisions(self, value):
    ...
```

### groupdocs.comparison.result
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result.md

Types under `groupdocs.comparison.result`.

##### Classes
| Class | Description |
| :- | :- |
| `ChangeInfo` |  |
| `FileType` |  |
| `PageInfo` |  |
| `Rectangle` |  |
| `StyleChangeInfo` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ComparisonAction` |  |

### ChangeInfo class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo.md

#### ChangeInfo class

The ChangeInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| authors |  |
| box |  |
| comparison_action |  |
| component_type |  |
| id |  |
| page_info |  |
| source_text |  |
| style_changes |  |
| target_text |  |
| text |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### authors property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/authors.md

##### Definition:
```python
@property
def authors(self):
    ...
@authors.setter
def authors(self, value):
    ...
```

### box property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/box.md

##### Definition:
```python
@property
def box(self):
    ...
@box.setter
def box(self, value):
    ...
```

### comparison_action property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/comparison_action.md

##### Definition:
```python
@property
def comparison_action(self):
    ...
@comparison_action.setter
def comparison_action(self, value):
    ...
```

### component_type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/component_type.md

##### Definition:
```python
@property
def component_type(self):
    ...
@component_type.setter
def component_type(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/id.md

##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### page_info property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/page_info.md

##### Definition:
```python
@property
def page_info(self):
    ...
@page_info.setter
def page_info(self, value):
    ...
```

### source_text property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/source_text.md

##### Definition:
```python
@property
def source_text(self):
    ...
@source_text.setter
def source_text(self, value):
    ...
```

### style_changes property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/style_changes.md

##### Definition:
```python
@property
def style_changes(self):
    ...
@style_changes.setter
def style_changes(self, value):
    ...
```

### target_text property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/target_text.md

##### Definition:
```python
@property
def target_text(self):
    ...
@target_text.setter
def target_text(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/text.md

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/changeinfo/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### ComparisonAction class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/comparisonaction.md

#### ComparisonAction class

The ComparisonAction type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| ACCEPT |  |
| REJECT |  |

### ACCEPT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/comparisonaction/accept.md

##### Value
`1`

### NONE field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/comparisonaction/none.md

##### Value
`0`

### REJECT field
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/comparisonaction/reject.md

##### Value
`2`

### FileType class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype.md

#### FileType class

The FileType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_file_type |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_file_type |  |
| equals_object |  |
| from_file_name_or_extension |  |
| get_hash_code |  |
| get_supported_file_types |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| file_format |  |

### _equals_file_type method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/_equals_file_type.md

#### _equals_file_type

```python
def _equals_file_type(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FileType` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _to_string_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### AS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/as.md

#### AS property

ActionScript Programming Language format

### AS3 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/as3.md

#### AS3 property

ActionScript Programming Language format

### ASM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/asm.md

#### ASM property

ASM format

### BASH property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/bash.md

#### BASH property

Type of interpreter that processes shell commands

### BASHRC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/bashrc.md

#### BASHRC property

File determines the behavior of interactive shells

### BAT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/bat.md

#### BAT property

Script file in DOS, OS/2 and Microsoft Windows

### BMP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/bmp.md

#### BMP property

Bitmap Picture

### BOWERRC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/bowerrc.md

#### BOWERRC property

Configuration file for package control on the server-side

### C property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/c.md

#### C property

C-Based Programming Language format

### CAD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cad.md

#### CAD property

CAD file format

### CAKE property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cake.md

#### CAKE property

CSharp cross-platform build automation system format

### CC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cc.md

#### CC property

C-Based Programming Language format

### CFG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cfg.md

#### CFG property

Configuration file used for storing settings

### CMAKE property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cmake.md

#### CMAKE property

Tool for managing the build process of software

### CMD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cmd.md

#### CMD property

Script file in DOS, OS/2 and Microsoft Windows

### CONF property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/conf.md

#### CONF property

Configuration file used on Unix and Linux based systems

### CPP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cpp.md

#### CPP property

C-Based Programming Language format

### CPY property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cpy.md

#### CPY property

Controller Python Script format

### CS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cs.md

#### CS property

CSharp Programming Language format

### CSV property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/csv.md

#### CSV property

Comma Separated Values File

### CSX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/csx.md

#### CSX property

CSharp script file format

### CTP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ctp.md

#### CTP property

CakePHP Template format

### CXX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/cxx.md

#### CXX property

C-Based Programming Language format

### DCM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dcm.md

#### DCM property

Digital Imaging and Communications in Medicine

### DIFF property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/diff.md

#### DIFF property

Data comparison tool format

### DIR property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dir.md

#### DIR property

Directory is a location for storing files on computer

### DJVU property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/djvu.md

#### DJVU property

Deja Vu format

### DOC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/doc.md

#### DOC property

Microsoft Word 97-2003 Document

### DOCM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/docm.md

#### DOCM property

Microsoft Word Macro-Enabled Document

### DOCX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/docx.md

#### DOCX property

Microsoft Word Document

### DOT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dot.md

#### DOT property

Microsoft Word 97-2003 Template

### DOTM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dotm.md

#### DOTM property

Microsoft Word Macro-Enabled Template

### DOTX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dotx.md

#### DOTX property

Microsoft Word Template

### DSQL property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dsql.md

#### DSQL property

Dynamic Structured Query Language format

### DWG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dwg.md

#### DWG property

Autodesk Design Data Formats

### DXF property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/dxf.md

#### DXF property

AutoCAD Drawing Interchange

### EBUILD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ebuild.md

#### EBUILD property

Specialized bash script which automates compilation and installation procedures for software packages

### EML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/eml.md

#### EML property

E-mail Message

### EMLX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/emlx.md

#### EMLX property

Apple Mail E-mail File

### equals method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_file_type method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/equals_file_type.md

#### equals_file_type

```python
def equals_file_type(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### ERB property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/erb.md

#### ERB property

Ruby Programming Language format

### ES6 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/es6.md

#### ES6 property

JavaScript standardised scripting language format

### extension property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_file_name_or_extension method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/from_file_name_or_extension.md

#### from_file_name_or_extension

```python
def from_file_name_or_extension(cls, file_name_or_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name_or_extension | `str` |  |

**Returns:** FileType

### GEMSPEC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/gemspec.md

#### GEMSPEC property

Developer file that specifies the attributes of a RubyGems

### get_hash_code method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_supported_file_types method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/get_supported_file_types.md

#### get_supported_file_types

```python
def get_supported_file_types(cls):
    ...
```

**Returns:** List[Any]

### GIF property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/gif.md

#### GIF property

Graphics Interchange Format

### GRADLE property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/gradle.md

#### GRADLE property

Build-automation system format

### GROOVY property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/groovy.md

#### GROOVY property

Source code file written in Groovy format

### GVY property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/gvy.md

#### GVY property

Source code file written in Groovy format

### GYP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/gyp.md

#### GYP property

Build automation tool format

### GYPI property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/gypi.md

#### GYPI property

Build automation tool format

### H property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/h.md

#### H property

C-Based header files contain definitions of Functions and Variables

### HAML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/haml.md

#### HAML property

Markup language for simplified HTML generation

### HAR property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/har.md

#### HAR property

The HTTP Archive format

### HH property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/hh.md

#### HH property

Header information referenced by a C++ source code file

### HPP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/hpp.md

#### HPP property

Header Files that are written in the C++ programming language

### HTML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/html.md

#### HTML property

HyperText Markup Language

### HXX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/hxx.md

#### HXX property

Header Files that are written in the C++ programming language

### IPY property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ipy.md

#### IPY property

IPython Script format

### JAVA property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/java.md

#### JAVA property

Java Programming Language format

### JPEG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/jpeg.md

#### JPEG property

Joint Photographic Experts Group

### JS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/js.md

#### JS property

JavaScript Programming Language format

### JSCSRC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/jscsrc.md

#### JSCSRC property

JavaScript configuration file format

### JSHINTRC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/jshintrc.md

#### JSHINTRC property

JavaScript code quality tool

### JSMAP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/jsmap.md

#### JSMAP property

JSON file that contains information on how to translate code back to source code

### JSON property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/json.md

#### JSON property

Lightweight format for storing and transporting data

### LESS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/less.md

#### LESS property

Dynamic preprocessor style sheet language format

### LOG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/log.md

#### LOG property

Logging keeps a registry of events, processes, messages and communication

### MAKE property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/make.md

#### MAKE property

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

### MARKDN property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/markdn.md

#### MARKDN property

Markdown Language format

### MARKDOWN property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/markdown.md

#### MARKDOWN property

Markdown Language format

### MD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/md.md

#### MD property

Markdown Language format

### MDOWN property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mdown.md

#### MDOWN property

Markdown Language format

### MDTEXT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mdtext.md

#### MDTEXT property

Markdown Language format

### MDTXT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mdtxt.md

#### MDTXT property

Markdown Language format

### MDWN property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mdwn.md

#### MDWN property

Markdown Language format

### MHTML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mhtml.md

#### MHTML property

Mime HTML

### MJS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mjs.md

#### MJS property

Extension for EcmaScript (ES) module files

### MK property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mk.md

#### MK property

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

### MKD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mkd.md

#### MKD property

Markdown Language format

### ML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ml.md

#### ML property

Caml Programming Language format

### MLI property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mli.md

#### MLI property

Caml Programming Language format

### MOBI property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/mobi.md

#### MOBI property

Mobipocket e-book format

### MSG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/msg.md

#### MSG property

Microsoft Outlook E-mail Message

### NQP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/nqp.md

#### NQP property

Intermediate language used to build the Rakudo Perl 6 compiler

### OBJC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/objc.md

#### OBJC property

Objective-C Programming Language format

### OBJCP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/objcp.md

#### OBJCP property

Objective-C++ Programming Language format

### ODP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/odp.md

#### ODP property

OpenDocument Presentation

### ODS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ods.md

#### ODS property

OpenDocument Spreadsheet

### ODT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/odt.md

#### ODT property

OpenDocument Text

### ONE property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/one.md

#### ONE property

Microsoft OneNote Document

### OTP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/otp.md

#### OTP property

OpenDocument Presentation Template

### OTT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ott.md

#### OTT property

OpenDocument Text Template

### P6 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/p6.md

#### P6 property

Perl Programming Language format

### PAC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pac.md

#### PAC property

Proxy Auto-Configuration file for JavaScript function format

### PATCH property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/patch.md

#### PATCH property

List of differences format

### PDF property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pdf.md

#### PDF property

Adobe Portable Document format

### PHP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/php.md

#### PHP property

PHP Programming Language format

### PHP4 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/php4.md

#### PHP4 property

PHP Programming Language format

### PHP5 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/php5.md

#### PHP5 property

PHP Programming Language format

### PHTML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/phtml.md

#### PHTML property

Standard file extension for PHP 2 programs format

### PL property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pl.md

#### PL property

Perl Programming Language format

### PL6 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pl6.md

#### PL6 property

Perl Programming Language format

### PM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pm.md

#### PM property

Perl module format

### PM6 property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pm6.md

#### PM6 property

Perl module format

### PNG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/png.md

#### PNG property

Portable Network Graphics

### POD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pod.md

#### POD property

Perl lightweight markup language format

### PODSPEC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/podspec.md

#### PODSPEC property

Ruby build settings format

### POT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pot.md

#### POT property

Microsoft PowerPoint template

### POTX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/potx.md

#### POTX property

Microsoft PowerPoint Template

### PPS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pps.md

#### PPS property

Microsoft PowerPoint 97-2003 Slide Show

### PPSX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ppsx.md

#### PPSX property

Microsoft PowerPoint Slide Show

### PPT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ppt.md

#### PPT property

Microsoft PowerPoint 97-2003 Presentation

### PPTX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pptx.md

#### PPTX property

Microsoft PowerPoint Presentation

### PROP property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/prop.md

#### PROP property

Properties file format

### PSGI property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/psgi.md

#### PSGI property

Interface between web servers and web applications and frameworks written in the Perl programming

### PY property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/py.md

#### PY property

Python Programming Language format

### PYI property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pyi.md

#### PYI property

Python Interface file format

### PYW property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/pyw.md

#### PYW property

Files used in Windows to indicate a script needs to be run

### RAKE property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rake.md

#### RAKE property

Ruby build automation tool

### RB property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rb.md

#### RB property

Ruby Programming Language format

### RBI property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rbi.md

#### RBI property

Ruby Interface file format

### REJ property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rej.md

#### REJ property

Rejected files format

### RJS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rjs.md

#### RJS property

Ruby Programming Language format

### RPY property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rpy.md

#### RPY property

Python-based file engine to create and run games

### RST property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rst.md

#### RST property

Lightweight markup language

### RTF property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/rtf.md

#### RTF property

Rich Text Document

### RU property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/ru.md

#### RU property

Rack configuration file format

### SASS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/sass.md

#### SASS property

Style sheet language format

### SBT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/sbt.md

#### SBT property

SBT build tool for Scala format

### SC property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/sc.md

#### SC property

Scala worksheet format

### SCALA property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/scala.md

#### SCALA property

Scala Programming Language format

### SCSS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/scss.md

#### SCSS property

Style sheet language format

### SH property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/sh.md

#### SH property

Script programmed for bash format

### SQL property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/sql.md

#### SQL property

Structured Query Language format

### SVG property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/svg.md

#### SVG property

Scalar Vector Graphics

### T property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/t.md

#### T property

Perl test file format

### to_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### TXT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/txt.md

#### TXT property

Plain Text Document

### UNKNOWN property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/unknown.md

#### UNKNOWN property

Unknown type

### VDX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/vdx.md

#### VDX property

Microsoft Visio 2003-2010 XML Drawing

### VIM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/vim.md

#### VIM property

Vim source code file format

### VSD property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/vsd.md

#### VSD property

Microsoft Visio 2003-2010 Drawing

### VSDX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/vsdx.md

#### VSDX property

Microsoft Visio Drawing

### VSS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/vss.md

#### VSS property

Microsoft Visio 2003-2010 Stencil

### VST property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/vst.md

#### VST property

Microsoft Visio 2003-2010 Template

### WEBMANIFEST property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/webmanifest.md

#### WEBMANIFEST property

Manifest file includes information about the app

### XLS property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/xls.md

#### XLS property

Microsoft Excel 97-2003 Worksheet

### XLSB property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/xlsb.md

#### XLSB property

Microsoft Excel Binary Worksheet

### XLSM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/xlsm.md

#### XLSM property

Microsoft Excel Macro-Enabled Worksheet

### XLSX property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/xlsx.md

#### XLSX property

Microsoft Excel Worksheet

### XLT property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/xlt.md

#### XLT property

Microsoft Excel template

### XLTM property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/xltm.md

#### XLTM property

Microsoft Excel macro-enabled template

### YAML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/yaml.md

#### YAML property

Human-readable data-serialization language format

### YML property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/filetype/yml.md

#### YML property

Human-readable data-serialization language format

### PageInfo class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/pageinfo.md

#### PageInfo class

The PageInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_int32_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| page_number |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/pageinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_int32_int32 method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/pageinfo/_init_int32_int32_int32.md

#### _init_int32_int32_int32

```python
def _init_int32_int32_int32(self, page_number, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| width | `int` |  |
| height | `int` |  |

### height property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/pageinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/pageinfo/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/pageinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### Rectangle class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle.md

#### Rectangle class

The Rectangle type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_single_single_single_single |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| width |  |
| x |  |
| y |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_single_single_single_single method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle/_init_single_single_single_single.md

#### _init_single_single_single_single

```python
def _init_single_single_single_single(self, x, y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| x | `float` |  |
| y | `float` |  |
| width | `float` |  |
| height | `float` |  |

### height property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle/x.md

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/rectangle/y.md

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### StyleChangeInfo class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo.md

#### StyleChangeInfo class

The StyleChangeInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  |
| _equals_style_change_info |  |
| _get_hash_code_noargs |  |
| _init_noargs |  |
| equals |  |
| equals_object |  |
| equals_style_change_info |  |
| get_hash_code |  |

##### Properties
| Property | Description |
| :- | :- |
| new_value |  |
| old_value |  |
| property_name |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_object method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _equals_style_change_info method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/_equals_style_change_info.md

#### _equals_style_change_info

```python
def _equals_style_change_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `StyleChangeInfo` |  |

**Returns:** bool

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_style_change_info method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/equals_style_change_info.md

#### equals_style_change_info

```python
def equals_style_change_info(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### new_value property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/new_value.md

##### Definition:
```python
@property
def new_value(self):
    ...
@new_value.setter
def new_value(self, value):
    ...
```

### old_value property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/old_value.md

##### Definition:
```python
@property
def old_value(self):
    ...
@old_value.setter
def old_value(self, value):
    ...
```

### property_name property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.result/stylechangeinfo/property_name.md

##### Definition:
```python
@property
def property_name(self):
    ...
@property_name.setter
def property_name(self, value):
    ...
```

### groupdocs.comparison.words.revision
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision.md

The namespace provides classes for working with revisions in WORD format file.

##### Classes
| Class | Description |
| :- | :- |
| `ApplyRevisionOptions` | Allows you to update the state of revisions before they are applied to the final document. |
| `RevisionHandler` | Represents the main class that controls revision handling. |
| `RevisionInfo` | Provides information about one revision. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `RevisionAction` | Action that can be applied to a revision. |
| `RevisionType` | Specifies the type of change being tracked. |

### ApplyRevisionOptions class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/applyrevisionoptions.md

#### ApplyRevisionOptions class

Allows you to update the state of revisions before they are applied to the final document.

The ApplyRevisionOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of ApplyRevisionOptions |

##### Properties
| Property | Description |
| :- | :- |
| changes | The list of revisions processed, which will be applied to the resulting document. |
| common_handler | Indicates whether to apply one action for all revisions |

### ApplyRevisionOptions constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/applyrevisionoptions/__init__.md

#### __init__

Constructs a new instance of ApplyRevisionOptions

```python
def __init__(self):
    ...
```

### changes property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/applyrevisionoptions/changes.md

#### changes property

The list of revisions processed, which will be applied to the resulting document.
##### Definition:
```python
@property
def changes(self):
    ...
@changes.setter
def changes(self, value):
    ...
```

### common_handler property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/applyrevisionoptions/common_handler.md

#### common_handler property

Indicates whether to apply one action for all revisions
##### Definition:
```python
@property
def common_handler(self):
    ...
@common_handler.setter
def common_handler(self, value):
    ...
```

### RevisionAction enumeration
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisionaction.md

#### RevisionAction enumeration

Action that can be applied to a revision.

The RevisionAction type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Nothing to do. |
| ACCEPT | The revision will be displayed if it is of type INSERTION or will be removed if the type is DELETION. |
| REJECT | The revision will be removed if it is of type INSERTION or will be displayed if the type is DELETION. |

### RevisionHandler class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisionhandler.md

#### RevisionHandler class

Represents the main class that controls revision handling.

The RevisionHandler type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes new instance of `RevisionHandler` class with the path to the file with revisions. |
| __init__ | Initializes new instance of `RevisionHandler` class with a file stream with revisions. |

##### Methods
| Method | Description |
| :- | :- |
| apply_revision_changes | Processes changes in revisions and applies them to the same file from which the revisions were taken. |
| apply_revision_changes | Processes changes in revisions, and the result is written to the specified file by path. |
| apply_revision_changes | Processes changes in revisions and the result is written to the document stream. |
| get_revisions | Gets list of all revisions. |

### RevisionHandler constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisionhandler/__init__.md

#### __init__

Initializes new instance of `RevisionHandler` class with the path to the file with revisions.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | File path |

#### __init__

Initializes new instance of `RevisionHandler` class with a file stream with revisions.

```python
def __init__(self, file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file | io.RawIOBase | Source document stream |

### apply_revision_changes method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisionhandler/apply_revision_changes.md

#### apply_revision_changes

Processes changes in revisions and applies them to the same file from which the revisions were taken.

```python
def apply_revision_changes(self, changes):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| changes | groupdocs.comparison.words.revision.ApplyRevisionOptions | List of changed revisions |

#### apply_revision_changes

Processes changes in revisions, and the result is written to the specified file by path.

```python
def apply_revision_changes(self, file_path, changes):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | Result file path |
| changes | groupdocs.comparison.words.revision.ApplyRevisionOptions | List of changed revisions |

#### apply_revision_changes

Processes changes in revisions and the result is written to the document stream.

```python
def apply_revision_changes(self, document, changes):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | Result document |
| changes | groupdocs.comparison.words.revision.ApplyRevisionOptions | List of changed revisions |

### get_revisions method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisionhandler/get_revisions.md

#### get_revisions

Gets list of all revisions.

```python
def get_revisions(self):
    ...
```

### RevisionInfo class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisioninfo.md

#### RevisionInfo class

Provides information about one revision.

The RevisionInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of RevisionInfo |

##### Properties
| Property | Description |
| :- | :- |
| action | Action (accept or reject). This field allows you to influence the display of the revision. |
| text | The text that is in revision. |
| author | Author of revision. |
| type | RevisionHandler type, depending on the type the Action (accept or reject) logic changes. |

### RevisionInfo constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisioninfo/__init__.md

#### __init__

Constructs a new instance of RevisionInfo

```python
def __init__(self):
    ...
```

### action property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisioninfo/action.md

#### action property

Action (accept or reject). This field allows you to influence the display of the revision.
##### Definition:
```python
@property
def action(self):
    ...
@action.setter
def action(self, value):
    ...
```

### author property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisioninfo/author.md

#### author property

Author of revision.
##### Definition:
```python
@property
def author(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisioninfo/text.md

#### text property

The text that is in revision.
##### Definition:
```python
@property
def text(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisioninfo/type.md

#### type property

RevisionHandler type, depending on the type the Action (accept or reject) logic changes.
##### Definition:
```python
@property
def type(self):
    ...
```

### RevisionType enumeration
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.revision/revisiontype.md

#### RevisionType enumeration

Specifies the type of change being tracked.

The RevisionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| INSERTION | New content was inserted in the document. |
| DELETION | Content was removed from the document. |
| FORMAT_CHANGE | Change of formatting was applied to the parent node. |
| STYLE_DEFINITION_CHANGE | Change of formatting was applied to the parent style. |
| MOVING | Content was moved in the document. |

### groupdocs.comparison.words
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.words.md

### groupdocs.comparison
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison.md

Main GroupDocs.Comparison namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `Comparer` |  |
| `ComparerSettings` |  |
| `Document` |  |
| `License` | Manages GroupDocs.Comparison licensing. |
| `Metered` | Manages metered (pay-per-use) licensing. |

##### Exceptions
| Exception | Description |
| :- | :- |
| `ComparisonException` |  |
| `DocumentComparisonException` |  |
| `FileFormatException` |  |
| `GroupDocsComparisonException` | Product-root exception for 'comparison' — every |
| `InvalidPasswordException` |  |
| `PasswordProtectedFileException` |  |
| `UnsupportedFileFormatException` |  |

### Comparer class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer.md

#### Comparer class

The Comparer type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _add_stream |  |
| _add_stream_load_options |  |
| _add_string |  |
| _add_string_compare_options |  |
| _add_string_load_options |  |
| _apply_changes_stream_apply_change_options |  |
| _apply_changes_stream_save_options_apply_change_options |  |
| _apply_changes_string_apply_change_options |  |
| _apply_changes_string_save_options_apply_change_options |  |
| _compare_compare_options |  |
| _compare_directory_string_compare_options |  |
| _compare_noargs |  |
| _compare_save_options_compare_options |  |
| _compare_stream |  |
| _compare_stream_compare_options |  |
| _compare_stream_save_options |  |
| _compare_stream_save_options_compare_options |  |
| _compare_string |  |
| _compare_string_compare_options |  |
| _compare_string_save_options |  |
| _compare_string_save_options_compare_options |  |
| _dispose_noargs |  |
| _get_changes_change_type |  |
| _get_changes_get_change_options |  |
| _get_changes_noargs |  |
| _get_result_document_stream_noargs |  |
| _get_result_string_noargs |  |
| _init_stream |  |
| _init_stream_comparer_settings |  |
| _init_stream_load_options |  |
| _init_stream_load_options_comparer_settings |  |
| _init_string |  |
| _init_string_compare_options |  |
| _init_string_comparer_settings |  |
| _init_string_load_options |  |
| _init_string_load_options_comparer_settings |  |
| add |  |
| add_file |  |
| add_stream |  |
| add_streams |  |
| add_string |  |
| apply_changes |  |
| apply_changes_file |  |
| apply_changes_stream |  |
| apply_changes_streams |  |
| apply_changes_string |  |
| compare |  |
| compare_compare_options |  |
| compare_directory |  |
| compare_directory_file |  |
| compare_directory_string |  |
| compare_file |  |
| compare_save_options |  |
| compare_stream |  |
| compare_streams |  |
| compare_string |  |
| dispose |  |
| get_changes |  |
| get_changes_change_type |  |
| get_changes_get_change_options |  |
| get_result_document_stream |  |
| get_result_string |  |

##### Properties
| Property | Description |
| :- | :- |
| result |  |
| source |  |
| source_folder |  |
| source_folder |  |
| target_folder |  |
| target_folder |  |
| targets |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _add_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_add_stream.md

#### _add_stream

```python
def _add_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _add_stream_load_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_add_stream_load_options.md

#### _add_stream_load_options

```python
def _add_stream_load_options(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `LoadOptions` |  |

### _add_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_add_string.md

#### _add_string

```python
def _add_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _add_string_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_add_string_compare_options.md

#### _add_string_compare_options

```python
def _add_string_compare_options(self, file_path, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| compare_options | `CompareOptions` |  |

### _add_string_load_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_add_string_load_options.md

#### _add_string_load_options

```python
def _add_string_load_options(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `LoadOptions` |  |

### _apply_changes_stream_apply_change_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_apply_changes_stream_apply_change_options.md

#### _apply_changes_stream_apply_change_options

```python
def _apply_changes_stream_apply_change_options(self, stream, apply_change_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| apply_change_options | `ApplyChangeOptions` |  |

### _apply_changes_stream_save_options_apply_change_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_apply_changes_stream_save_options_apply_change_options.md

#### _apply_changes_stream_save_options_apply_change_options

```python
def _apply_changes_stream_save_options_apply_change_options(self, stream, save_options, apply_change_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| save_options | `SaveOptions` |  |
| apply_change_options | `ApplyChangeOptions` |  |

### _apply_changes_string_apply_change_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_apply_changes_string_apply_change_options.md

#### _apply_changes_string_apply_change_options

```python
def _apply_changes_string_apply_change_options(self, file_path, apply_change_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| apply_change_options | `ApplyChangeOptions` |  |

### _apply_changes_string_save_options_apply_change_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_apply_changes_string_save_options_apply_change_options.md

#### _apply_changes_string_save_options_apply_change_options

```python
def _apply_changes_string_save_options_apply_change_options(self, file_path, save_options, apply_change_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| save_options | `SaveOptions` |  |
| apply_change_options | `ApplyChangeOptions` |  |

### _compare_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_compare_options.md

#### _compare_compare_options

```python
def _compare_compare_options(self, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| compare_options | `CompareOptions` |  |

**Returns:** Document

### _compare_directory_string_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_directory_string_compare_options.md

#### _compare_directory_string_compare_options

```python
def _compare_directory_string_compare_options(self, file_path, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| compare_options | `CompareOptions` |  |

### _compare_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_noargs.md

#### _compare_noargs

```python
def _compare_noargs(self):
    ...
```

**Returns:** Document

### _compare_save_options_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_save_options_compare_options.md

#### _compare_save_options_compare_options

```python
def _compare_save_options_compare_options(self, save_options, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| save_options | `SaveOptions` |  |
| compare_options | `CompareOptions` |  |

**Returns:** Document

### _compare_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_stream.md

#### _compare_stream

```python
def _compare_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

**Returns:** Document

### _compare_stream_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_stream_compare_options.md

#### _compare_stream_compare_options

```python
def _compare_stream_compare_options(self, document, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| compare_options | `CompareOptions` |  |

**Returns:** Document

### _compare_stream_save_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_stream_save_options.md

#### _compare_stream_save_options

```python
def _compare_stream_save_options(self, document, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| save_options | `SaveOptions` |  |

**Returns:** Document

### _compare_stream_save_options_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_stream_save_options_compare_options.md

#### _compare_stream_save_options_compare_options

```python
def _compare_stream_save_options_compare_options(self, stream, save_options, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| save_options | `SaveOptions` |  |
| compare_options | `CompareOptions` |  |

**Returns:** Document

### _compare_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_string.md

#### _compare_string

```python
def _compare_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

**Returns:** Document

### _compare_string_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_string_compare_options.md

#### _compare_string_compare_options

```python
def _compare_string_compare_options(self, file_path, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| compare_options | `CompareOptions` |  |

**Returns:** Document

### _compare_string_save_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_string_save_options.md

#### _compare_string_save_options

```python
def _compare_string_save_options(self, file_path, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| save_options | `SaveOptions` |  |

**Returns:** Document

### _compare_string_save_options_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_compare_string_save_options_compare_options.md

#### _compare_string_save_options_compare_options

```python
def _compare_string_save_options_compare_options(self, file_path, save_options, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| save_options | `SaveOptions` |  |
| compare_options | `CompareOptions` |  |

**Returns:** Document

### _dispose_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _get_changes_change_type method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_get_changes_change_type.md

#### _get_changes_change_type

```python
def _get_changes_change_type(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `ChangeType` |  |

**Returns:** List[ChangeInfo]

### _get_changes_get_change_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_get_changes_get_change_options.md

#### _get_changes_get_change_options

```python
def _get_changes_get_change_options(self, get_change_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_change_options | `GetChangeOptions` |  |

**Returns:** List[ChangeInfo]

### _get_changes_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_get_changes_noargs.md

#### _get_changes_noargs

```python
def _get_changes_noargs(self):
    ...
```

**Returns:** List[ChangeInfo]

### _get_result_document_stream_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_get_result_document_stream_noargs.md

#### _get_result_document_stream_noargs

```python
def _get_result_document_stream_noargs(self):
    ...
```

**Returns:** Stream

### _get_result_string_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_get_result_string_noargs.md

#### _get_result_string_noargs

```python
def _get_result_string_noargs(self):
    ...
```

**Returns:** str

### _init_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_stream.md

#### _init_stream

```python
def _init_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _init_stream_comparer_settings method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_stream_comparer_settings.md

#### _init_stream_comparer_settings

```python
def _init_stream_comparer_settings(self, document, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| settings | `ComparerSettings` |  |

### _init_stream_load_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_stream_load_options.md

#### _init_stream_load_options

```python
def _init_stream_load_options(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `LoadOptions` |  |

### _init_stream_load_options_comparer_settings method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_stream_load_options_comparer_settings.md

#### _init_stream_load_options_comparer_settings

```python
def _init_stream_load_options_comparer_settings(self, document, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `LoadOptions` |  |
| settings | `ComparerSettings` |  |

### _init_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_string_compare_options.md

#### _init_string_compare_options

```python
def _init_string_compare_options(self, folder_path, compare_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| folder_path | `str` |  |
| compare_options | `CompareOptions` |  |

### _init_string_comparer_settings method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_string_comparer_settings.md

#### _init_string_comparer_settings

```python
def _init_string_comparer_settings(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| settings | `ComparerSettings` |  |

### _init_string_load_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_string_load_options.md

#### _init_string_load_options

```python
def _init_string_load_options(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `LoadOptions` |  |

### _init_string_load_options_comparer_settings method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/_init_string_load_options_comparer_settings.md

#### _init_string_load_options_comparer_settings

```python
def _init_string_load_options_comparer_settings(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `LoadOptions` |  |
| settings | `ComparerSettings` |  |

### add method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/add.md

#### add

```python
def add(self):
    ...
```

### add_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/add_file.md

#### add_file

```python
def add_file(self):
    ...
```

### add_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/add_stream.md

#### add_stream

```python
def add_stream(self):
    ...
```

### add_streams method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/add_streams.md

#### add_streams

```python
def add_streams(self):
    ...
```

### add_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/add_string.md

#### add_string

```python
def add_string(self):
    ...
```

### apply_changes method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/apply_changes.md

#### apply_changes

```python
def apply_changes(self):
    ...
```

### apply_changes_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/apply_changes_file.md

#### apply_changes_file

```python
def apply_changes_file(self):
    ...
```

### apply_changes_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/apply_changes_stream.md

#### apply_changes_stream

```python
def apply_changes_stream(self):
    ...
```

### apply_changes_streams method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/apply_changes_streams.md

#### apply_changes_streams

```python
def apply_changes_streams(self):
    ...
```

### apply_changes_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/apply_changes_string.md

#### apply_changes_string

```python
def apply_changes_string(self):
    ...
```

### compare method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare.md

#### compare

```python
def compare(self):
    ...
```

### compare_compare_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_compare_options.md

#### compare_compare_options

```python
def compare_compare_options(self):
    ...
```

### compare_directory method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_directory.md

#### compare_directory

```python
def compare_directory(self):
    ...
```

### compare_directory_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_directory_file.md

#### compare_directory_file

```python
def compare_directory_file(self):
    ...
```

### compare_directory_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_directory_string.md

#### compare_directory_string

```python
def compare_directory_string(self):
    ...
```

### compare_file method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_file.md

#### compare_file

```python
def compare_file(self):
    ...
```

### compare_save_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_save_options.md

#### compare_save_options

```python
def compare_save_options(self):
    ...
```

### compare_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_stream.md

#### compare_stream

```python
def compare_stream(self):
    ...
```

### compare_streams method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_streams.md

#### compare_streams

```python
def compare_streams(self):
    ...
```

### compare_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/compare_string.md

#### compare_string

```python
def compare_string(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### get_changes method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/get_changes.md

#### get_changes

```python
def get_changes(self):
    ...
```

### get_changes_change_type method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/get_changes_change_type.md

#### get_changes_change_type

```python
def get_changes_change_type(self):
    ...
```

### get_changes_get_change_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/get_changes_get_change_options.md

#### get_changes_get_change_options

```python
def get_changes_get_change_options(self):
    ...
```

### get_result_document_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/get_result_document_stream.md

#### get_result_document_stream

```python
def get_result_document_stream(self):
    ...
```

### get_result_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/get_result_string.md

#### get_result_string

```python
def get_result_string(self):
    ...
```

### result property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/result.md

##### Definition:
```python
@property
def result(self):
    ...
```

### source property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/source.md

##### Definition:
```python
@property
def source(self):
    ...
```

### source_folder property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/source_folder.md

##### Definition:
```python
@property
def source_folder(self):
    ...
```

### target_folder property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/target_folder.md

##### Definition:
```python
@property
def target_folder(self):
    ...
@target_folder.setter
def target_folder(self, value):
    ...
```

### targets property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparer/targets.md

##### Definition:
```python
@property
def targets(self):
    ...
```

### ComparerSettings class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparersettings.md

#### ComparerSettings class

The ComparerSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| logger |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparersettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparersettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### logger property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparersettings/logger.md

##### Definition:
```python
@property
def logger(self):
    ...
@logger.setter
def logger(self, value):
    ...
```

### ComparisonException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/comparisonexception.md

#### ComparisonException class

The ComparisonException type exposes the following members:

### Document class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document.md

#### Document class

The Document type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _generate_preview_preview_options |  |
| _get_document_info_noargs |  |
| _init_stream |  |
| _init_stream_string |  |
| _init_string |  |
| _init_string_string |  |
| generate_preview |  |
| generate_preview_preview_options |  |
| get_document_info |  |

##### Properties
| Property | Description |
| :- | :- |
| changes |  |
| file_type |  |
| name |  |
| password |  |
| stream |  |

### __init__ constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _generate_preview_preview_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/_generate_preview_preview_options.md

#### _generate_preview_preview_options

```python
def _generate_preview_preview_options(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | `PreviewOptions` |  |

### _get_document_info_noargs method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/_get_document_info_noargs.md

#### _get_document_info_noargs

```python
def _get_document_info_noargs(self):
    ...
```

**Returns:** IDocumentInfo

### _init_stream method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/_init_stream.md

#### _init_stream

```python
def _init_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

### _init_stream_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/_init_stream_string.md

#### _init_stream_string

```python
def _init_stream_string(self, stream, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| password | `str` |  |

### _init_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_string method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/_init_string_string.md

#### _init_string_string

```python
def _init_string_string(self, file_path, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| password | `str` |  |

### changes property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/changes.md

##### Definition:
```python
@property
def changes(self):
    ...
@changes.setter
def changes(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_preview_options method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/generate_preview_preview_options.md

#### generate_preview_preview_options

```python
def generate_preview_preview_options(self):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/password.md

##### Definition:
```python
@property
def password(self):
    ...
```

### stream property
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/document/stream.md

##### Definition:
```python
@property
def stream(self):
    ...
```

### DocumentComparisonException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/documentcomparisonexception.md

#### DocumentComparisonException class

The DocumentComparisonException type exposes the following members:

### FileFormatException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/fileformatexception.md

#### FileFormatException class

The FileFormatException type exposes the following members:

### GroupDocsComparisonException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/groupdocscomparisonexception.md

#### GroupDocsComparisonException class

Product-root exception for 'comparison' — every

generated exception subclasses this, and callers can
``except GroupDocsComparisonException:`` as a catch-all for
this product without catching other GroupDocs errors.

The GroupDocsComparisonException type exposes the following members:

### InvalidPasswordException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/invalidpasswordexception.md

#### InvalidPasswordException class

The InvalidPasswordException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/license.md

#### License class

Manages GroupDocs.Comparison licensing.

Licensed builds unlock the full feature set of the wrapper at
runtime. Unlicensed builds run in evaluation mode with the same API
surface but with limits on output size and watermarked content.

The License type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| set_license | Apply a license to the current process. |

### License constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/license/__init__.md

#### __init__

Constructs a new instance of License

```python
def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/license/set_license.md

#### set_license

Apply a license to the current process.

```python
def set_license(self, license_source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_source |  | Either a string path to a ``.lic`` file or a readable file-like object that yields the license bytes. File-like inputs are written to a temporary file before being passed to the bridge. |

| Raises | Description |
| :- | :- |
| `TypeError` | If ``license_source`` is neither a string path nor a readable file-like object. |

### Metered class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/metered.md

#### Metered class

Manages metered (pay-per-use) licensing.

Metered licenses bill on actual consumption (typically pages or
documents processed). Set the public/private key pair once at
application startup; the wrapper reports usage back to the GroupDocs
license server in the background.

The Metered type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_consumption_credit | Return the remaining metered credit for the current key. |
| get_consumption_quantity | Return the total metered quantity consumed so far. |
| set_metered_key | Activate metered billing with the given public/private key pair. |

### Metered constructor
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/metered/__init__.md

#### __init__

Initializes a new instance of the `Metered` class.

```python
def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/metered/get_consumption_credit.md

#### get_consumption_credit

Return the remaining metered credit for the current key.

```python
def get_consumption_credit():
    ...
```

**Returns:** float: The remaining credit balance reported by the license
server.

### get_consumption_quantity method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/metered/get_consumption_quantity.md

#### get_consumption_quantity

Return the total metered quantity consumed so far.

```python
def get_consumption_quantity():
    ...
```

**Returns:** float: The cumulative usage (typically in pages or documents)
recorded against the current metered key.

### set_metered_key method
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/metered/set_metered_key.md

#### set_metered_key

Activate metered billing with the given public/private key pair.

```python
def set_metered_key(self, public_key, private_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| public_key |  | The public key half of the metered credentials. |
| private_key |  | The private key half of the metered credentials. |

### PasswordProtectedFileException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/passwordprotectedfileexception.md

#### PasswordProtectedFileException class

The PasswordProtectedFileException type exposes the following members:

### UnsupportedFileFormatException class
Path: https://reference.groupdocs.com/comparison/python-net/groupdocs.comparison/unsupportedfileformatexception.md

#### UnsupportedFileFormatException class

The UnsupportedFileFormatException type exposes the following members:


# GroupDocs.Conversion

> Convert between 170+ document and image formats — PDF, Office, CAD, email, and more.

## Java

### GroupDocs.Conversion for Java
Path: https://reference.groupdocs.com/conversion/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.conversion | The scope for GroupDocs.Conversion classes
 |
| com.groupdocs.conversion.caching | The GroupDocs.Conversion.Caching namespace provides classes for customizing caching behaviour.
 |
| com.groupdocs.conversion.contracts | The GroupDocs.Conversion.Contracts namespace provides members to instantiate and release output document, manage font substitutions etc.
 |
| com.groupdocs.conversion.contracts.documentinfo | The GroupDocs.Conversion.Contracts.Documentinfo namespace provides metadata for a document.
 |
| com.groupdocs.conversion.exceptions | The GroupDocs.Conversion.Exceptions namespace provides different exceptions classes.
 |
| com.groupdocs.conversion.filetypes | The GroupDocs.Conversion.FileTypes namespace provides classes which represent supported file types.
 |
| com.groupdocs.conversion.fluent |  |
| com.groupdocs.conversion.integration.audio |  |
| com.groupdocs.conversion.integration.ocr | The GroupDocs.Conversion.Integration.Ocr package provides metadata for a OCR.
 |
| com.groupdocs.conversion.integration.video |  |
| com.groupdocs.conversion.licensing | The GroupDocs.Conversion.Legacy.Licensing namespace provides classes for applying of the license
 |
| com.groupdocs.conversion.logging | The GroupDocs.Conversion.Logging namespace provides classes for customizing logging behaviour.
 |
| com.groupdocs.conversion.options.convert | The GroupDocs.Conversion.Options.Convert namespace provides classes to specify additional options for document conversion process.
 |
| com.groupdocs.conversion.options.load | The GroupDocs.Conversion.Options.Load namespace provides classes to specify additional options for document loading process.
 |
| com.groupdocs.conversion.reporting | The GroupDocs.Conversion.Options.Load namespace provides classes to implement converter listening.
 |

### com.groupdocs.conversion.caching
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.caching.md

The GroupDocs.Conversion.Caching namespace provides classes for customizing caching behaviour.
**Learn more** More about caching and optimizing conversion process performance: Caching conversion results

#### Classes

| Class | Description |
| --- | --- |
| FileCache | File caching behaviour. |
| MemoryCache | Memory caching behaviour. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICache | Defines methods required for storing rendered document and document resources \\u0441ache. |

### FileCache
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.caching/filecache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.caching.ICache
```
public final class FileCache implements ICache
```

File caching behaviour. Means that cache is stored on the file system **Learn more** More about caching and optimizing conversion process performance: Caching conversion results

#### Constructors

| Constructor | Description |
| --- | --- |
| FileCache(String cachePath) | Creates new instance of FileCache class
 |
#### Methods

| Method | Description |
| --- | --- |
| set(String key, Object value) | Inserts a cache entry into the cache.
 |
| tryGetValue(String key) | Gets the entry associated with this key if present.
 |
| getKeys(String filter) | Returns all keys matching filter.
 |
##### FileCache(String cachePath)
```
public FileCache(String cachePath)
```

Creates new instance of FileCache class

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.lang.String | Relative or absolute path where document cache will be stored
 |

##### set(String key, Object value)
```
public void set(String key, Object value)
```

Inserts a cache entry into the cache.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A unique identifier for the cache entry.
 |
| value | java.lang.Object | The object to insert.
 |

##### tryGetValue(String key)
```
public Object tryGetValue(String key)
```

Gets the entry associated with this key if present.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry.
 |

**Returns:**
java.lang.Object - Object if the key was found or else null.

##### getKeys(String filter)
```
public Iterable<String> getKeys(String filter)
```

Returns all keys matching filter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | The filter to use.
 |

**Returns:**
java.lang.Iterable<java.lang.String> - Keys matching the filter.

### ICache
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.caching/icache.md

### MemoryCache
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.caching/memorycache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.caching.ICache
```
public class MemoryCache implements ICache
```

Memory caching behaviour. Means that cache is stored in the memory **Learn more** More about caching and optimizing conversion process performance: Caching conversion results

#### Constructors

| Constructor | Description |
| --- | --- |
| MemoryCache() | Creates new instance of MemoryCache class
 |
#### Methods

| Method | Description |
| --- | --- |
| set(String key, Object value) | Inserts a cache entry into the cache.
 |
| tryGetValue(String key) | Gets the entry associated with this key if present.
 |
| getKeys(String filter) | Returns all keys matching filter.
 |
##### MemoryCache()
```
public MemoryCache()
```

Creates new instance of MemoryCache class

##### set(String key, Object value)
```
public void set(String key, Object value)
```

Inserts a cache entry into the cache.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A unique identifier for the cache entry.
 |
| value | java.lang.Object | The object to insert.
 |

##### tryGetValue(String key)
```
public Object tryGetValue(String key)
```

Gets the entry associated with this key if present.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry.
 |

**Returns:**
java.lang.Object - The located value or null.

##### getKeys(String filter)
```
public Iterable<String> getKeys(String filter)
```

Returns all keys matching filter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | he filter to use.
 |

**Returns:**
java.lang.Iterable<java.lang.String> - Keys matching the filter.

### com.groupdocs.conversion.contracts.documentinfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo.md

The GroupDocs.Conversion.Contracts.Documentinfo namespace provides metadata for a document.

#### Classes

| Class | Description |
| --- | --- |
| AudioDocumentInfo | Contains Audio document metadata |
| CadDocumentInfo | Contains Cad document metadata |
| CgmDocumentInfo | Contains Cgm document metadata |
| CsvDocumentInfo | Contains Csv document metadata |
| DiagramDocumentInfo | Contains Diagram document metadata |
| DjVuDocumentInfo | Contains DjVu document metadata |
| DocumentInfo | Provides base implementation for retrieving polymorphic document information |
| EmailDocumentInfo | Contains Email document metadata |
| EpsDocumentInfo | Contains Ps document metadata |
| EpubDocumentInfo | Contains Epub document metadata |
| FontDocumentInfo | Contains Font document metadata |
| IcoDocumentInfo | Contains Ico document metadata |
| ImageDocumentInfo | Contains Image document metadata |
| JsonDocumentInfo | Contains Json document metadata |
| MarkdownDocumentInfo | Contains Md document metadata |
| NoteDocumentInfo | Contains Note document metadata |
| PasswordProtectedDocumentInfo | Provided document is password protected |
| PclDocumentInfo | Contains Pcl document metadata |
| PdfDocumentInfo | Contains Pdf document metadata |
| PersonalStorageDocumentInfo | Contains personal storage document metadata |
| PersonalStorageFolderInfo | Personal Storage Folder info |
| PresentationDocumentInfo | Contains Presentation document metadata |
| ProjectManagementDocumentInfo | Contains ProjectManagement document metadata |
| PsDocumentInfo | Contains Ps document metadata |
| PsdDocumentInfo | Contains Psd document metadata |
| PublisherDocumentInfo | Contains Publisher document metadata |
| SpreadsheetDocumentInfo | Contains Spreadsheet document metadata |
| SvgDocumentInfo | Contains Svg document metadata |
| TableOfContentsItem | Contains Table of contents item metadata |
| TexDocumentInfo | Contains Tex document metadata |
| TsvDocumentInfo | Contains Tsv document metadata |
| TxtDocumentInfo | Contains Txt document metadata |
| VcfDocumentInfo | Contains Vcf document metadata |
| VideoDocumentInfo | Contains Video document metadata |
| WebDocumentInfo | Contains Web document metadata |
| WordProcessingDocumentInfo | Contains Wordprocessing document metadata |
| XmlDocumentInfo | Contains Xml document metadata |
| XpsDocumentInfo | Contains Xps document metadata |
| XslFoDocumentInfo | Contains XslFo document metadata |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Contains metadata for a document. |

### AudioDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/audiodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class AudioDocumentInfo extends DocumentInfo
```

Contains Audio document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| AudioDocumentInfo(FileType format, long size) |  |
##### AudioDocumentInfo(FileType format, long size)
```
public AudioDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### CadDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/caddocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class CadDocumentInfo extends DocumentInfo
```

Contains Cad document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| CadDocumentInfo(Image cad, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | width
 |
| getHeight() | height
 |
| getLayouts() | layouts in the document
 |
| getLayers() | layers in the document
 |
##### CadDocumentInfo(Image cad, FileType format, long size)
```
public CadDocumentInfo(Image cad, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cad | com.aspose.cad.Image |  |
| format | FileType |  |
| size | long |  |

##### getWidth()
```
public int getWidth()
```

width

**Returns:**
int - width

##### getHeight()
```
public int getHeight()
```

height

**Returns:**
int - height

##### getLayouts()
```
public List<String> getLayouts()
```

layouts in the document

**Returns:**
java.util.List<java.lang.String> - layouts in the document

##### getLayers()
```
public List<String> getLayers()
```

layers in the document

**Returns:**
java.util.List<java.lang.String> - layers in the document

### CgmDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/cgmdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class CgmDocumentInfo extends PdfDocumentInfo
```

Contains Cgm document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| CgmDocumentInfo(Document cgm, FileType format, long size) |  |
##### CgmDocumentInfo(Document cgm, FileType format, long size)
```
public CgmDocumentInfo(Document cgm, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cgm | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### CsvDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/csvdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.SpreadsheetDocumentInfo
```
public class CsvDocumentInfo extends SpreadsheetDocumentInfo
```

Contains Csv document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| CsvDocumentInfo(Workbook csv, FileType format, long size) |  |
##### CsvDocumentInfo(Workbook csv, FileType format, long size)
```
public CsvDocumentInfo(Workbook csv, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| csv | com.aspose.cells.Workbook |  |
| format | FileType |  |
| size | long |  |

### DiagramDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/diagramdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class DiagramDocumentInfo extends DocumentInfo
```

Contains Diagram document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramDocumentInfo(Diagram diagram, FileType format, long size) |  |
##### DiagramDocumentInfo(Diagram diagram, FileType format, long size)
```
public DiagramDocumentInfo(Diagram diagram, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| diagram | com.aspose.diagram.Diagram |  |
| format | FileType |  |
| size | long |  |

### DjVuDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/djvudocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.ImageDocumentInfo
```
public class DjVuDocumentInfo extends ImageDocumentInfo
```

Contains DjVu document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| DjVuDocumentInfo(DjvuImage image, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getVerticalResolution() | Gets vertical resolution
 |
| getHorizontalResolution() | Get horizontal resolution
 |
| getOpacity() | Gets image opacity
 |
##### DjVuDocumentInfo(DjvuImage image, FileType format, long size)
```
public DjVuDocumentInfo(DjvuImage image, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.imaging.fileformats.djvu.DjvuImage |  |
| format | FileType |  |
| size | long |  |

##### getVerticalResolution()
```
public double getVerticalResolution()
```

Gets vertical resolution

**Returns:**
double - vertical resolution

##### getHorizontalResolution()
```
public double getHorizontalResolution()
```

Get horizontal resolution

**Returns:**
double - horizontal resolution

##### getOpacity()
```
public float getOpacity()
```

Gets image opacity

**Returns:**
float - image opacity

### DocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.documentinfo.IDocumentInfo
```
public abstract class DocumentInfo implements IDocumentInfo
```

Provides base implementation for retrieving polymorphic document information

#### Methods

| Method | Description |
| --- | --- |
| getPropertyNames() | {@inheritDoc}
 |
| getProperty(String propertyName) | {@inheritDoc}
 |
| getPagesCount() | {@inheritDoc}
 |
| getFormat() | {@inheritDoc}
 |
| getSize() | {@inheritDoc}
 |
| getCreationDate() | {@inheritDoc}
 |
##### getPropertyNames()
```
public List<String> getPropertyNames()
```

List of all properties which could be get for the current document info

**Returns:**
java.util.List<java.lang.String>
##### getProperty(String propertyName)
```
public String getProperty(String propertyName)
```

Get value for a property provided as a key

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String |  |

**Returns:**
java.lang.String
##### getPagesCount()
```
public int getPagesCount()
```

Document pages count.

**Returns:**
int
##### getFormat()
```
public String getFormat()
```

Document format

**Returns:**
java.lang.String
##### getSize()
```
public long getSize()
```

Document size in bytes

**Returns:**
long
##### getCreationDate()
```
public Date getCreationDate()
```

Document creation date

**Returns:**
java.util.Date

### EmailDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/emaildocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class EmailDocumentInfo extends DocumentInfo
```

Contains Email document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailDocumentInfo(MailMessage mail, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| isSigned() | Gets is signed
 |
| isEncrypted() | Gets is encrypted
 |
| isHtml() | Gets is html
 |
| getAttachmentsCount() | Gets attachments count
 |
| getAttachmentsNames() | Gets attachments names
 |
##### EmailDocumentInfo(MailMessage mail, FileType format, long size)
```
public EmailDocumentInfo(MailMessage mail, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mail | com.aspose.email.MailMessage |  |
| format | FileType |  |
| size | long |  |

##### isSigned()
```
public boolean isSigned()
```

Gets is signed

**Returns:**
boolean - true if is signed

##### isEncrypted()
```
public boolean isEncrypted()
```

Gets is encrypted

**Returns:**
boolean - true if is encrypted

##### isHtml()
```
public boolean isHtml()
```

Gets is html

**Returns:**
boolean - true if is html

##### getAttachmentsCount()
```
public int getAttachmentsCount()
```

Gets attachments count

**Returns:**
int - attachments count

##### getAttachmentsNames()
```
public List<String> getAttachmentsNames()
```

Gets attachments names

**Returns:**
java.util.List<java.lang.String> - attachments names

### EpsDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/epsdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.ImageDocumentInfo
```
public class EpsDocumentInfo extends ImageDocumentInfo
```

Contains Ps document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| EpsDocumentInfo(Image ps, FileType format, long size) |  |
##### EpsDocumentInfo(Image ps, FileType format, long size)
```
public EpsDocumentInfo(Image ps, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ps | com.aspose.imaging.Image |  |
| format | FileType |  |
| size | long |  |

### EpubDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/epubdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class EpubDocumentInfo extends PdfDocumentInfo
```

Contains Epub document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| EpubDocumentInfo(Document epub, FileType format, long size) |  |
##### EpubDocumentInfo(Document epub, FileType format, long size)
```
public EpubDocumentInfo(Document epub, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| epub | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### FontDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/fontdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class FontDocumentInfo extends DocumentInfo
```

Contains Font document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| FontDocumentInfo(FileType format, long size) |  |
##### FontDocumentInfo(FileType format, long size)
```
public FontDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### IcoDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/icodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.ImageDocumentInfo
```
public class IcoDocumentInfo extends ImageDocumentInfo
```

Contains Ico document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| IcoDocumentInfo(Image ico, FileType format, long size) |  |
##### IcoDocumentInfo(Image ico, FileType format, long size)
```
public IcoDocumentInfo(Image ico, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ico | com.aspose.imaging.Image |  |
| format | FileType |  |
| size | long |  |

### IDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/idocumentinfo.md

### ImageDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/imagedocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class ImageDocumentInfo extends DocumentInfo
```

Contains Image document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageDocumentInfo(Image image, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets bits per pixel
 |
| getHeight() | Gets height
 |
| getWidth() | Gets width
 |
##### ImageDocumentInfo(Image image, FileType format, long size)
```
public ImageDocumentInfo(Image image, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.imaging.Image |  |
| format | FileType |  |
| size | long |  |

##### getBitsPerPixel()
```
public int getBitsPerPixel()
```

Gets bits per pixel

**Returns:**
int - bits per pixel

##### getHeight()
```
public int getHeight()
```

Gets height

**Returns:**
int - height

##### getWidth()
```
public int getWidth()
```

Gets width

**Returns:**
int - width

### JsonDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/jsondocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class JsonDocumentInfo extends DocumentInfo
```

Contains Json document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| JsonDocumentInfo(FileType format, long size) |  |
##### JsonDocumentInfo(FileType format, long size)
```
public JsonDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### MarkdownDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/markdowndocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.WordProcessingDocumentInfo
```
public class MarkdownDocumentInfo extends WordProcessingDocumentInfo
```

Contains Md document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| MarkdownDocumentInfo(Document txt, FileType format, long size) |  |
##### MarkdownDocumentInfo(Document txt, FileType format, long size)
```
public MarkdownDocumentInfo(Document txt, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| txt | com.aspose.words.Document |  |
| format | FileType |  |
| size | long |  |

### NoteDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/notedocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class NoteDocumentInfo extends DocumentInfo
```

Contains Note document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| NoteDocumentInfo(Document note, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets title
 |
##### NoteDocumentInfo(Document note, FileType format, long size)
```
public NoteDocumentInfo(Document note, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| note | com.aspose.note.Document |  |
| format | FileType |  |
| size | long |  |

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title

### PasswordProtectedDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/passwordprotecteddocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PasswordProtectedDocumentInfo extends DocumentInfo
```

Provided document is password protected

#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordProtectedDocumentInfo(FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| isPasswordProtected() | Gets is document password protected
 |
##### PasswordProtectedDocumentInfo(FileType format, long size)
```
public PasswordProtectedDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is document password protected

**Returns:**
boolean

### PclDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/pcldocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PclDocumentInfo extends DocumentInfo
```

Contains Pcl document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PclDocumentInfo(Document pcl, FileType format, long size) |  |
##### PclDocumentInfo(Document pcl, FileType format, long size)
```
public PclDocumentInfo(Document pcl, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pcl | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### PdfDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/pdfdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PdfDocumentInfo extends DocumentInfo
```

Contains Pdf document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDocumentInfo(Document pdf, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets version
 |
| getTitle() | Gets title
 |
| getAuthor() | Gets author
 |
| isPasswordProtected() | Gets is encrypted
 |
| isLandscape() | Gets is page landscaped
 |
| getHeight() | Gets page height
 |
| getWidth() | Gets page width
 |
| getTableOfContents() | Gets Table of contents
 |
| setTableOfContents(List<TableOfContentsItem> tableOfContents) | Sets Table of contents
 |
##### PdfDocumentInfo(Document pdf, FileType format, long size)
```
public PdfDocumentInfo(Document pdf, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdf | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

##### getVersion()
```
public String getVersion()
```

Gets version

**Returns:**
java.lang.String - version

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title

##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is encrypted

**Returns:**
boolean - true if encrypted

##### isLandscape()
```
public boolean isLandscape()
```

Gets is page landscaped

**Returns:**
boolean - true if page is landscaped

##### getHeight()
```
public double getHeight()
```

Gets page height

**Returns:**
double - page height

##### getWidth()
```
public double getWidth()
```

Gets page width

**Returns:**
double - page width

##### getTableOfContents()
```
public List<TableOfContentsItem> getTableOfContents()
```

Gets Table of contents

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.TableOfContentsItem> - Table of contents

##### setTableOfContents(List<TableOfContentsItem> tableOfContents)
```
public void setTableOfContents(List<TableOfContentsItem> tableOfContents)
```

Sets Table of contents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tableOfContents | java.util.List<com.groupdocs.conversion.contracts.documentinfo.TableOfContentsItem> | Table of contents
 |

### PersonalStorageDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/personalstoragedocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PersonalStorageDocumentInfo extends DocumentInfo
```

Contains personal storage document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| isPasswordProtected() | Is storage password protected
 |
| getRootFolderName() | Root folder name
 |
| getContentCount() | Get count of contents in the root folder
 |
| getFolders() | Folders in the storage
 |
##### PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size)
```
public PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storage | com.aspose.email.PersonalStorage |  |
| format | FileType |  |
| size | long |  |

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Is storage password protected

**Returns:**
boolean
##### getRootFolderName()
```
public String getRootFolderName()
```

Root folder name

**Returns:**
java.lang.String - Root folder name

##### getContentCount()
```
public int getContentCount()
```

Get count of contents in the root folder

**Returns:**
int - count of contents in the root folder

##### getFolders()
```
public List<PersonalStorageFolderInfo> getFolders()
```

Folders in the storage

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageFolderInfo> - Folders in the storage

### PersonalStorageFolderInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/personalstoragefolderinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class PersonalStorageFolderInfo extends ValueObject
```

Personal Storage Folder info

#### Constructors

| Constructor | Description |
| --- | --- |
| PersonalStorageFolderInfo(String name, List<PersonalStorageItemInfo> items) |  |
#### Fields

| Field | Description |
| --- | --- |
| items |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Name of the folder
 |
| getItemsCount() | Count of the items in the folder
 |
| getSubFolders() |  |
| getItems() |  |
| toString() | String representation of personal storage folder info
 |
##### PersonalStorageFolderInfo(String name, List<PersonalStorageItemInfo> items)
```
public PersonalStorageFolderInfo(String name, List<PersonalStorageItemInfo> items)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |
| items | java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageItemInfo> |  |

##### items
```
public List<PersonalStorageItemInfo> items
```

##### getName()
```
public String getName()
```

Name of the folder

**Returns:**
java.lang.String
##### getItemsCount()
```
public int getItemsCount()
```

Count of the items in the folder

**Returns:**
int
##### getSubFolders()
```
public List<PersonalStorageFolderInfo> getSubFolders()
```

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageFolderInfo>
##### getItems()
```
public List<PersonalStorageItemInfo> getItems()
```

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageItemInfo>
##### toString()
```
public String toString()
```

String representation of personal storage folder info

**Returns:**
java.lang.String - String representation of personal storage folder info in format FolderName (ItemsCount)

### PresentationDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/presentationdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PresentationDocumentInfo extends DocumentInfo
```

Contains Presentation document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationDocumentInfo(Presentation presentation, FileType format, long size, boolean isPasswordProtected) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets title
 |
| setTitle(String title) | Sets title
 |
| getAuthor() | Gets author
 |
| setAuthor(String author) | Sets author
 |
| isPasswordProtected() | Gets is the document password protected
 |
##### PresentationDocumentInfo(Presentation presentation, FileType format, long size, boolean isPasswordProtected)
```
public PresentationDocumentInfo(Presentation presentation, FileType format, long size, boolean isPasswordProtected)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| presentation | com.aspose.slides.Presentation |  |
| format | FileType |  |
| size | long |  |
| isPasswordProtected | boolean |  |

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title

##### setTitle(String title)
```
public void setTitle(String title)
```

Sets title

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | title
 |

##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author

##### setAuthor(String author)
```
public void setAuthor(String author)
```

Sets author

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| author | java.lang.String | author
 |

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is the document password protected

**Returns:**
boolean - `true` if document is password protected

### ProjectManagementDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/projectmanagementdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class ProjectManagementDocumentInfo extends DocumentInfo
```

Contains ProjectManagement document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementDocumentInfo(Project project, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTasksCount() | Gets task count
 |
| getStartDate() | Gets Project start date
 |
| getEndDate() | Gets Project end date
 |
##### ProjectManagementDocumentInfo(Project project, FileType format, long size)
```
public ProjectManagementDocumentInfo(Project project, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| project | com.aspose.tasks.Project |  |
| format | FileType |  |
| size | long |  |

##### getTasksCount()
```
public int getTasksCount()
```

Gets task count

**Returns:**
int - task count

##### getStartDate()
```
public Date getStartDate()
```

Gets Project start date

**Returns:**
java.util.Date - Project start date

##### getEndDate()
```
public Date getEndDate()
```

Gets Project end date

**Returns:**
java.util.Date - Project end date

### PsdDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/psddocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PsdDocumentInfo extends DocumentInfo
```

Contains Psd document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PsdDocumentInfo(Image image, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets bits per pixel
 |
| getHeight() | Gets height
 |
| getWidth() | Gets width
 |
##### PsdDocumentInfo(Image image, FileType format, long size)
```
public PsdDocumentInfo(Image image, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.psd.Image |  |
| format | FileType |  |
| size | long |  |

##### getBitsPerPixel()
```
public int getBitsPerPixel()
```

Gets bits per pixel

**Returns:**
int - bits per pixel

##### getHeight()
```
public int getHeight()
```

Gets height

**Returns:**
int - height

##### getWidth()
```
public int getWidth()
```

Gets width

**Returns:**
int - width

### PsDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/psdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PsDocumentInfo extends DocumentInfo
```

Contains Ps document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PsDocumentInfo(Document ps, FileType format, long size) |  |
##### PsDocumentInfo(Document ps, FileType format, long size)
```
public PsDocumentInfo(Document ps, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ps | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### PublisherDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/publisherdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PublisherDocumentInfo extends DocumentInfo
```

Contains Publisher document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| PublisherDocumentInfo(FileType format, long size) |  |
##### PublisherDocumentInfo(FileType format, long size)
```
public PublisherDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### SpreadsheetDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/spreadsheetdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class SpreadsheetDocumentInfo extends DocumentInfo
```

Contains Spreadsheet document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetDocumentInfo(Workbook spreadsheet, boolean isPasswordProtected, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets title
 |
| getWorksheetsCount() | Gets worksheets count
 |
| getAuthor() | Gets author
 |
| isPasswordProtected() | Gets is document password protected
 |
| getWorksheets() | Worksheets names
 |
| setWorksheets(List<String> worksheets) |  |
##### SpreadsheetDocumentInfo(Workbook spreadsheet, boolean isPasswordProtected, FileType format, long size)
```
public SpreadsheetDocumentInfo(Workbook spreadsheet, boolean isPasswordProtected, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| spreadsheet | com.aspose.cells.Workbook |  |
| isPasswordProtected | boolean |  |
| format | FileType |  |
| size | long |  |

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title

##### getWorksheetsCount()
```
public int getWorksheetsCount()
```

Gets worksheets count

**Returns:**
int - worksheets count

##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is document password protected

**Returns:**
boolean - true if document is password protected

##### getWorksheets()
```
public List<String> getWorksheets()
```

Worksheets names

**Returns:**
java.util.List<java.lang.String>
##### setWorksheets(List<String> worksheets)
```
public void setWorksheets(List<String> worksheets)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheets | java.util.List<java.lang.String> |  |

### SvgDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/svgdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class SvgDocumentInfo extends DocumentInfo
```

Contains Svg document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| SvgDocumentInfo(FileType format, long size) |  |
##### SvgDocumentInfo(FileType format, long size)
```
public SvgDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### TableOfContentsItem
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/tableofcontentsitem.md

**Inheritance:**
java.lang.Object
```
public class TableOfContentsItem
```

Contains Table of contents item metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| TableOfContentsItem(String title, int page) | Default constructor
 |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Bookmark title
 |
| getPage() | Bookmark page
 |
##### TableOfContentsItem(String title, int page)
```
public TableOfContentsItem(String title, int page)
```

Default constructor

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | title
 |
| page | int | page
 |

##### getTitle()
```
public String getTitle()
```

Bookmark title

**Returns:**
java.lang.String - Bookmark title

##### getPage()
```
public int getPage()
```

Bookmark page

**Returns:**
int - Bookmark page

### TexDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/texdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class TexDocumentInfo extends DocumentInfo
```

Contains Tex document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| TexDocumentInfo(Document tex, FileType format, long size) |  |
##### TexDocumentInfo(Document tex, FileType format, long size)
```
public TexDocumentInfo(Document tex, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tex | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### TsvDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/tsvdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.SpreadsheetDocumentInfo
```
public class TsvDocumentInfo extends SpreadsheetDocumentInfo
```

Contains Tsv document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| TsvDocumentInfo(Workbook tsv, FileType format, long size) |  |
##### TsvDocumentInfo(Workbook tsv, FileType format, long size)
```
public TsvDocumentInfo(Workbook tsv, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tsv | com.aspose.cells.Workbook |  |
| format | FileType |  |
| size | long |  |

### TxtDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/txtdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.WordProcessingDocumentInfo
```
public class TxtDocumentInfo extends WordProcessingDocumentInfo
```

Contains Txt document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| TxtDocumentInfo(Document txt, FileType format, long size) |  |
##### TxtDocumentInfo(Document txt, FileType format, long size)
```
public TxtDocumentInfo(Document txt, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| txt | com.aspose.words.Document |  |
| format | FileType |  |
| size | long |  |

### VcfDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/vcfdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class VcfDocumentInfo extends DocumentInfo
```

Contains Vcf document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| VcfDocumentInfo(List<VCardContact> vcf, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getContactsCount() |  |
##### VcfDocumentInfo(List<VCardContact> vcf, FileType format, long size)
```
public VcfDocumentInfo(List<VCardContact> vcf, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| vcf | java.util.List<com.aspose.email.VCardContact> |  |
| format | FileType |  |
| size | long |  |

##### getContactsCount()
```
public int getContactsCount()
```

**Returns:**
int

### VideoDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/videodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class VideoDocumentInfo extends DocumentInfo
```

Contains Video document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| VideoDocumentInfo(FileType format, long size) |  |
##### VideoDocumentInfo(FileType format, long size)
```
public VideoDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### WebDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/webdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class WebDocumentInfo extends DocumentInfo
```

Contains Web document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| WebDocumentInfo(System.IO.Stream document, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() |  |
##### WebDocumentInfo(System.IO.Stream document, FileType format, long size)
```
public WebDocumentInfo(System.IO.Stream document, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | com.aspose.ms.System.IO.Stream |  |
| format | FileType |  |
| size | long |  |

##### getEncoding()
```
public System.Text.Encoding getEncoding()
```

**Returns:**
com.aspose.ms.System.Text.Encoding

### WordProcessingDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/wordprocessingdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class WordProcessingDocumentInfo extends DocumentInfo
```

Contains Wordprocessing document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingDocumentInfo(Document wordprocessing, boolean isPasswordProtected, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWords() | Gets words count
 |
| getLines() | Gets lines count
 |
| getTitle() | Gets title
 |
| getAuthor() | Gets author
 |
| isPasswordProtected() | Gets is document password protected
 |
| getTableOfContents() | Table of contents
 |
##### WordProcessingDocumentInfo(Document wordprocessing, boolean isPasswordProtected, FileType format, long size)
```
public WordProcessingDocumentInfo(Document wordprocessing, boolean isPasswordProtected, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordprocessing | com.aspose.words.Document |  |
| isPasswordProtected | boolean |  |
| format | FileType |  |
| size | long |  |

##### getWords()
```
public int getWords()
```

Gets words count

**Returns:**
int - words count

##### getLines()
```
public int getLines()
```

Gets lines count

**Returns:**
int - lines count

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title

##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is document password protected

**Returns:**
boolean - `true` if document is password protected

##### getTableOfContents()
```
public List<TableOfContentsItem> getTableOfContents()
```

Table of contents

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.TableOfContentsItem> - Table of contents

### XmlDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/xmldocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class XmlDocumentInfo extends DocumentInfo
```

Contains Xml document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| XmlDocumentInfo(FileType format, long size) |  |
##### XmlDocumentInfo(FileType format, long size)
```
public XmlDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### XpsDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/xpsdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class XpsDocumentInfo extends PdfDocumentInfo
```

Contains Xps document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| XpsDocumentInfo(Document xps, FileType format, long size) |  |
##### XpsDocumentInfo(Document xps, FileType format, long size)
```
public XpsDocumentInfo(Document xps, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xps | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### XslFoDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.documentinfo/xslfodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class XslFoDocumentInfo extends PdfDocumentInfo
```

Contains XslFo document metadata

#### Constructors

| Constructor | Description |
| --- | --- |
| XslFoDocumentInfo(Document xslfo, FileType format, long size) |  |
##### XslFoDocumentInfo(Document xslfo, FileType format, long size)
```
public XslFoDocumentInfo(Document xslfo, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xslfo | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### com.groupdocs.conversion.contracts
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts.md

The GroupDocs.Conversion.Contracts namespace provides members to instantiate and release output document, manage font substitutions etc.

#### Classes

| Class | Description |
| --- | --- |
| ConversionPair | Represents conversion pair |
| Enumeration | Generic enumeration class. |
| FontSubstitute | Describes substitution for missing font. |
| PossibleConversions | Represents a mapping what conversion pairs are supported for specific source file format |
| TargetConversion | Represents possible target conversion and a flag is it a primary or secondary |
| ValueObject | Abstract value object class. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ConvertOptionsProvider | Describes delegate to provide convert options for specific source document. |
| ConvertedDocumentStream | Describes delegate to receive converted document stream. |
| ConvertedPageStream | Describes delegate to receive converted page stream. |
| ConverterSettingsProvider | Supplier for ConverterSettings |
| DocumentStreamProvider | Supplier for InputStream |
| DocumentStreamsProvider | Supplier for InputStream array |
| IDocument | Interface for documents |
| SaveDocumentStream | Describes delegate for saving converted document into output stream. |
| SaveDocumentStreamForFileType | Describes delegate for saving converted document into stream. |
| SavePageStream | Describes delegate for saving converted document page into stream. |
| SavePageStreamForFileType | Describes delegate for saving converted document page into stream. |

### ConversionPair
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/conversionpair.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class ConversionPair extends ValueObject
```

Represents conversion pair

#### Fields

| Field | Description |
| --- | --- |
| NULL |  |
#### Methods

| Method | Description |
| --- | --- |
| createPrimary(FileType source, FileType target) | Creates primary conversion pair
 |
| createPrimary(List<? extends FileType> sources, List<? extends FileType> targets) | Creates primary conversion pairs
 |
| createPrimary(List<? extends FileType> sources, List<? extends FileType> targets, Pair<FileType,FileType>[] excludedPairs) |  |
| createSecondary(FileType source, FileType target) | Creates secondary conversion pair
 |
| createSecondary(Iterable<? extends FileType> sources, Iterable<? extends FileType> targets) | Creates secondary conversion pairs
 |
| getEqualityComponents() | Equality components
 |
| toString() | Conversion pair string representation
 |
| getSource() | Source file format
 |
| getTarget() | Target file format
 |
| isPrimary() | Primary conversion pair or not
 |
##### NULL
```
public static final ConversionPair NULL
```

##### createPrimary(FileType source, FileType target)
```
public static ConversionPair createPrimary(FileType source, FileType target)
```

Creates primary conversion pair

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | source
 |
| target | FileType | target
 |

**Returns:**
ConversionPair - ConversionPair

##### createPrimary(List<? extends FileType> sources, List<? extends FileType> targets)
```
public static List<ConversionPair> createPrimary(List<? extends FileType> sources, List<? extends FileType> targets)
```

Creates primary conversion pairs

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sources | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> | sources file type
 |
| targets | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> | targets file type
 |

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.ConversionPair> - primary conversion pairs

##### createPrimary(List<? extends FileType> sources, List<? extends FileType> targets, Pair<FileType,FileType>[] excludedPairs)
```
public static List<ConversionPair> createPrimary(List<? extends FileType> sources, List<? extends FileType> targets, Pair<FileType,FileType>[] excludedPairs)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sources | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> |  |
| targets | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> |  |
| excludedPairs | com.groupdocs.conversion.contracts.Pair<com.groupdocs.conversion.filetypes.FileType,com.groupdocs.conversion.filetypes.FileType>[] |  |

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.ConversionPair>
##### createSecondary(FileType source, FileType target)
```
public static ConversionPair createSecondary(FileType source, FileType target)
```

Creates secondary conversion pair

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | source file type
 |
| target | FileType | target file type
 |

**Returns:**
ConversionPair - secondary conversion pair

##### createSecondary(Iterable<? extends FileType> sources, Iterable<? extends FileType> targets)
```
public static List<ConversionPair> createSecondary(Iterable<? extends FileType> sources, Iterable<? extends FileType> targets)
```

Creates secondary conversion pairs

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sources | java.lang.Iterable<? extends com.groupdocs.conversion.filetypes.FileType> | sources file type
 |
| targets | java.lang.Iterable<? extends com.groupdocs.conversion.filetypes.FileType> | targets file type
 |

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.ConversionPair> - secondary conversion pairs

##### getEqualityComponents()
```
public System.Collections.Generic.IGenericEnumerable getEqualityComponents()
```

Equality components

**Returns:**
com.aspose.ms.System.Collections.Generic.IGenericEnumerable - equality components

##### toString()
```
public String toString()
```

Conversion pair string representation

**Returns:**
java.lang.String - string

##### getSource()
```
public FileType getSource()
```

Source file format

**Returns:**
FileType - source file format

##### getTarget()
```
public FileType getTarget()
```

Target file format

**Returns:**
FileType - target file format

##### isPrimary()
```
public boolean isPrimary()
```

Primary conversion pair or not

**Returns:**
boolean - true if primary, else if not

### ConvertedDocumentStream
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/converteddocumentstream.md

### ConvertedPageStream
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/convertedpagestream.md

### ConverterSettingsProvider
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/convertersettingsprovider.md

**All Implemented Interfaces:**
java.util.function.Supplier
```
public interface ConverterSettingsProvider extends Supplier<ConverterSettings>
```

Supplier for ConverterSettings

### ConvertOptionsProvider
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/convertoptionsprovider.md

### DocumentStreamProvider
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/documentstreamprovider.md

**All Implemented Interfaces:**
java.util.function.Supplier
```
public interface DocumentStreamProvider extends Supplier<InputStream>
```

Supplier for InputStream

### DocumentStreamsProvider
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/documentstreamsprovider.md

**All Implemented Interfaces:**
java.util.function.Supplier
```
public interface DocumentStreamsProvider extends Supplier<InputStream[]>
```

Supplier for InputStream array

### Enumeration
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/enumeration.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Comparable, java.io.Serializable, com.aspose.ms.System.IEquatable
```
public abstract class Enumeration implements Comparable, Serializable, System.IEquatable<Enumeration>
```

Generic enumeration class.

TKey
:

#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a string that represents the current object.
 |
| <T>getAll(Class<T> typeOfT) | Returns all enumeration values.
 |
| equals(Object obj) | Determines whether two object instances are equal.
 |
| equals(Enumeration other) | Determines whether two object instances are equal.
 |
| hashCode() | Serves as the default hash function.
 |
| <T>fromValue(Class<T> typeOfT, String value) | Returns object by key.
 |
| <T>fromDisplayName(Class<T> typeOfT, String displayName) | Returns object by display name.
 |
| compareTo(Object obj) | Compares current object to other.
 |
| op_Equality(Enumeration left, Enumeration right) | Equality operator.
 |
| op_Inequality(Enumeration left, Enumeration right) | Inequality operator.
 |
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - String representation

##### <T>getAll(Class<T> typeOfT)
```
public static List <T>getAll(Class<T> typeOfT)
```

Returns all enumeration values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
java.util.List - Enumerable of the provided type

T
: Enumerated object type.

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object.
 |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .

##### equals(Enumeration other)
```
public boolean equals(Enumeration other)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Enumeration | The object to compare with the current object.
 |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .

##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current object.

##### <T>fromValue(Class<T> typeOfT, String value)
```
public static T <T>fromValue(Class<T> typeOfT, String value)
```

Returns object by key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| value | java.lang.String | The value
 |

**Returns:**
T - The object

##### <T>fromDisplayName(Class<T> typeOfT, String displayName)
```
public static T <T>fromDisplayName(Class<T> typeOfT, String displayName)
```

Returns object by display name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| displayName | java.lang.String | The display name
 |

**Returns:**
T - The object

##### compareTo(Object obj)
```
public final int compareTo(Object obj)
```

Compares current object to other.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The other object
 |

**Returns:**
int - zero if equal

##### op_Equality(Enumeration left, Enumeration right)
```
public static boolean op_Equality(Enumeration left, Enumeration right)
```

Equality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Enumeration | The first object
 |
| right | Enumeration | The second object
 |

**Returns:**
boolean -  true  if objects are equal

##### op_Inequality(Enumeration left, Enumeration right)
```
public static boolean op_Inequality(Enumeration left, Enumeration right)
```

Inequality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Enumeration | The first object
 |
| right | Enumeration | The second object
 |

**Returns:**
boolean -  true  if objects are not equal

### FontSubstitute
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/fontsubstitute.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public class FontSubstitute extends ValueObject implements Serializable
```

Describes substitution for missing font.

#### Methods

| Method | Description |
| --- | --- |
| create(String originalFont, String substituteWith) | Instantiate new font substitution pair.
 |
| getOriginalFontName() | The original font name.
 |
| getSubstituteFontName() | The substitute font name.
 |
##### create(String originalFont, String substituteWith)
```
public static FontSubstitute create(String originalFont, String substituteWith)
```

Instantiate new font substitution pair.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originalFont | java.lang.String | Font from the source document.
 |
| substituteWith | java.lang.String | Font which will be used to replace originalFont.
 |

**Returns:**
FontSubstitute - substitution pair

##### getOriginalFontName()
```
public String getOriginalFontName()
```

The original font name.

**Returns:**
java.lang.String - the original font name.

##### getSubstituteFontName()
```
public String getSubstituteFontName()
```

The substitute font name.

**Returns:**
java.lang.String - the substitute font name.

### IDocument
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/idocument.md

**All Implemented Interfaces:**
com.aspose.ms.System.IDisposable, com.groupdocs.conversion.contracts.IDocumentSave
```
public interface IDocument extends System.IDisposable, IDocumentSave
```

Interface for documents

#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getContentStream() |  |
| getLoadOptions() |  |
| getInfo() |  |
| getSize() |  |
| getPagesCount() |  |
| ensureLoaded() |  |
##### getFormat()
```
public abstract FileType getFormat()
```

**Returns:**
FileType
##### getContentStream()
```
public abstract System.IO.MemoryStream getContentStream()
```

**Returns:**
com.aspose.ms.System.IO.MemoryStream
##### getLoadOptions()
```
public abstract LoadOptions getLoadOptions()
```

**Returns:**
LoadOptions
##### getInfo()
```
public abstract IDocumentInfo getInfo()
```

**Returns:**
IDocumentInfo
##### getSize()
```
public abstract long getSize()
```

**Returns:**
long
##### getPagesCount()
```
public abstract int getPagesCount()
```

**Returns:**
int
##### ensureLoaded()
```
public abstract void ensureLoaded()
```

### PossibleConversions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/possibleconversions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public final class PossibleConversions extends ValueObject
```

Represents a mapping what conversion pairs are supported for specific source file format

#### Constructors

| Constructor | Description |
| --- | --- |
| PossibleConversions(FileType source) | Creates possible conversion list for specified source file format
 |
#### Fields

| Field | Description |
| --- | --- |
| NULL |  |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() | Predefined load options which could be used to convert from current type
 |
| getAll() | All target file types and primary/secondary flag
 |
| getTargetConversion(FileType target) | Returns target conversion for specified target file type
 |
| getTargetConversion(String extension) |  |
| getPrimary() | Primary target file types
 |
| getSecondary() | Secondary target file types
 |
| add(ConversionPair pair) | Add conversion pair
 |
| forTarget(FileType target) | Find conversion pair in current list for target file type
 |
| getSource() | Source file formats
 |
##### PossibleConversions(FileType source)
```
public PossibleConversions(FileType source)
```

Creates possible conversion list for specified source file format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | source file type
 |

##### NULL
```
public static final PossibleConversions NULL
```

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Predefined load options which could be used to convert from current type

**Returns:**
LoadOptions - load options

##### getAll()
```
public Iterable<TargetConversion> getAll()
```

All target file types and primary/secondary flag

**Returns:**
java.lang.Iterable<com.groupdocs.conversion.contracts.TargetConversion> - Iterable of TargetConversion

##### getTargetConversion(FileType target)
```
public TargetConversion getTargetConversion(FileType target)
```

Returns target conversion for specified target file type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| target | FileType | target file type
 |

**Returns:**
TargetConversion - conversions

##### getTargetConversion(String extension)
```
public TargetConversion getTargetConversion(String extension)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String |  |

**Returns:**
TargetConversion
##### getPrimary()
```
public Iterable<FileType> getPrimary()
```

Primary target file types

**Returns:**
java.lang.Iterable<com.groupdocs.conversion.filetypes.FileType> - primary target file types

##### getSecondary()
```
public Iterable<FileType> getSecondary()
```

Secondary target file types

**Returns:**
java.lang.Iterable<com.groupdocs.conversion.filetypes.FileType> - secondary target file types

##### add(ConversionPair pair)
```
public void add(ConversionPair pair)
```

Add conversion pair

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pair | ConversionPair | conversion pair
 |

##### forTarget(FileType target)
```
public ConversionPair forTarget(FileType target)
```

Find conversion pair in current list for target file type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| target | FileType | target file type
 |

**Returns:**
ConversionPair - conversion pair

##### getSource()
```
public FileType getSource()
```

Source file formats

**Returns:**
FileType - file formats

### SaveDocumentStream
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/savedocumentstream.md

### SaveDocumentStreamForFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/savedocumentstreamforfiletype.md

### SavePageStream
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/savepagestream.md

### SavePageStreamForFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/savepagestreamforfiletype.md

### TargetConversion
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/targetconversion.md

**Inheritance:**
java.lang.Object
```
public final class TargetConversion
```

Represents possible target conversion and a flag is it a primary or secondary

#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Target document format
 |
| isPrimary() | Is the conversion primary
 |
| getConvertOptions() | Predefined convert options which could be used to convert to current type
 |
##### getFormat()
```
public FileType getFormat()
```

Target document format

**Returns:**
FileType - Target document format

##### isPrimary()
```
public boolean isPrimary()
```

Is the conversion primary

**Returns:**
boolean - `true` if primary

##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Predefined convert options which could be used to convert to current type

**Returns:**
ConvertOptions - convert options

### ValueObject
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.contracts/valueobject.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable, java.io.Serializable
```
public abstract class ValueObject implements System.IEquatable<ValueObject>, Serializable
```

Abstract value object class.

#### Constructors

| Constructor | Description |
| --- | --- |
| ValueObject() |  |
#### Methods

| Method | Description |
| --- | --- |
| equals(Object obj) | Determines whether two object instances are equal.
 |
| equals(ValueObject other) | Determines whether two object instances are equal.
 |
| hashCode() | Serves as the default hash function.
 |
| op_Equality(ValueObject a, ValueObject b) | Equality operator.
 |
| op_Inequality(ValueObject a, ValueObject b) | Inequality operator.
 |
##### ValueObject()
```
public ValueObject()
```

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object.
 |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .

##### equals(ValueObject other)
```
public final boolean equals(ValueObject other)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ValueObject | The object to compare with the current object.
 |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .

##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current object.

##### op_Equality(ValueObject a, ValueObject b)
```
public static boolean op_Equality(ValueObject a, ValueObject b)
```

Equality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | ValueObject | The first object
 |
| b | ValueObject | The second object
 |

**Returns:**
boolean -  true  if objects are equal

##### op_Inequality(ValueObject a, ValueObject b)
```
public static boolean op_Inequality(ValueObject a, ValueObject b)
```

Inequality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | ValueObject | The first object
 |
| b | ValueObject | The second object
 |

**Returns:**
boolean -  true  if objects are not equal

### com.groupdocs.conversion.exceptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions.md

The GroupDocs.Conversion.Exceptions namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| ConversionNotSupportedException | GroupDocs exception thrown when the conversion from source file to target file type is not supported |
| CorruptOrDamagedFileException | GroupDocs exception thrown when the file is corrupt or damaged |
| FileTypeNotSupportedException | GroupDocs exception thrown when the file type is not supported |
| FontSubstituteException | Thrown if font substitute is illegal |
| GroupDocsConversionException | GroupDocs.Conversion general exception |
| IncorrectPasswordException | GroupDocs exception thrown when the file is password protected, password is provided but is incorrect |
| InvalidConvertOptionsException | Thrown if provided convert options are invalid |
| InvalidConverterSettingsException | Thrown if provided converter settings are invalid |
| PasswordRequiredException | GroupDocs exception thrown when the file is password protected and password is not provided |

### ConversionNotSupportedException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/conversionnotsupportedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class ConversionNotSupportedException extends GroupDocsConversionException
```

GroupDocs exception thrown when the conversion from source file to target file type is not supported

#### Constructors

| Constructor | Description |
| --- | --- |
| ConversionNotSupportedException() | Default constructor
 |
| ConversionNotSupportedException(FileType source, FileType target) | Creates an exception instance with a source FileType and a target Filetype
 |
| ConversionNotSupportedException(String message) | Creates an exception instance with a message
 |
##### ConversionNotSupportedException()
```
public ConversionNotSupportedException()
```

Default constructor

##### ConversionNotSupportedException(FileType source, FileType target)
```
public ConversionNotSupportedException(FileType source, FileType target)
```

Creates an exception instance with a source FileType and a target Filetype

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | The source file type
 |
| target | FileType | The target file type
 |

##### ConversionNotSupportedException(String message)
```
public ConversionNotSupportedException(String message)
```

Creates an exception instance with a message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### CorruptOrDamagedFileException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/corruptordamagedfileexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class CorruptOrDamagedFileException extends GroupDocsConversionException
```

GroupDocs exception thrown when the file is corrupt or damaged

#### Constructors

| Constructor | Description |
| --- | --- |
| CorruptOrDamagedFileException() | Default constructor
 |
| CorruptOrDamagedFileException(FileType fileType) | Creates an exception instance with a FileType
 |
| CorruptOrDamagedFileException(String message) | Creates an exception instance with a message
 |
| CorruptOrDamagedFileException(String message, RuntimeException exception) | Creates an exception instance with a message and propagates the inner exception
 |
##### CorruptOrDamagedFileException()
```
public CorruptOrDamagedFileException()
```

Default constructor

##### CorruptOrDamagedFileException(FileType fileType)
```
public CorruptOrDamagedFileException(FileType fileType)
```

Creates an exception instance with a FileType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type
 |

##### CorruptOrDamagedFileException(String message)
```
public CorruptOrDamagedFileException(String message)
```

Creates an exception instance with a message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

##### CorruptOrDamagedFileException(String message, RuntimeException exception)
```
public CorruptOrDamagedFileException(String message, RuntimeException exception)
```

Creates an exception instance with a message and propagates the inner exception

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |
| exception | java.lang.RuntimeException | The inner exception
 |

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/filetypenotsupportedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class FileTypeNotSupportedException extends GroupDocsConversionException
```

GroupDocs exception thrown when the file type is not supported

#### Constructors

| Constructor | Description |
| --- | --- |
| FileTypeNotSupportedException() | Default constructor
 |
| FileTypeNotSupportedException(FileType fileType) | Creates an exception instance with a FileType
 |
| FileTypeNotSupportedException(String message) | Creates an exception instance with a message
 |
##### FileTypeNotSupportedException()
```
public FileTypeNotSupportedException()
```

Default constructor

##### FileTypeNotSupportedException(FileType fileType)
```
public FileTypeNotSupportedException(FileType fileType)
```

Creates an exception instance with a FileType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type
 |

##### FileTypeNotSupportedException(String message)
```
public FileTypeNotSupportedException(String message)
```

Creates an exception instance with a message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### FontSubstituteException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/fontsubstituteexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class FontSubstituteException extends GroupDocsConversionException
```

Thrown if font substitute is illegal

#### Constructors

| Constructor | Description |
| --- | --- |
| FontSubstituteException() | Default constructor
 |
| FontSubstituteException(String message) | Creates an exception with a specific message
 |
##### FontSubstituteException()
```
public FontSubstituteException()
```

Default constructor

##### FontSubstituteException(String message)
```
public FontSubstituteException(String message)
```

Creates an exception with a specific message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### GroupDocsConversionException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/groupdocsconversionexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception
```
public class GroupDocsConversionException extends System.Exception
```

GroupDocs.Conversion general exception

#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsConversionException() | Default constructor
 |
| GroupDocsConversionException(String message) | Creates an exception with a specific message
 |
| GroupDocsConversionException(String message, RuntimeException exception) | Create an exception with a specific message and propagate the inner exception
 |
##### GroupDocsConversionException()
```
public GroupDocsConversionException()
```

Default constructor

##### GroupDocsConversionException(String message)
```
public GroupDocsConversionException(String message)
```

Creates an exception with a specific message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

##### GroupDocsConversionException(String message, RuntimeException exception)
```
public GroupDocsConversionException(String message, RuntimeException exception)
```

Create an exception with a specific message and propagate the inner exception

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |
| exception | java.lang.RuntimeException | The inner exception
 |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class IncorrectPasswordException extends GroupDocsConversionException
```

GroupDocs exception thrown when the file is password protected, password is provided but is incorrect

#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() | Default constructor
 |
| IncorrectPasswordException(FileType fileType) | Creates an exception instance with a FileType
 |
| IncorrectPasswordException(String message) | Creates an exception instance with a message
 |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

Default constructor

##### IncorrectPasswordException(FileType fileType)
```
public IncorrectPasswordException(FileType fileType)
```

Creates an exception instance with a FileType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type
 |

##### IncorrectPasswordException(String message)
```
public IncorrectPasswordException(String message)
```

Creates an exception instance with a message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### InvalidConverterSettingsException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/invalidconvertersettingsexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class InvalidConverterSettingsException extends GroupDocsConversionException
```

Thrown if provided converter settings are invalid

#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidConverterSettingsException() | Default constructor
 |
| InvalidConverterSettingsException(String message) | Creates an exception with a specific message
 |
##### InvalidConverterSettingsException()
```
public InvalidConverterSettingsException()
```

Default constructor

##### InvalidConverterSettingsException(String message)
```
public InvalidConverterSettingsException(String message)
```

Creates an exception with a specific message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### InvalidConvertOptionsException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/invalidconvertoptionsexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class InvalidConvertOptionsException extends GroupDocsConversionException
```

Thrown if provided convert options are invalid

#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidConvertOptionsException() | Default constructor
 |
| InvalidConvertOptionsException(String message) | Creates an exception with a specific message
 |
##### InvalidConvertOptionsException()
```
public InvalidConvertOptionsException()
```

Default constructor

##### InvalidConvertOptionsException(String message)
```
public InvalidConvertOptionsException(String message)
```

Creates an exception with a specific message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### PasswordRequiredException
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.exceptions/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.conversion.exceptions.GroupDocsConversionException
```
public final class PasswordRequiredException extends GroupDocsConversionException
```

GroupDocs exception thrown when the file is password protected and password is not provided

#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() | Default constructor
 |
| PasswordRequiredException(FileType fileType) | Creates an exception instance with a FileType
 |
| PasswordRequiredException(String message) | Creates an exception instance with a message
 |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

Default constructor

##### PasswordRequiredException(FileType fileType)
```
public PasswordRequiredException(FileType fileType)
```

Creates an exception instance with a FileType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type
 |

##### PasswordRequiredException(String message)
```
public PasswordRequiredException(String message)
```

Creates an exception instance with a message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message
 |

### com.groupdocs.conversion.filetypes
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes.md

The GroupDocs.Conversion.FileTypes namespace provides classes which represent supported file types.

#### Classes

| Class | Description |
| --- | --- |
| AudioFileType | Defines Audio documents Includes the following types: , , , , , , , , , Learn more about audio formats [here](https://docs.fileformat.com/audio/). |
| CadFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. |
| DatabaseFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. |
| DiagramFileType | Defines Diagram documents. |
| EBookFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. |
| EmailFileType | Defines Email file formats that are used by email applications to store their various data including email messages, attachments, folders, address books etc. |
| FileType | File type base class |
| FontFileType | Defines Font documents. |
| ImageFileType | Defines image documents. |
| NoteFileType | Defines Note-taking formats. |
| PageDescriptionLanguageFileType | Defines Page description documents. |
| PdfFileType | Defines Pdf documents. |
| PresentationFileType | Defines Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. |
| ProjectManagementFileType | Defines Project file formats that are created by Project Management software such as Microsoft Project, Primavera P6 etc. |
| PublisherFileType | Defines Publisher documents. |
| SpreadsheetFileType | Defines Spreadsheet documents. |
| VideoFileType | Defines Video documents Includes the following types: , , , , , , , Learn more about video formats [here](https://docs.fileformat.com/video/). |
| WebFileType | Defines Web documents. |
| WordProcessingFileType | Defines Word Processing files that contain user information in plain text or rich text format. |

### AudioFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/audiofiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public class AudioFileType extends FileType
```

Defines Audio documents Includes the following types: , , , , , , , , , Learn more about audio formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| AudioFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Mp3 | Files with .mp3 extension are digitally encoded file formats for audio files that are formally based on the MPEG-1 Audio Layer III or MPEG-2 Audio Layer III.
 |
| Aac | AAC (Advanced Audio Coding) refers to digital audio coding standard that represent audio files based on lossy audio compression.
 |
| Aiff | The AIFF (Audio Interchange File Format) is an uncompressed audio file format developed by Apple in 1998, but is based on EA IFF 85 Learn more about this file format here.
 |
| Flac | FLAC(Free Lossless Audio Codec) is a lossless compression audio coding format developed by Xiph.Org Foundation Learn more about this file format here.
 |
| M4a | The M4A file format is an audio file created by using the AAC (Advanced Audio Coding) which is known as a lossy compression.
 |
| Wma | A file with .wma extension represents an audio file that is saved in the Advanced Systems Format (ASF) format.
 |
| Ac3 | A file with a .ac3 extension is an Audio Codec 3 file, introduced by Dolby Laboratories.
 |
| Ogg | OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension.
 |
| Wav | WAV, known for WAVE (Waveform Audio File Format), is a subset of Microsoft\\u2019s Resource Interchange File Format (RIFF) specification for storing digital audio files.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
##### AudioFileType()
```
public AudioFileType()
```

Serialization constructor

##### Mp3
```
public static final AudioFileType Mp3
```

Files with .mp3 extension are digitally encoded file formats for audio files that are formally based on the MPEG-1 Audio Layer III or MPEG-2 Audio Layer III. Learn more about this file format here.

##### Aac
```
public static final AudioFileType Aac
```

AAC (Advanced Audio Coding) refers to digital audio coding standard that represent audio files based on lossy audio compression. Learn more about this file format here.

##### Aiff
```
public static final AudioFileType Aiff
```

The AIFF (Audio Interchange File Format) is an uncompressed audio file format developed by Apple in 1998, but is based on EA IFF 85 Learn more about this file format here.

##### Flac
```
public static final AudioFileType Flac
```

FLAC(Free Lossless Audio Codec) is a lossless compression audio coding format developed by Xiph.Org Foundation Learn more about this file format here.

##### M4a
```
public static final AudioFileType M4a
```

The M4A file format is an audio file created by using the AAC (Advanced Audio Coding) which is known as a lossy compression. Learn more about this file format here.

##### Wma
```
public static final AudioFileType Wma
```

A file with .wma extension represents an audio file that is saved in the Advanced Systems Format (ASF) format. Learn more about this file format here.

##### Ac3
```
public static final AudioFileType Ac3
```

A file with a .ac3 extension is an Audio Codec 3 file, introduced by Dolby Laboratories. It is an audio format that can contain up to six channels of audio output. Learn more about this file format here.

##### Ogg
```
public static final AudioFileType Ogg
```

OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension. OGG files are used for storing audio data and can include artist and track information and metadata as well. Learn more about this file format here.

##### Wav
```
public static final AudioFileType Wav
```

WAV, known for WAVE (Waveform Audio File Format), is a subset of Microsoft\\u2019s Resource Interchange File Format (RIFF) specification for storing digital audio files. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions

### CadFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/cadfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class CadFileType extends FileType implements Serializable
```

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs.
Includes the following types:
Dgn,
Dwf,
Dwg,
Dwt,
Dxf,
Ifc,
Igs,
Plt,
Stl.
Cf2.
Dwfx.
Learn more about CAD formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| CadFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Dxf | DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file.
 |
| Dwg | DFiles with DWG extension represent proprietary binary files used for containing 2D and 3D design data.
 |
| Dgn | DGN, Design, files are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System.
 |
| Dwf | Design Web Format (DWF) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files.
 |
| Stl | STL, abbreviation for stereolithrography, is an interchangeable file format that represents 3-dimensional surface geometry.
 |
| Ifc | Files with IFC extension refer to Industry Foundation Classes (IFC) file format that establishes international standards to import and export building objects and their properties.
 |
| Plt | The PLT file format is a vector-based plotter file introduced by Autodesk, Inc.
 |
| Igs | Igs document format
 |
| Dwt | A DWT file is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files.
 |
| Dwfx | DWFX file is a 2D or 3D drawing created with Autodesk CAD software.
 |
| Cf2 | Common File Format File.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### CadFileType()
```
public CadFileType()
```

Serialization constructor

##### Dxf
```
public static final CadFileType Dxf
```

DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file.
Learn more about this file format here.

##### Dwg
```
public static final CadFileType Dwg
```

DFiles with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Like DXF, which are ASCII files, DWG represent the binary file format for CAD (Computer Aided Design) drawings.
Learn more about this file format here

##### Dgn
```
public static final CadFileType Dgn
```

DGN, Design, files are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System.
Learn more about this file format here.

##### Dwf
```
public static final CadFileType Dwf
```

Design Web Format (DWF) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. It contains graphics and text as part of design data and reduce the size of the file due to its compressed format.
Learn more about this file format here.

##### Stl
```
public static final CadFileType Stl
```

STL, abbreviation for stereolithrography, is an interchangeable file format that represents 3-dimensional surface geometry. The file format finds its usage in several fields such as rapid prototyping, 3D printing and computer-aided manufacturing.
Learn more about this file format here.

##### Ifc
```
public static final CadFileType Ifc
```

Files with IFC extension refer to Industry Foundation Classes (IFC) file format that establishes international standards to import and export building objects and their properties. This file format provides interoperability between different software applications.
Learn more about this file format here.

##### Plt
```
public static final CadFileType Plt
```

The PLT file format is a vector-based plotter file introduced by Autodesk, Inc. and contains information for a certain CAD file. Plotting details require accuracy and precision in production, and usage of PLT file guarantee this as all images are printed using lines instead of dots.
Learn more about this file format here.

##### Igs
```
public static final CadFileType Igs
```

Igs document format

##### Dwt
```
public static final CadFileType Dwt
```

A DWT file is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files.
Learn more about this file format here.

##### Dwfx
```
public static final CadFileType Dwfx
```

DWFX file is a 2D or 3D drawing created with Autodesk CAD software. It is saved in the DWFx format, which is similar to a . DWF file, but is formatted using Microsoft's XML Paper Specification (XPS).

##### Cf2
```
public static final CadFileType Cf2
```

Common File Format File. CAD file that contains 3D package designs or other model data; can be processed and cut by a CAD/CAM machine, such as a die cutting device.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### DatabaseFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/databasefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class DatabaseFileType extends FileType implements Serializable
```

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs.
Includes the following types:
Nsf,
Log,
Sql,
Learn more about CAD formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| DatabaseFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Nsf | A file with .nsf (Notes Storage Facility) extension is a database file format used by the IBM Notes software, which was previously known as Lotus Notes.
 |
| Log | A file with .log extension contains the list of plain text with timestamp.
 |
| Sql | A file with .sql extension is a Structured Query Language (SQL) file that contains code to work with relational databases.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
##### DatabaseFileType()
```
public DatabaseFileType()
```

Serialization constructor

##### Nsf
```
public static final DatabaseFileType Nsf
```

A file with .nsf (Notes Storage Facility) extension is a database file format used by the IBM Notes software, which was previously known as Lotus Notes. It defines the schema to store different kind of objects such like emails, appointments, documents, forms and views. Learn more about this file format here.

##### Log
```
public static final DatabaseFileType Log
```

A file with .log extension contains the list of plain text with timestamp. Usually, certain activity detail is logged by the softwares or operating systems to help the developers or users to track what was happening at a certain time period. Learn more about this file format here.

##### Sql
```
public static final DatabaseFileType Sql
```

A file with .sql extension is a Structured Query Language (SQL) file that contains code to work with relational databases. It is used to write SQL statements for CRUD (Create, Read, Update, and Delete) operations on databases. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions

### DiagramFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/diagramfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class DiagramFileType extends FileType implements Serializable
```

Defines Diagram documents. Includes the following types:
Vdw,
Vdx,
Vsd,
Vsdm,
Vsdx,
Vss,
Vssm,
Vssx,
Vst,
Vstm,
Vstx,
Vsx,
Vtx.

#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Vsd | VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these.
 |
| Vsdx | Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards.
 |
| Vss | VSS are stencil files created with Microsoft Visio 2007 and earlier.
 |
| Vst | Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files.
 |
| Vsx | Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio.
 |
| Vtx | A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format.
 |
| Vdw | VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing.
 |
| Vdx | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension.
 |
| Vssx | Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above.
 |
| Vstx | Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above.
 |
| Vsdm | Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros.
 |
| Vssm | Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros.
 |
| Vstm | Files with VSTM extension are template files created with Microsoft Visio that support macros.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### DiagramFileType()
```
public DiagramFileType()
```

Serialization constructor

##### Vsd
```
public static final DiagramFileType Vsd
```

VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these.
Learn more about this file format here.

##### Vsdx
```
public static final DiagramFileType Vsdx
```

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It was developed to replace the binary file format, .VSD, which is supported by earlier versions of Microsoft Visio.
Learn more about this file format here.

##### Vss
```
public static final DiagramFileType Vss
```

VSS are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing.
Learn more about this file format here.

##### Vst
```
public static final DiagramFileType Vst
```

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. These template files are in binary file format and contain the default layout and settings that are utilized for creation of new Visio drawings.
Learn more about this file format here.

##### Vsx
```
public static final DiagramFileType Vsx
```

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and was supported till Visio 2013.
Learn more about this file format here.

##### Vtx
```
public static final DiagramFileType Vtx
```

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. The template is aimed to provide a file with basic settings that can be used to create multiple Visio files of the same settings.
Learn more about this file format here.

##### Vdw
```
public static final DiagramFileType Vdw
```

VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing.
Learn more about this file format here.

##### Vdx
```
public static final DiagramFileType Vdx
```

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. A Visio drawing XML file is created in Visio software, which is developed by Microsoft.
Learn more about this file format here.

##### Vssx
```
public static final DiagramFileType Vssx
```

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representation of a variety of drawing elements such as collection of shapes, connectors, flowcharts, network layout, UML diagrams,
Learn more about this file format here.

##### Vstx
```
public static final DiagramFileType Vstx
```

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide starting point for creating Visio drawings, saved as .VSDX files, with default layout and settings.
Learn more about this file format here.

##### Vsdm
```
public static final DiagramFileType Vsdm
```

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened.
Learn more about this file format here.

##### Vssm
```
public static final DiagramFileType Vssm
```

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. A VSSM file when opened allows to run the macros to achieve desired formatting and placement of shapes in a diagram.
Learn more about this file format here.

##### Vstm
```
public static final DiagramFileType Vstm
```

Files with VSTM extension are template files created with Microsoft Visio that support macros. Unlike VSDX files, files created from VSTM templates can run macros that are developed in Visual Basic for Applications (VBA) code.
Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static final FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### EBookFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/ebookfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EBookFileType extends FileType implements Serializable
```

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs.
Includes the following types:
Epub,
Mobi,
Azw3,
Learn more about CAD formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| EBookFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Epub | EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers.
 |
| Mobi | The MOBI file format is one of the most widely used ebook file format.
 |
| Azw3 | AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### EBookFileType()
```
public EBookFileType()
```

Serialization constructor

##### Epub
```
public static final EBookFileType Epub
```

EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. The format has been so common by now that it is supported by many e-readers and software applications. Learn more about this file format here.

##### Mobi
```
public static final EBookFileType Mobi
```

The MOBI file format is one of the most widely used ebook file format. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as proprietary format for Mobipocket Reader. Learn more about this file format here.

##### Azw3
```
public static final EBookFileType Azw3
```

AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. The format is an enhancement to older AZW files and is used on Kindle Fire devices only with backward compatibility for the ancestor file format i.e. MOBI and AZW. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### EmailFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/emailfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EmailFileType extends FileType implements Serializable
```

Defines Email file formats that are used by email applications to store their various data including email messages, attachments, folders, address books etc.
Includes the following file types:
Eml,
Emlx,
Msg,
Vcf.
Pst.
Ost.
Olm.
Learn more about Email formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Msg | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks.
 |
| Eml | EML file format represents email messages saved using Outlook and other relevant applications.
 |
| Emlx | The EMLX file format is implemented and developed by Apple.
 |
| Vcf | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information.
 |
| Mbox | MBox file format is a generic term that represents a container for collection of electronic mail messages.
 |
| Pst | Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information.
 |
| Ost | OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook.
 |
| Olm | A file with .olm extension is a Microsoft Outlook file for Mac Operating System.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
##### EmailFileType()
```
public EmailFileType()
```

Serialization constructor

##### Msg
```
public static final EmailFileType Msg
```

MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks.
Learn more about this file format here.

##### Eml
```
public static final EmailFileType Eml
```

EML file format represents email messages saved using Outlook and other relevant applications. Almost all emailing clients support this file format for its compliance with RFC-822 Internet Message Format Standard.
Learn more about this file format here.

##### Emlx
```
public static final EmailFileType Emlx
```

The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails.
Learn more about this file format here.

##### Vcf
```
public static final EmailFileType Vcf
```

VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications.
Learn more about this file format here.

##### Mbox
```
public static final EmailFileType Mbox
```

MBox file format is a generic term that represents a container for collection of electronic mail messages. The messages are stored inside the container along with their attachments.
Learn more about this file format here.

##### Pst
```
public static final EmailFileType Pst
```

Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. Learn more about this file format here.

##### Ost
```
public static final EmailFileType Ost
```

OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format here.

##### Olm
```
public static final EmailFileType Olm
```

A file with .olm extension is a Microsoft Outlook file for Mac Operating System. An OLM file stores email messages, journals, calendar data, and other types of application data. These are similar to PST files used by Outlook on Windows Operating System. However, OLM files created by Outlook for Mac can\\u2019t be opened in Outlook for Windows. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions

### FileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/filetype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration
```
public class FileType extends Enumeration
```

File type base class

#### Constructors

| Constructor | Description |
| --- | --- |
| FileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Unknown file type
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | The file format
 |
| getExtension() | The file extension
 |
| getFamily() | The file family
 |
| getDescription() | Description of the file type
 |
| fromFilename(String fileName) | Returns FileType for specified fileName
 |
| fromExtension(String fileExtension) | Gets FileType for provided fileExtension
 |
| fromStream(InputStream inputStream) | Returns FileType for provided document stream
 |
| <T>getAllTypes(Class<T> typeOfT) | Returns all enumeration values.
 |
| <T>getAllTypes(Class<T> typeOfT, FileType[] excluded) |  |
| <T>getAllTypes(Class<T> typeOfT, FileType[][] excluded) |  |
| toString() | String representation
 |
| getLoadOptions() | Prepared default load options for the source file type
 |
| getConvertOptions() | Prepared default convert options for the file type
 |
| isObsolete() |  |
| equals(Enumeration other) |  |
| equals(Object obj) |  |
| hashCode() |  |
##### FileType()
```
public FileType()
```

Serialization constructor

##### Unknown
```
public static final FileType Unknown
```

Unknown file type

##### getFileFormat()
```
public final String getFileFormat()
```

The file format

**Returns:**
java.lang.String
##### getExtension()
```
public final String getExtension()
```

The file extension

**Returns:**
java.lang.String
##### getFamily()
```
public String getFamily()
```

The file family

**Returns:**
java.lang.String - The file family

##### getDescription()
```
public final String getDescription()
```

Description of the file type

**Returns:**
java.lang.String - description

##### fromFilename(String fileName)
```
public static FileType fromFilename(String fileName)
```

Returns FileType for specified fileName

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The file name
 |

**Returns:**
FileType - The file type of specified file name

##### fromExtension(String fileExtension)
```
public static FileType fromExtension(String fileExtension)
```

Gets FileType for provided fileExtension

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | java.lang.String | file extension
 |

**Returns:**
FileType - file type

##### fromStream(InputStream inputStream)
```
public static FileType fromStream(InputStream inputStream)
```

Returns FileType for provided document stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | TStream which will be probed
 |

**Returns:**
FileType - The file type of provided stream

##### <T>getAllTypes(Class<T> typeOfT)
```
public static List<FileType> <T>getAllTypes(Class<T> typeOfT)
```

Returns all enumeration values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
java.util.List<com.groupdocs.conversion.filetypes.FileType> - Enumerable of file types

T
: Enumerated object type.

##### <T>getAllTypes(Class<T> typeOfT, FileType[] excluded)
```
public static List<FileType> <T>getAllTypes(Class<T> typeOfT, FileType[] excluded)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| excluded | FileType\[\] |  |

**Returns:**
java.util.List<com.groupdocs.conversion.filetypes.FileType>
##### <T>getAllTypes(Class<T> typeOfT, FileType[][] excluded)
```
public static List<FileType> <T>getAllTypes(Class<T> typeOfT, FileType[][] excluded)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| excluded | FileType\[\] |  |

**Returns:**
java.util.List<com.groupdocs.conversion.filetypes.FileType>
##### toString()
```
public String toString()
```

String representation

**Returns:**
java.lang.String - String representation of file type

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions - NULL if there is not file type specific load options

##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions - NULL if the conversion to the type not supported

##### isObsolete()
```
public boolean isObsolete()
```

**Returns:**
boolean
##### equals(Enumeration other)
```
public boolean equals(Enumeration other)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Enumeration |  |

**Returns:**
boolean
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int

### FontFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/fontfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class FontFileType extends FileType implements Serializable
```

Defines Font documents.
Includes the following types:
Ttf,
Eot,
Otf,
Cff,
Type1,
Woff,
Woff2,
Learn more about Font formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| FontFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Ttf | A file with .ttf extension represents font files based on the TrueType specifications font technology.
 |
| Eot | A file with .eot extension is an OpenType font that is embedded in a document.
 |
| Otf | A file with .otf extension refers to OpenType font format.
 |
| Cff | A file with .cff extension is a Compact Font Format and is also known as a PostScript Type 1, or CIDFont.
 |
| Type1 | Type 1 fonts is a deprecated Adobe technology which was widely used in the desktop based publishing software and printers that could use PostScript.
 |
| Woff | A file with .woff extension is a web font file based on the Web Open Font Format (WOFF).
 |
| Woff2 | A file with .woff extension is a web font file based on the Web Open Font Format (WOFF).
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### FontFileType()
```
public FontFileType()
```

Serialization constructor

##### Ttf
```
public static final FontFileType Ttf
```

A file with .ttf extension represents font files based on the TrueType specifications font technology. It was initially designed and launched by Apple Computer, Inc for Mac OS and was later adopted by Microsoft for Windows OS. Learn more about this file format here.

##### Eot
```
public static final FontFileType Eot
```

A file with .eot extension is an OpenType font that is embedded in a document. These are mostly used in web files such as a Web page. It was created by Microsoft and is supported by Microsoft Products including PowerPoint presentation .pps file. Learn more about this file format here.

##### Otf
```
public static final FontFileType Otf
```

A file with .otf extension refers to OpenType font format. OTF font format is more scalable and extends the existing features of TTF formats for digital typography. Developed by Microsoft and Adobe, OTF combines the features of PostScript and TrueType font formats. Learn more about this file format here.

##### Cff
```
public static final FontFileType Cff
```

A file with .cff extension is a Compact Font Format and is also known as a PostScript Type 1, or CIDFont. CFF acts as a container to store multiple fonts together in a single unit known as a FontSet. Learn more about this file format here.

##### Type1
```
public static final FontFileType Type1
```

Type 1 fonts is a deprecated Adobe technology which was widely used in the desktop based publishing software and printers that could use PostScript. Although Type 1 fonts are not supported in many modern platforms, web browsers and mobile operating systems, but these are still supported in some of the operating systems. Learn more about this file format here.

##### Woff
```
public static final FontFileType Woff
```

A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format here.

##### Woff2
```
public static final FontFileType Woff2
```

A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### ImageFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/imagefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class ImageFileType extends FileType implements Serializable
```

Defines image documents. Includes the following file types:
Ai,
Bmp,
Cdr,
Cmx,
Dcm,
Dib,
DjVu,
Dng,
Emf,
Emz,
Gif,
Ico,
J2c,
J2k,
Jls,
Jp2,
Jpc,
Jpeg,
Jpf,
Jpg,
Jpm,
Jpx,
Odg,
Png,
Psd,
Svg,
Svgz,
Tga,
Tif,
Tiff,
Webp,
Wmf,
Wmz.
Learn more about Image formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Tiff | TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
 |
| Tif | TTIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
 |
| Jpg | A JPG is a type of image format that is saved using the method of lossy compression.
 |
| Jpeg | A JPEG is a type of image format that is saved using the method of lossy compression.
 |
| Png | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
 |
| Gif | A GIF or Graphical Interchange Format is a type of highly compressed image.
 |
| Bmp | BMP represent Bitmap Image files that are used to store bitmap digital images.
 |
| Ico | Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows.
 |
| Psd | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development.
 |
| Wmf | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data.
 |
| Emf | Enhanced metafile format (EMF) stores graphical images device-independently.
 |
| Dcm | Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
 |
| Dicom | Files with .DICOM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
 |
| Webp | WWebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression.
 |
| Dng | DNG is a digital camera image format used for the storage of raw files.
 |
| Jp2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
 |
| Odg | The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image.
 |
| J2c | J2c document format
 |
| J2k | J2K file is an image that is compressed using the wavelet compression instead of DCT compression.
 |
| Jpx | Jpx document format
 |
| Jpf | Jpf document format
 |
| Jpm | Jpm document format
 |
| Cdr | A CDR file is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed.
 |
| Cmx | Files with CMX extension are Corel Exchange image file format that is used as presentation by CorelSuite applications.
 |
| Dib | DDIB (Device Independent Bitmap) file is a raster image file that is similar in structure to the standard Bitmap files (BMP) but has a different header.
 |
| Jpc | Jpc document format
 |
| Jls | Jls document format
 |
| DjVu | DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs.
 |
| Otg | An OTG file is a drawing template that is created using the OpenDocument standard that follows the OASIS Office Applications 1.0 specification.
 |
| Ai | AI, Adobe Illustrator Artwork, represents single-page vector-based drawings in either the EPS or PDF formats.
 |
| Emz | n EMZ file is actually a compressed version of a Microsoft EMF file.
 |
| Wmz | An WMZ file is actually a compressed version of a Microsoft WMF file.
 |
| Svgz | An SVGZ file is actually a compressed version of a SVG file.
 |
| Tga | A file with .tga extension is a raster graphic format and was created by Truevision Inc.
 |
| Psb | Adobe photoshop saves files in two formats.
 |
| Fodg | FODG is a uncompressed XML-format file used for storing OpenDocument text data.
 |
| Heic |  |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| isVectorImage(FileType fileType) |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### ImageFileType()
```
public ImageFileType()
```

Serialization constructor

##### Tiff
```
public static final ImageFileType Tiff
```

TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces.
Learn more about this file format here.

##### Tif
```
public static final ImageFileType Tif
```

TTIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces.
Learn more about this file format here.

##### Jpg
```
public static final ImageFileType Jpg
```

A JPG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality.
Learn more about this file format here.

##### Jpeg
```
public static final ImageFileType Jpeg
```

A JPEG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality.
Learn more about this file format here.

##### Png
```
public static final ImageFileType Png
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations.
Learn more about this file format here.

##### Gif
```
public static final ImageFileType Gif
```

A GIF or Graphical Interchange Format is a type of highly compressed image. For each image GIF typically allow up to 8 bits per pixel and up to 256 colours are allowed across the image.
Learn more about this file format here.

##### Bmp
```
public static final ImageFileType Bmp
```

BMP represent Bitmap Image files that are used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format.
Learn more about this file format here.

##### Ico
```
public static final ImageFileType Ico
```

Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows.
Learn more about this file format here.

##### Psd
```
public static final ImageFileType Psd
```

PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development.
Learn more about this file format here.

##### Wmf
```
public static final ImageFileType Wmf
```

Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data.
Learn more about this file format here.

##### Emf
```
public static final ImageFileType Emf
```

Enhanced metafile format (EMF) stores graphical images device-independently. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device.
Learn more about this file format here.

##### Dcm
```
public static final ImageFileType Dcm
```

Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
Learn more about this file format here.

##### Dicom
```
public static final ImageFileType Dicom
```

Files with .DICOM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
Learn more about this file format here.

##### Webp
```
public static final ImageFileType Webp
```

WWebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size.
Learn more about this file format here.

##### Dng
```
public static final ImageFileType Dng
```

DNG is a digital camera image format used for the storage of raw files. It has been developed by Adobe in September 2004. It was basically developed for digital photography.
Learn more about this file format here.

##### Jp2
```
public static final ImageFileType Jp2
```

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
/// Learn more about this file format here.

##### Odg
```
public static final ImageFileType Odg
```

The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image.
Learn more about this file format here.

##### J2c
```
public static final ImageFileType J2c
```

J2c document format

##### J2k
```
public static final ImageFileType J2k
```

J2K file is an image that is compressed using the wavelet compression instead of DCT compression.
Learn more about this file format here.

##### Jpx
```
public static final ImageFileType Jpx
```

Jpx document format

##### Jpf
```
public static final ImageFileType Jpf
```

Jpf document format

##### Jpm
```
public static final ImageFileType Jpm
```

Jpm document format

##### Cdr
```
public static final ImageFileType Cdr
```

A CDR file is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. Such a drawing file contains text, lines, shapes, images, colours and effects for vector representation of image contents.
Learn more about this file format here.

##### Cmx
```
public static final ImageFileType Cmx
```

Files with CMX extension are Corel Exchange image file format that is used as presentation by CorelSuite applications.
Learn more about this file format here.

##### Dib
```
public static final ImageFileType Dib
```

DDIB (Device Independent Bitmap) file is a raster image file that is similar in structure to the standard Bitmap files (BMP) but has a different header.
Learn more about this file format here.

##### Jpc
```
public static final ImageFileType Jpc
```

Jpc document format

##### Jls
```
public static final ImageFileType Jls
```

Jls document format

##### DjVu
```
public static final ImageFileType DjVu
```

DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs.
Learn more about this file format here.

##### Otg
```
public static final ImageFileType Otg
```

An OTG file is a drawing template that is created using the OpenDocument standard that follows the OASIS Office Applications 1.0 specification. Learn more about this file format here.

##### Ai
```
public static final ImageFileType Ai
```

AI, Adobe Illustrator Artwork, represents single-page vector-based drawings in either the EPS or PDF formats.

##### Emz
```
public static final ImageFileType Emz
```

n EMZ file is actually a compressed version of a Microsoft EMF file. This allows for easier distribution of the file online. When an EMF file is compressed using the .GZIP compression algorithm, it is then given the .emz file extension.

##### Wmz
```
public static final ImageFileType Wmz
```

An WMZ file is actually a compressed version of a Microsoft WMF file. This allows for easier distribution of the file online. When an EWMFMF file is compressed using the .GZIP compression algorithm, it is then given the .wmz file extension.

##### Svgz
```
public static final ImageFileType Svgz
```

An SVGZ file is actually a compressed version of a SVG file. This allows for easier distribution of the file online. When an SVG file is compressed using the .GZIP compression algorithm, it is then given the .svgz file extension.

##### Tga
```
public static final ImageFileType Tga
```

A file with .tga extension is a raster graphic format and was created by Truevision Inc. Learn more about this file format here.

##### Psb
```
public static final ImageFileType Psb
```

Adobe photoshop saves files in two formats. Files having 30,000 by 30,000 pixels in size are saved with PSD extension and files larger than PSD upto 300,000 by 300,000 pixels are saved with PSB extension known as \\u201cPhotoshop Big\\u201d. Learn more about this file format here.

##### Fodg
```
public static final ImageFileType Fodg
```

FODG is a uncompressed XML-format file used for storing OpenDocument text data. FODG extension is associated with open source office productivity suites Libre Office and OpenOffice.org.

##### Heic
```
public static final ImageFileType Heic
```

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### isVectorImage(FileType fileType)
```
public static boolean isVectorImage(FileType fileType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType |  |

**Returns:**
boolean
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### NoteFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/notefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public final class NoteFileType extends FileType
```

Defines Note-taking formats. Includes the following file types:
One.
Learn more about Note-taking formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| NoteFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| One | File represented by .ONE extension are created by Microsoft OneNote application.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
##### NoteFileType()
```
public NoteFileType()
```

Serialization constructor

##### One
```
public static final NoteFileType One
```

File represented by .ONE extension are created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes.
Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions

### PageDescriptionLanguageFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PageDescriptionLanguageFileType extends FileType implements Serializable
```

Defines Page description documents.
Includes the following types:
Svg,
Eps,
Cgm,
Xps,
Tex,
Ps,
Pcl,
Oxps,

#### Constructors

| Constructor | Description |
| --- | --- |
| PageDescriptionLanguageFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Svg | An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image.
 |
| Eps | Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page.
 |
| Cgm | Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text.
 |
| Xps | An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft.
 |
| Tex | TeX is a language that comprises of programming as well as mark-up features, used to typeset documents.
 |
| Ps | PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing.
 |
| Pcl | PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP).
 |
| Oxps | The file format OXPS is known as Open XML Paper Specification.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### PageDescriptionLanguageFileType()
```
public PageDescriptionLanguageFileType()
```

Serialization constructor

##### Svg
```
public static final PageDescriptionLanguageFileType Svg
```

An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. Learn more about this file format here.

##### Eps
```
public static final PageDescriptionLanguageFileType Eps
```

Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page. Learn more about this file format here.

##### Cgm
```
public static final PageDescriptionLanguageFileType Cgm
```

Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. CGM uses object-oriented approach and many function provisions for image production. Learn more about this file format here.

##### Xps
```
public static final PageDescriptionLanguageFileType Xps
```

An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement of EMF file format and is similar to PDF file format, but uses XML in layout, appearance, and printing information of a document. Learn more about this file format here.

##### Tex
```
public static final PageDescriptionLanguageFileType Tex
```

TeX is a language that comprises of programming as well as mark-up features, used to typeset documents. Learn more about this file format here.

##### Ps
```
public static final PageDescriptionLanguageFileType Ps
```

PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. The main focus of PostScript (PS) is to facilitate the two-dimensional graphic design. Learn more about this file format here.

##### Pcl
```
public static final PageDescriptionLanguageFileType Pcl
```

PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP). Learn more about this file format here.

##### Oxps
```
public static final PageDescriptionLanguageFileType Oxps
```

The file format OXPS is known as Open XML Paper Specification. It\\u2019s a page description language and document format. Microsoft is the developer of this format. OXPS file format is very much familiar to these PDF files. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### PdfFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/pdffiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfFileType extends FileType implements Serializable
```

Defines Pdf documents. Includes the following file types:
Pdf,

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Pdf | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### PdfFileType()
```
public PdfFileType()
```

Serialization constructor

##### Pdf
```
public static final PdfFileType Pdf
```

Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System.
Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static final FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### PresentationFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/presentationfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PresentationFileType extends FileType implements Serializable
```

Defines Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects.
Includes the following file types:
Odp,
Otp,
Pot,
Potm,
Potx,
Pps,
Ppsm,
Ppsx,
Ppt,
Pptm,
Pptx.
Learn more about Presentation formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Ppt | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow.
 |
| Pps | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose.
 |
| Pptx | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application.
 |
| Ppsx | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
 |
| Odp | Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard.
 |
| Otp | Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format.
 |
| Potx | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
 |
| Pot | Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
 |
| Potm | Files with POTM extension are Microsoft PowerPoint template files with support for Macros.
 |
| Pptm | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
 |
| Ppsm | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
 |
| Fodp | Files with FODP extension represent OpenDocument Flat XML Presentation.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### PresentationFileType()
```
public PresentationFileType()
```

Serialization constructor

##### Ppt
```
public static final PresentationFileType Ppt
```

A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003.
Learn more about this file format here.

##### Pps
```
public static final PresentationFileType Pps
```

PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003.
Learn more about this file format here.

##### Pptx
```
public static final PresentationFileType Pptx
```

Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format.
Learn more about this file format here.

##### Ppsx
```
public static final PresentationFileType Ppsx
```

PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
Learn more about this file format here.

##### Odp
```
public static final PresentationFileType Odp
```

Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard.
Learn more about this file format here.

##### Otp
```
public static final PresentationFileType Otp
```

Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format.
Learn more about this file format here.

##### Potx
```
public static final PresentationFileType Potx
```

Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
Learn more about this file format here.

##### Pot
```
public static final PresentationFileType Pot
```

Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
Learn more about this file format here.

##### Potm
```
public static final PresentationFileType Potm
```

Files with POTM extension are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files.
Learn more about this file format here.

##### Pptm
```
public static final PresentationFileType Pptm
```

Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
Learn more about this file format here.

##### Ppsm
```
public static final PresentationFileType Ppsm
```

Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
Learn more about this file format here.

##### Fodp
```
public static final PresentationFileType Fodp
```

Files with FODP extension represent OpenDocument Flat XML Presentation. Presentation file saved in the OpenDocument format, but saved using a flat XML format instead of the .ZIP container used by standard .ODP files

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### ProjectManagementFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/projectmanagementfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public final class ProjectManagementFileType extends FileType
```

Defines Project file formats that are created by Project Management software such as Microsoft Project, Primavera P6 etc. A project file is a collection of tasks, resources, and their scheduling to get a measurable output in the form or a product or a service.
Project management documents. Includes the following file types:
Mpp,
Mpt,
Mpx.
Learn more about Project Management formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Mpt | Microsoft Project template files, contain basic information and structure along with document settings for creating .MPP files.
 |
| Mpp | MPP is Microsoft Project data file that stores information related to project management in an integrated manner.
 |
| Mpx | Microsoft Exchange File Format, is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating.
 |
| Xer | The XER file format is a proprietary project file format used by Primavera P6 project planning and management application.
 |
#### Methods

| Method | Description |
| --- | --- |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### ProjectManagementFileType()
```
public ProjectManagementFileType()
```

Serialization constructor

##### Mpt
```
public static final ProjectManagementFileType Mpt
```

Microsoft Project template files, contain basic information and structure along with document settings for creating .MPP files.
Learn more about this file format here.

##### Mpp
```
public static final ProjectManagementFileType Mpp
```

MPP is Microsoft Project data file that stores information related to project management in an integrated manner.
Learn more about this file format here.

##### Mpx
```
public static final ProjectManagementFileType Mpx
```

Microsoft Exchange File Format, is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating.
Learn more about this file format here.

##### Xer
```
public static final ProjectManagementFileType Xer
```

The XER file format is a proprietary project file format used by Primavera P6 project planning and management application.
Learn more about this file format here.

##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### PublisherFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/publisherfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PublisherFileType extends FileType implements Serializable
```

Defines Publisher documents.
Includes the following types:
Pub,
Learn more about Font formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| PublisherFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Pub | A PUB file is a Microsoft Publisher document file format.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### PublisherFileType()
```
public PublisherFileType()
```

Serialization constructor

##### Pub
```
public static final PublisherFileType Pub
```

A PUB file is a Microsoft Publisher document file format. It is used to create several types of design layout documents such as newsletters, flyers, brochures, postcards, etc. PUB files can contain text, raster and vector images. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### SpreadsheetFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/spreadsheetfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class SpreadsheetFileType extends FileType implements Serializable
```

Defines Spreadsheet documents. Includes the following file types:
Csv,
Fods,
Ods,
Ots,
Tsv,
Xlam,
Xls,
Xlsb,
Xlsm,
Xlsx,
Xlt,
Xltm,
Xltx.
Learn more about Spreadsheet formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Xls | XLS represents Excel Binary File Format.
 |
| Xlsx | XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
 |
| Xlsm | XLSM is a type of Spreadsheet files that support macros.
 |
| Xlsb | XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content.
 |
| Ods | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
 |
| Ots | A file with .ots extension is an OpenDocument Spreadsheet Template file that is created with the Calc application software included in Apache OpenOffice.
 |
| Xltx | XLTX file represents Microsoft Excel Template that are based on the Office OpenXML file format specifications.
 |
| Xlt | Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite.
 |
| Xltm | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files.
 |
| Tsv | A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format.
 |
| Xlam | XLAM is an Macro-Enabled Add-In file that is used to add new functions to spreadsheets.
 |
| Csv | Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values.
 |
| Fods | A file with .fods extension is a type of OpenDocument Spreadsheet document format that stores data in rows and columns.
 |
| Dif | DIF stands for Data Interchange Format that is used to import/export spreadsheets data between different applications.
 |
| Sxc | The file format SXC(Sun XML Calc) belongs to an office suite called OpenOffice.org.
 |
| Numbers | The files with .numbers extension are classified as spreadsheet file type, that\\u2019s why they are similar to the .xlsx files; but the Numbers files are created by using Apple iWork Numbers spreadsheet software.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### SpreadsheetFileType()
```
public SpreadsheetFileType()
```

Serialization constructor

##### Xls
```
public static final SpreadsheetFileType Xls
```

XLS represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers.
Learn more about this file format here.

##### Xlsx
```
public static final SpreadsheetFileType Xlsx
```

XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
Learn more about this file format here.

##### Xlsm
```
public static final SpreadsheetFileType Xlsm
```

XLSM is a type of Spreadsheet files that support macros.
Learn more about this file format here.

##### Xlsb
```
public static final SpreadsheetFileType Xlsb
```

XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content.
Learn more about this file format here.

##### Ods
```
public static final SpreadsheetFileType Ods
```

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns.
Learn more about this file format here.

##### Ots
```
public static final SpreadsheetFileType Ots
```

A file with .ots extension is an OpenDocument Spreadsheet Template file that is created with the Calc application software included in Apache OpenOffice. Calc application software is the similar to Excel available in Microsoft Office.
Learn more about this file format here.

##### Xltx
```
public static final SpreadsheetFileType Xltx
```

XLTX file represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files that exhibit the same settings as specified in the XLTX file.
Learn more about this file format here.

##### Xlt
```
public static final SpreadsheetFileType Xlt
```

Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening these.
Learn more about this file format here.

##### Xltm
```
public static final SpreadsheetFileType Xltm
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure other than that the later doesn't support creating template files with macros.
Learn more about this file format here.

##### Tsv
```
public static final SpreadsheetFileType Tsv
```

A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format.
Learn more about this file format here.

##### Xlam
```
public static final SpreadsheetFileType Xlam
```

XLAM is an Macro-Enabled Add-In file that is used to add new functions to spreadsheets. An Add-In is a supplemental program that runs additional code and provides additional functionality for spreadsheets.
Learn more about this file format here

##### Csv
```
public static final SpreadsheetFileType Csv
```

Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values.
Learn more about this file format here.

##### Fods
```
public static final SpreadsheetFileType Fods
```

A file with .fods extension is a type of OpenDocument Spreadsheet document format that stores data in rows and columns. The format is specified as part of ODF 1.2 specifications published and maintained by OASIS. Learn more about this file format here.

##### Dif
```
public static final SpreadsheetFileType Dif
```

DIF stands for Data Interchange Format that is used to import/export spreadsheets data between different applications. These include Microsoft Excel, OpenOffice Calc, StarCalc and many others. Learn more about this file format here.

##### Sxc
```
public static final SpreadsheetFileType Sxc
```

The file format SXC(Sun XML Calc) belongs to an office suite called OpenOffice.org. This format generally deals with the spreadsheet needs of users as it is an XML based spreadsheet file format. SXC format supports formulas, functions, macros and charts along with DataPilot. Learn more about this file format here.

##### Numbers
```
public static final SpreadsheetFileType Numbers
```

The files with .numbers extension are classified as spreadsheet file type, that\\u2019s why they are similar to the .xlsx files; but the Numbers files are created by using Apple iWork Numbers spreadsheet software. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static final FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### VideoFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/videofiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public class VideoFileType extends FileType
```

Defines Video documents Includes the following types: , , , , , , , Learn more about video formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| VideoFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Mp4 | MP4(short for MPEG-4 Part 14) is a file format based on ISO/IEC 14496-12:2004 that is based on QuickTime File Format but formally specifies support for Initial Object Descriptors (IOD) and other MPEG features.
 |
| Avi | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft.
 |
| Flv | FLV (Flash Video) is a container file format with the .flv extension.
 |
| Mkv | MKV (Matroska Video) is a multimedia container similar to MOV and AVI format but it supports more than one audio and subtitle track in the same file.
 |
| Mov | MOV or QuickTime file format is a multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e.
 |
| Webm | A file with a .webm extension is a video file based on the open, royalty-free WebM file format.
 |
| Wmv | Windows Media Video is the compressed video format developed by Microsoft.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
##### VideoFileType()
```
public VideoFileType()
```

Serialization constructor

##### Mp4
```
public static final VideoFileType Mp4
```

MP4(short for MPEG-4 Part 14) is a file format based on ISO/IEC 14496-12:2004 that is based on QuickTime File Format but formally specifies support for Initial Object Descriptors (IOD) and other MPEG features. Learn more about this file format here.

##### Avi
```
public static final VideoFileType Avi
```

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. It holds the audio and video data created and compressed using several codecs (Coders/Decoders) such as XVid and DivX. Learn more about this file format here.

##### Flv
```
public static final VideoFileType Flv
```

FLV (Flash Video) is a container file format with the .flv extension. FLV is used to deliver audio/video content over the internet by using the Adobe Flash Player or Adobe Air. Learn more about this file format here.

##### Mkv
```
public static final VideoFileType Mkv
```

MKV (Matroska Video) is a multimedia container similar to MOV and AVI format but it supports more than one audio and subtitle track in the same file. An MKV file is the Matroska multimedia container format used for video. Learn more about this file format here.

##### Mov
```
public static final VideoFileType Mov
```

MOV or QuickTime file format is a multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. Video, Audio, text, etc. Learn more about this file format here.

##### Webm
```
public static final VideoFileType Webm
```

A file with a .webm extension is a video file based on the open, royalty-free WebM file format. It has been designed for sharing video on the web and defines the file container structure including video and audio formats. Learn more about this file format here.

##### Wmv
```
public static final VideoFileType Wmv
```

Windows Media Video is the compressed video format developed by Microsoft. After the standardization by the Society of Motion Picture and Television Engineers (SMPTE), WMV is now considered to be an open standard format. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions

### WebFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/webfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class WebFileType extends FileType implements Serializable
```

Defines Web documents.
Includes the following types:
Xml,
Json,
Html,
Htm,
Mht,
Mhtml,
Chm,
Learn more about web formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| WebFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Xml | XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects.
 |
| Json | JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data.
 |
| Html | HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers.
 |
| Htm | HTM (Hyper Text Markup Language) is the extension for web pages created for display in browsers.
 |
| Mht | Files with MHTML extension represent a web page archive format that can be created by a number of different applications.
 |
| Mhtml | Files with MHTML extension represent a web page archive format that can be created by a number of different applications.
 |
| Chm | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### WebFileType()
```
public WebFileType()
```

Serialization constructor

##### Xml
```
public static final WebFileType Xml
```

XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects. Learn more about this file format here.

##### Json
```
public static final WebFileType Json
```

JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. Learn more about this file format here.

##### Html
```
public static final WebFileType Html
```

HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format here.

##### Htm
```
public static final WebFileType Htm
```

HTM (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format here.

##### Mht
```
public static final WebFileType Mht
```

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format here.

##### Mhtml
```
public static final WebFileType Mhtml
```

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format here.

##### Chm
```
public static final WebFileType Chm
```

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. It provides an index for quick accessing the topics and navigation to different parts of the help document. Learn more about this file format here.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### WordProcessingFileType
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.filetypes/wordprocessingfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class WordProcessingFileType extends FileType implements Serializable
```

Defines Word Processing files that contain user information in plain text or rich text format. A plain text file format contains unformatted text and no font or page settings etc. can be applied. In contrast, a rich text file format allows formatting options such as setting fonts type, styles (bold, italic, underline, etc.), page margins, headings, bullets and numbers, and several other formatting features.
Includes the following file types:
Doc,
Docm,
Docx,
Dot,
Dotm,
Dotx,
Odt,
Ott,
Rtf,
Txt,
Md,
Learn more about Word Processing formats here.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingFileType() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Doc | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format.
 |
| Docm | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
 |
| Docx | DOCX is a well-known format for Microsoft Word documents.
 |
| Dot | Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files.
 |
| Dotm | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
 |
| Dotx | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files.
 |
| Rtf | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications.
 |
| Odt | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format.
 |
| Ott | Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format.
 |
| Txt | A file with .TXT extension represents a text document that contains plain text in the form of lines.
 |
| Md | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension.
 |
| Ml | Ml file
 |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### WordProcessingFileType()
```
public WordProcessingFileType()
```

Serialization constructor

##### Doc
```
public static final WordProcessingFileType Doc
```

Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format.
Learn more about this file format here.

##### Docm
```
public static final WordProcessingFileType Docm
```

DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
Learn more about this file format here.

##### Docx
```
public static final WordProcessingFileType Docx
```

DOCX is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files.
Learn more about this file format here.

##### Dot
```
public static final WordProcessingFileType Dot
```

Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files.
Learn more about this file format here.

##### Dotm
```
public static final WordProcessingFileType Dotm
```

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
Learn more about this file format here.

##### Dotx
```
public static final WordProcessingFileType Dotx
```

Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files.
Learn more about this file format here.

##### Rtf
```
public static final WordProcessingFileType Rtf
```

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications.
Learn more about this file format here.

##### Odt
```
public static final WordProcessingFileType Odt
```

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format.
Learn more about this file format here.

##### Ott
```
public static final WordProcessingFileType Ott
```

Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format.
Learn more about this file format here.

##### Txt
```
public static final WordProcessingFileType Txt
```

A file with .TXT extension represents a text document that contains plain text in the form of lines.
Learn more about this file format here.

##### Md
```
public static final WordProcessingFileType Md
```

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. MD files are saved in plain text format that uses Markdown language which also includes inline text symbols, defining how a text can be formatted such as indentations, table formatting, fonts, and headers. Learn more about this file format here.

##### Ml
```
public static final WordProcessingFileType Ml
```

Ml file

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions<WordProcessingFileType> getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### com.groupdocs.conversion.fluent
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent.md

#### Interfaces

| Interface | Description |
| --- | --- |
| IConversionByPageCompleted | Handle conversion page completed |
| IConversionByPageCompletedOrConvert | Handle conversion completed or execute conversion |
| IConversionCompleted | Handle conversion completed |
| IConversionCompletedOrConvert | Handle conversion completed or execute conversion |
| IConversionCompressResult | Can compress all conversion results in single archive |
| IConversionCompressResultCompleted | Handle compression completed |
| IConversionConvert | Execute conversion |
| IConversionConvertByPageOptions | Conversion convert options |
| IConversionConvertOptions | Conversion convert options |
| IConversionFrom | Setup source for conversion |
| IConversionGetDocumentInfo | Gets source document info - pages count and other document properties specific to the file type. |
| IConversionGetPossibleConversions | Gets possible conversions for the source document. |
| IConversionIsPasswordProtected | Checks if source document is password protected |
| IConversionLoadOptions | Conversion load options |
| IConversionLoadOptionsOrSourceDocumentLoaded | Conversion load options or actions with loaded document |
| IConversionSettings | Setup conversion settings |
| IConversionSettingsOrConversionFrom | Conversion settings or conversion source |
| IConversionSourceDocumentLoaded | Provides possible actions with loaded document |
| IConversionTo | Set how converted document to be stored |

### IConversionByPageCompleted
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionbypagecompleted.md

### IConversionByPageCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionbypagecompletedorconvert.md

**All Implemented Interfaces:**
com.groupdocs.conversion.fluent.IConversionByPageCompleted, com.groupdocs.conversion.fluent.IConversionConvert, com.groupdocs.conversion.fluent.IConversionCompressResult
```
public interface IConversionByPageCompletedOrConvert extends IConversionByPageCompleted, IConversionConvert, IConversionCompressResult
```

Handle conversion completed or execute conversion

### IConversionCompleted
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversioncompleted.md

### IConversionCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversioncompletedorconvert.md

**All Implemented Interfaces:**
com.groupdocs.conversion.fluent.IConversionCompleted, com.groupdocs.conversion.fluent.IConversionConvert, com.groupdocs.conversion.fluent.IConversionCompressResult
```
public interface IConversionCompletedOrConvert extends IConversionCompleted, IConversionConvert, IConversionCompressResult
```

Handle conversion completed or execute conversion

### IConversionCompressResult
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversioncompressresult.md

### IConversionCompressResultCompleted
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversioncompressresultcompleted.md

### IConversionConvert
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionconvert.md

### IConversionConvertByPageOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionconvertbypageoptions.md

### IConversionConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionconvertoptions.md

### IConversionFrom
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionfrom.md

### IConversionGetDocumentInfo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversiongetdocumentinfo.md

### IConversionGetPossibleConversions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversiongetpossibleconversions.md

### IConversionIsPasswordProtected
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionispasswordprotected.md

### IConversionLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionloadoptions.md

### IConversionLoadOptionsOrSourceDocumentLoaded
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionloadoptionsorsourcedocumentloaded.md

**All Implemented Interfaces:**
com.groupdocs.conversion.fluent.IConversionLoadOptions, com.groupdocs.conversion.fluent.IConversionSourceDocumentLoaded
```
public interface IConversionLoadOptionsOrSourceDocumentLoaded extends IConversionLoadOptions, IConversionSourceDocumentLoaded
```

Conversion load options or actions with loaded document

### IConversionSettings
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionsettings.md

### IConversionSettingsOrConversionFrom
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionsettingsorconversionfrom.md

**All Implemented Interfaces:**
com.groupdocs.conversion.fluent.IConversionSettings, com.groupdocs.conversion.fluent.IConversionFrom
```
public interface IConversionSettingsOrConversionFrom extends IConversionSettings, IConversionFrom
```

Conversion settings or conversion source

### IConversionSourceDocumentLoaded
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionsourcedocumentloaded.md

**All Implemented Interfaces:**
com.groupdocs.conversion.fluent.IConversionTo, com.groupdocs.conversion.fluent.IConversionGetPossibleConversions, com.groupdocs.conversion.fluent.IConversionGetDocumentInfo, com.groupdocs.conversion.fluent.IConversionIsPasswordProtected
```
public interface IConversionSourceDocumentLoaded extends IConversionTo, IConversionGetPossibleConversions, IConversionGetDocumentInfo, IConversionIsPasswordProtected
```

Provides possible actions with loaded document

### IConversionTo
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.fluent/iconversionto.md

### com.groupdocs.conversion.integration.audio
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.audio.md

#### Interfaces

| Interface | Description |
| --- | --- |
| IAudioConnector | Defines methods that are required to convert audio to audio documents. |

### IAudioConnector
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.audio/iaudioconnector.md

### com.groupdocs.conversion.integration.ocr
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.ocr.md

The GroupDocs.Conversion.Integration.Ocr package provides metadata for a OCR.

#### Classes

| Class | Description |
| --- | --- |
| RecognizedImage | Represents text, extracted from an image as a result of its recognition process. |
| TextFragment | Represents a part of recognized text (word, symbol, etc), extracted by OCR engine. |
| TextLine | Represents text, extracted from an image as a result of its recognition process. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IOcrConnector | Defines methods that are required to apply OCR to image documents and embedded images. |

### IOcrConnector
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.ocr/iocrconnector.md

### RecognizedImage
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.ocr/recognizedimage.md

**Inheritance:**
java.lang.Object
```
public class RecognizedImage
```

Represents text, extracted from an image as a result of its recognition process.

#### Constructors

| Constructor | Description |
| --- | --- |
| RecognizedImage(List<TextLine> lines) | Initializes a new instance of the class, using a set of recognized lines.
 |
#### Fields

| Field | Description |
| --- | --- |
| EMPTY | Empty recognized image
 |
#### Methods

| Method | Description |
| --- | --- |
| getLines() | Gets lines of text, with their fragments, recognized within the document.
 |
| getText() | Gets textual equivalent of the structured text
 |
##### RecognizedImage(List<TextLine> lines)
```
public RecognizedImage(List<TextLine> lines)
```

Initializes a new instance of the class, using a set of recognized lines.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lines | java.util.List<com.groupdocs.conversion.integration.ocr.TextLine> | an IEnumerable (e.g. a list or an array) of recognized lines
 |

##### EMPTY
```
public static final RecognizedImage EMPTY
```

Empty recognized image

##### getLines()
```
public TextLine[] getLines()
```

Gets lines of text, with their fragments, recognized within the document.

**Returns:**
com.groupdocs.conversion.integration.ocr.TextLine[]
##### getText()
```
public String getText()
```

Gets textual equivalent of the structured text

**Returns:**
java.lang.String

### TextFragment
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.ocr/textfragment.md

**Inheritance:**
java.lang.Object
```
public class TextFragment
```

Represents a part of recognized text (word, symbol, etc), extracted by OCR engine.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextFragment(String text, Rectangle rectangle) | Initializes a new instance of the recognized text fragment.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets a textual content of the recognized text fragment.
 |
| getRectangle() | Gets a bounding rectangle of the recognized text fragment.
 |
##### TextFragment(String text, Rectangle rectangle)
```
public TextFragment(String text, Rectangle rectangle)
```

Initializes a new instance of the recognized text fragment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | textual content of the recognized text fragment
 |
| rectangle | java.awt.Rectangle | bounding rectangle of the recognized text fragment
 |

##### getText()
```
public String getText()
```

Gets a textual content of the recognized text fragment.

**Returns:**
java.lang.String
##### getRectangle()
```
public Rectangle getRectangle()
```

Gets a bounding rectangle of the recognized text fragment.

**Returns:**
Rectangle

### TextLine
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.ocr/textline.md

**Inheritance:**
java.lang.Object
```
public class TextLine
```

Represents text, extracted from an image as a result of its recognition process.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextLine(List<TextFragment> fragments) | Initializes a new instance of a line of text, extracted by OCR engine from an image.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFragments() | Gets an array of text fragments, such as symbols and words, recognized in the line.
 |
##### TextLine(List<TextFragment> fragments)
```
public TextLine(List<TextFragment> fragments)
```

Initializes a new instance of a line of text, extracted by OCR engine from an image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fragments | java.util.List<com.groupdocs.conversion.integration.ocr.TextFragment> | initial set of text fragments
 |

##### getFragments()
```
public TextFragment[] getFragments()
```

Gets an array of text fragments, such as symbols and words, recognized in the line.

**Returns:**
com.groupdocs.conversion.integration.ocr.TextFragment[]

### com.groupdocs.conversion.integration.video
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.integration.video.md

### com.groupdocs.conversion.licensing
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.licensing.md

The GroupDocs.Conversion.Legacy.Licensing namespace provides classes for applying of the license

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |
| Metered | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |

### License
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Provides methods to license the component. Learn more about licensing
here
.
**Learn more** More about licensing: GroupDocs Licensing FAQ More about GroupDocs.Conversion licensing: Evaluation Limitations and Licensing

#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| isLicensed() | Returns true if a valid license has been applied; false if the component is running in evaluation mode.
 |
| setLicense(InputStream licenseStream) |  |
| setLicense(System.IO.Stream licenseStream) | Licenses the component.
 |
| setLicense(String licensePath) | Licenses the component.
 |
| resetLicense() |  |
##### License()
```
public License()
```

##### isLicensed()
```
public boolean isLicensed()
```

Returns true if a valid license has been applied; false if the component is running in evaluation mode.

**Returns:**
boolean
##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream |  |

##### setLicense(System.IO.Stream licenseStream)
```
public final void setLicense(System.IO.Stream licenseStream)
```

Licenses the component.

<br />

*** ** * ** ***

> ```
>  The following example demonstrates how to set a license
>  passing Stream of the license file.
>   using (FileStream licenseStream = new FileStream("LicenseFile.lic", FileMode.Open))
>  {
>      GroupDocs.Conversion.License lic = new GroupDocs.Conversion.License();
>      lic.SetLicense(licenseStream);
>  }
>
>
> ```

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | com.aspose.ms.System.IO.Stream | The license stream.
 |

##### setLicense(String licensePath)
```
public void setLicense(String licensePath)
```

Licenses the component.

<br />

*** ** * ** ***

> ```
>  The following example demonstrates how to set a license
>  passing a path to the license file.
>   string licensePath = "GroupDocs.Conversion.lic";
>  GroupDocs.Conversion.License lic = new GroupDocs.Conversion.License();
>  lic.SetLicense(licensePath);
>
>
> ```

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path.
 |

##### resetLicense()
```
public static void resetLicense()
```

### Metered
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.licensing/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying
Metered
 license.
**Learn more** More about Metered licensing: Metered Licensing FAQ More about GroupDocs.Conversion licensing: Evaluation Limitations and Licensing

#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() |  |
#### Methods

| Method | Description |
| --- | --- |
| setMeteredKey(String publicKey, String privateKey) | Activates product with Metered keys.
 |
| getConsumptionQuantity() | Retrieves amount of MBs processed.
 |
| getConsumptionCredit() | Retrieves count of credits consumed.
 |
| increaseBytesCount(long bytesCount) |  |
| consumeCreditsBySize(long bytesCount) |  |
##### Metered()
```
public Metered()
```

##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Activates product with Metered keys.

<br />

*** ** * ** ***

> ```
>  Following example demonstrates how to activate product with Metered keys.
>   string publicKey = "Public Key";
>  string privateKey = "Private Key";
>  Metered metered = new Metered();
>  metered.SetMeteredKey(publicKey, privateKey);
>
>
> ```

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | The public key.
 |
| privateKey | java.lang.String | The private key.
 |

##### getConsumptionQuantity()
```
public static BigDecimal getConsumptionQuantity()
```

Retrieves amount of MBs processed.

<br />

*** ** * ** ***

> ```
>   Following example demonstrates how to retrieve amount of MBs processed.
>     string publicKey = "Public Key";
>   string privateKey = "Private Key";
>
>   Metered metered = new Metered();
>   metered.SetMeteredKey(publicKey, privateKey);
>   decimal mbProcessed = Metered.GetConsumptionQuantity();
>
>
> ```

<br />

**Returns:**
java.math.BigDecimal
##### getConsumptionCredit()
```
public static BigDecimal getConsumptionCredit()
```

Retrieves count of credits consumed.

<br />

*** ** * ** ***

> ```
>   Following example demonstrates how to retrieve count of credits consumed.
>     string publicKey = "Public Key";
>   string privateKey = "Private Key";
>
>   Metered metered = new Metered();
>   metered.SetMeteredKey(publicKey, privateKey);
>   decimal creditsConsumed = Metered.GetConsumptionCredit();
>
>
> ```

<br />

**Returns:**
java.math.BigDecimal
##### increaseBytesCount(long bytesCount)
```
public static void increaseBytesCount(long bytesCount)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bytesCount | long |  |

##### consumeCreditsBySize(long bytesCount)
```
public static void consumeCreditsBySize(long bytesCount)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bytesCount | long |  |

### com.groupdocs.conversion.logging
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.logging.md

The GroupDocs.Conversion.Logging namespace provides classes for customizing logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Console logger implementation. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

### ConsoleLogger
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.logging/consolelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.logging.ILogger
```
public final class ConsoleLogger implements ILogger
```

Console logger implementation.

#### Constructors

| Constructor | Description |
| --- | --- |
| ConsoleLogger() |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message) | Writes trace log message;
Trace log messages provides generally useful information about application flow.
 |
| warning(String message) | Writes warning log message;
Warning log messages provides information about unexpected and recoverable event in application flow.
 |
| error(String message, Exception exception) | Writes error log message;
Error log messages provides information about unrecoverable events in application flow.
 |
##### ConsoleLogger()
```
public ConsoleLogger()
```

##### trace(String message)
```
public void trace(String message)
```

Writes trace log message;
Trace log messages provides generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message.
 |

##### warning(String message)
```
public void warning(String message)
```

Writes warning log message;
Warning log messages provides information about unexpected and recoverable event in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning message.
 |

##### error(String message, Exception exception)
```
public void error(String message, Exception exception)
```

Writes error log message;
Error log messages provides information about unrecoverable events in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message.
 |
| exception | java.lang.Exception | The exception.
 |

### ILogger
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.logging/ilogger.md

### com.groupdocs.conversion.options.convert
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert.md

The GroupDocs.Conversion.Options.Convert namespace provides classes to specify additional options for document conversion process.

#### Classes

| Class | Description |
| --- | --- |
| CadConvertOptions | Options for conversion to Cad type. |
| CommonConvertOptions<TFileType> | abstract generic common conversion options class. |
| ConvertOptions<TFileType> | The general conversion options class. |
| DiagramConvertOptions | Options for conversion to Diagram file type. |
| EBookConvertOptions | Options for conversion to EBook file type. |
| EmailConvertOptions | Options for conversion to Email file type. |
| Font | Font settings |
| FontConvertOptions | Options for conversion to EBook file type. |
| ImageConvertOptions | Options for conversion to Image file type. |
| ImageFlipModes | Describes image flip modes. |
| JpegOptions | Options for conversion to Jpeg file type. |
| JpgColorModes | Describes Jpg color modes enumeration. |
| JpgCompressionMethods | Describes Jpg compression modes |
| NoConvertOptions | Special convert option class, which instructs converter to copy source document without any processing |
| PageDescriptionLanguageConvertOptions | Options for conversion to page descriptions language file type. |
| PdfConvertOptions | Options for conversion to Pdf file type. |
| PdfDirection | Describes Pdf text direction. |
| PdfFormats | Describes Pdf formats enumeration. |
| PdfFormattingOptions | Defines Pdf formatting options. |
| PdfOptimizationOptions | Defines Pdf optimization options. |
| PdfOptions | Options for conversion to Pdf file type. |
| PdfPageLayout | Describes Pdf page layout. |
| PdfPageMode | Describes Pdf page mode |
| PresentationConvertOptions | Describes options for conversion to Presentation file type. |
| ProjectManagementConvertOptions | Options for conversion to Project management file type. |
| PsdColorModes | Defines Psd color modes enumeration. |
| PsdCompressionMethods | Describes Psd compression methods. |
| PsdOptions | Options for converting to Psd file type. |
| Rotation | Describes page rotation enumeration |
| RtfOptions | Options for conversion to RTF file type. |
| SpreadsheetConvertOptions | Options for conversion to Spreadsheet file type. |
| TiffCompressionMethods | Describes Tiff compression methods enumeration. |
| TiffOptions | Options for conversion to TIFF file type. |
| WatermarkImageOptions | Options for settings watermark to the converted document |
| WatermarkOptions | Options for settings watermark to the converted document |
| WatermarkTextOptions | Options for settings text watermark to the converted document |
| WebConvertOptions | Options for conversion to Web file type. |
| WebpOptions | Options for conversion to Webp file type. |
| WordProcessingConvertOptions | Options for conversion to WordProcessing file type. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IConvertOptions | Represents convert options |
| IPageMarginConvertOptions | Represents convert options that support page margins |
| IPageOrientationConvertOptions | Represents convert options that support page orientation |
| IPageRangedConvertOptions | Represents convert options that support conversion of specific list of pages |
| IPageSize |  |
| IPageSizeConvertOptions | Represents convert options that support page size |
| IPagedConvertOptions | Represents convert options that allows conversion to perform page limitation by specifying start page and pages count |
| IPdfRecognitionModeOptions | Represents convert options that control recognition mode when converting from PDF |
| IWatermarkedConvertOptions | Represents convert options that allow output of conversion to be watermarked |

#### Enumerations

| Enum | Description |
| --- | --- |
| PageOrientation |  |
| PageSize |  |
| PdfRecognitionMode |  |

### CadConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/cadconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IPagedConvertOptions
```
public class CadConvertOptions extends ConvertOptions<CadFileType> implements IPagedConvertOptions
```

Options for conversion to Cad type.

#### Constructors

| Constructor | Description |
| --- | --- |
| CadConvertOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() |  |
| setPageNumber(int pageNumber) |  |
| getPagesCount() |  |
| setPagesCount(int pagesCount) |  |
##### CadConvertOptions()
```
public CadConvertOptions()
```

Initializes new instance of class.

##### getPageNumber()
```
public Integer getPageNumber()
```

Gets the page number to start conversion from.

**Returns:**
java.lang.Integer
##### setPageNumber(int pageNumber)
```
public void setPageNumber(int pageNumber)
```

Sets the page number to start conversion from.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |

##### getPagesCount()
```
public Integer getPagesCount()
```

Gets number of pages to convert starting from PageNumber.

**Returns:**
java.lang.Integer
##### setPagesCount(int pagesCount)
```
public void setPagesCount(int pagesCount)
```

Sets number of pages to convert starting from PageNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagesCount | int |  |

### CommonConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/commonconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IWatermarkedConvertOptions, com.groupdocs.conversion.options.convert.IPagedConvertOptions, com.groupdocs.conversion.options.convert.IPageRangedConvertOptions
```
public abstract class CommonConvertOptions<TFileType> extends ConvertOptions<TFileType> implements IWatermarkedConvertOptions, IPagedConvertOptions, IPageRangedConvertOptions
```

abstract generic common conversion options class.

#### Methods

| Method | Description |
| --- | --- |
| getWatermark() |  |
| setWatermark(WatermarkOptions watermark) |  |
| getPageNumber() |  |
| setPageNumber(int pageNumber) |  |
| getPagesCount() |  |
| setPagesCount(int pagesCount) |  |
| getPages() |  |
| setPages(List<Integer> pages) |  |
##### getWatermark()
```
public WatermarkOptions getWatermark()
```

Gets watermark specific options

**Returns:**
WatermarkOptions
##### setWatermark(WatermarkOptions watermark)
```
public void setWatermark(WatermarkOptions watermark)
```

Sets watermark specific options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | WatermarkOptions |  |

##### getPageNumber()
```
public Integer getPageNumber()
```

Gets the page number to start conversion from.

**Returns:**
java.lang.Integer
##### setPageNumber(int pageNumber)
```
public void setPageNumber(int pageNumber)
```

Sets the page number to start conversion from.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |

##### getPagesCount()
```
public Integer getPagesCount()
```

Gets number of pages to convert starting from PageNumber.

**Returns:**
java.lang.Integer
##### setPagesCount(int pagesCount)
```
public void setPagesCount(int pagesCount)
```

Sets number of pages to convert starting from PageNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagesCount | int |  |

##### getPages()
```
public List<Integer> getPages()
```

Gets The list of page indexes to be converted. Should be specified to convert specific pages.

**Returns:**
java.util.List<java.lang.Integer>
##### setPages(List<Integer> pages)
```
public void setPages(List<Integer> pages)
```

Sets the list of page indexes to be converted. Should be specified to convert specific pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pages | java.util.List<java.lang.Integer> |  |

### ConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/convertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.convert.IConvertOptions, java.lang.Cloneable
```
public abstract class ConvertOptions<TFileType> extends ValueObject implements Serializable, IConvertOptions, Cloneable
```

The general conversion options class.

#### Methods

| Method | Description |
| --- | --- |
| getFormat() | {@inheritDoc}
 |
| setFormat(FileType value) | The desired file type the input document should be converted to.
 |
| deepClone() | Clones current options instance.
 |
| getFormat_ConvertOptions_New() | The desired file type the input document should be converted to.
 |
| setFormat_ConvertOptions_New(TFileType value) | The desired file type the input document should be converted to.
 |
##### getFormat()
```
public FileType getFormat()
```

Gets the desired file type the input document should be converted to.

**Returns:**
FileType
##### setFormat(FileType value)
```
public void setFormat(FileType value)
```

The desired file type the input document should be converted to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### deepClone()
```
public final Object deepClone()
```

Clones current options instance.

**Returns:**
java.lang.Object -
##### getFormat_ConvertOptions_New()
```
public final TFileType getFormat_ConvertOptions_New()
```

The desired file type the input document should be converted to.

**Returns:**
TFileType
##### setFormat_ConvertOptions_New(TFileType value)
```
public final void setFormat_ConvertOptions_New(TFileType value)
```

The desired file type the input document should be converted to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TFileType |  |

### DiagramConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/diagramconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
```
public class DiagramConvertOptions extends CommonConvertOptions<DiagramFileType>
```

Options for conversion to Diagram file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramConvertOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAutoFitPageToDrawingContent() | Defines whether need enlarge page to fit drawing content or not
 |
| setAutoFitPageToDrawingContent(boolean autoFitPageToDrawingContent) | Sets need enlarge page flag
 |
##### DiagramConvertOptions()
```
public DiagramConvertOptions()
```

Initializes new instance of class.

##### isAutoFitPageToDrawingContent()
```
public boolean isAutoFitPageToDrawingContent()
```

Defines whether need enlarge page to fit drawing content or not

**Returns:**
boolean - need enlarge page flag

##### setAutoFitPageToDrawingContent(boolean autoFitPageToDrawingContent)
```
public void setAutoFitPageToDrawingContent(boolean autoFitPageToDrawingContent)
```

Sets need enlarge page flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoFitPageToDrawingContent | boolean | need enlarge page flag
 |

### EBookConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ebookconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions
```
public class EBookConvertOptions extends CommonConvertOptions<EBookFileType> implements IPageSizeConvertOptions, IPageOrientationConvertOptions
```

Options for conversion to EBook file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| EBookConvertOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageSize() |  |
| setPageSize(PageSize pageSize) |  |
| getPageWidth() |  |
| setPageWidth(float pageWidth) |  |
| getPageHeight() |  |
| setPageHeight(float pageHeight) |  |
| getPageOrientation() |  |
| setPageOrientation(PageOrientation pageOrientation) |  |
##### EBookConvertOptions()
```
public EBookConvertOptions()
```

Initializes new instance of class.

##### getPageSize()
```
public PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public float getPageWidth()
```

Specified page width in points if is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public float getPageHeight()
```

Specified page height in points if is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

##### getPageOrientation()
```
public PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

### EmailConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/emailconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public class EmailConvertOptions extends ConvertOptions<EmailFileType> implements Serializable
```

Options for conversion to Email file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailConvertOptions() | Initializes new instance of class.
 |
##### EmailConvertOptions()
```
public EmailConvertOptions()
```

Initializes new instance of class.

### Font
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/font.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class Font extends ValueObject
```

Font settings

#### Constructors

| Constructor | Description |
| --- | --- |
| Font(String fontFamilyName, float size) | creates new Font instance
 |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Fets font family name
 |
| getSize() | Gets font size
 |
| isBold() | Font bold flag
 |
| setBold(boolean bold) | Sets Font bold flag
 |
| isItalic() | Font italic flag
 |
| setItalic(boolean italic) | Sets font italic flag
 |
| isUnderline() | Gets Font underline
 |
| setUnderline(boolean underline) | Sets Font underline
 |
| getDefault() |  |
| clone(float newSize) |  |
##### Font(String fontFamilyName, float size)
```
public Font(String fontFamilyName, float size)
```

creates new Font instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | java.lang.String | Font name
 |
| size | float | Font size
 |

##### getFamilyName()
```
public String getFamilyName()
```

Fets font family name

**Returns:**
java.lang.String - Font family name

##### getSize()
```
public float getSize()
```

Gets font size

**Returns:**
float - Font size

##### isBold()
```
public boolean isBold()
```

Font bold flag

**Returns:**
boolean - true if bold

##### setBold(boolean bold)
```
public void setBold(boolean bold)
```

Sets Font bold flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bold | boolean | true if bold
 |

##### isItalic()
```
public boolean isItalic()
```

Font italic flag

**Returns:**
boolean - true if Italic

##### setItalic(boolean italic)
```
public void setItalic(boolean italic)
```

Sets font italic flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| italic | boolean | true if Italic
 |

##### isUnderline()
```
public boolean isUnderline()
```

Gets Font underline

**Returns:**
boolean - true if Font is underline

##### setUnderline(boolean underline)
```
public void setUnderline(boolean underline)
```

Sets Font underline

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| underline | boolean | Font underline flag
 |

##### getDefault()
```
public static Font getDefault()
```

**Returns:**
Font
##### clone(float newSize)
```
public Font clone(float newSize)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newSize | float |  |

**Returns:**
Font

### FontConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/fontconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions
```
public class FontConvertOptions extends ConvertOptions<FontFileType>
```

Options for conversion to EBook file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| FontConvertOptions() | Initializes new instance of class.
 |
##### FontConvertOptions()
```
public FontConvertOptions()
```

Initializes new instance of class.

### IConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/iconvertoptions.md

### ImageConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/imageconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class ImageConvertOptions extends CommonConvertOptions<ImageFileType> implements Serializable
```

Options for conversion to Image file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageConvertOptions() | Initializes new instance of ImageConvertOptions class.
 |
#### Fields

| Field | Description |
| --- | --- |
| DEFAULT_DPI |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Desired image width after conversion.
 |
| setWidth(int value) | Desired image width after conversion.
 |
| getHeight() | Desired image height after conversion.
 |
| setHeight(int value) | Desired image height after conversion.
 |
| getUsePdf() | If
true
, the input firstly is converted to PDF and after that to desired format.
 |
| setUsePdf(boolean value) | If
true
, the input firstly is converted to PDF and after that to desired format.
 |
| getHorizontalResolution() | Desired image horizontal resolution after conversion.
 |
| setHorizontalResolution(int value) | Desired image horizontal resolution after conversion.
 |
| getVerticalResolution() | Desired image vertical resolution after conversion.
 |
| setVerticalResolution(int value) | Desired image vertical resolution after conversion.
 |
| getTiffOptions() | Tiff specific convert options.
 |
| setTiffOptions(TiffOptions value) | Tiff specific convert options.
 |
| getPsdOptions() | Psd specific convert options.
 |
| setPsdOptions(PsdOptions value) | Psd specific convert options.
 |
| getWebpOptions() | Webp specific convert options.
 |
| setWebpOptions(WebpOptions value) | Webp specific convert options.
 |
| getGrayscale() | Indicates whether to convert into grayscale image.
 |
| setGrayscale(boolean value) | Indicates whether to convert into grayscale image.
 |
| getRotateAngle() | Image rotation angle.
 |
| setRotateAngle(int value) | Image rotation angle.
 |
| getJpegOptions() | Jpeg specific convert options.
 |
| setJpegOptions(JpegOptions value) | Jpeg specific convert options.
 |
| getFlipMode() | Image flip mode.
 |
| setFlipMode(ImageFlipModes value) | Image flip mode.
 |
| getBrightness() | Adjusts image brightness.
 |
| setBrightness(int value) | Adjusts image brightness.
 |
| getContrast() | Adjusts image contrast.
 |
| setContrast(int value) | Adjusts image contrast.
 |
| getGamma() | Adjusts image gamma.
 |
| setGamma(float value) | Adjusts image gamma.
 |
| getBackgroundColor() | Gets background color
 |
| setBackgroundColor(System.Drawing.Color backgroundColor) | Sets background color where supported by the source format
 |
##### ImageConvertOptions()
```
public ImageConvertOptions()
```

Initializes new instance of ImageConvertOptions class.

##### DEFAULT_DPI
```
public static final int DEFAULT_DPI
```

##### getWidth()
```
public final int getWidth()
```

Desired image width after conversion.

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Desired image width after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Desired image height after conversion.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Desired image height after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getUsePdf()
```
public final boolean getUsePdf()
```

If
true
, the input firstly is converted to PDF and after that to desired format.

**Returns:**
boolean
##### setUsePdf(boolean value)
```
public final void setUsePdf(boolean value)
```

If
true
, the input firstly is converted to PDF and after that to desired format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHorizontalResolution()
```
public final int getHorizontalResolution()
```

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Returns:**
int
##### setHorizontalResolution(int value)
```
public final void setHorizontalResolution(int value)
```

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVerticalResolution()
```
public final int getVerticalResolution()
```

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Returns:**
int
##### setVerticalResolution(int value)
```
public final void setVerticalResolution(int value)
```

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTiffOptions()
```
public final TiffOptions getTiffOptions()
```

Tiff specific convert options.

**Returns:**
TiffOptions
##### setTiffOptions(TiffOptions value)
```
public final void setTiffOptions(TiffOptions value)
```

Tiff specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffOptions |  |

##### getPsdOptions()
```
public final PsdOptions getPsdOptions()
```

Psd specific convert options.

**Returns:**
PsdOptions
##### setPsdOptions(PsdOptions value)
```
public final void setPsdOptions(PsdOptions value)
```

Psd specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PsdOptions |  |

##### getWebpOptions()
```
public final WebpOptions getWebpOptions()
```

Webp specific convert options.

**Returns:**
WebpOptions
##### setWebpOptions(WebpOptions value)
```
public final void setWebpOptions(WebpOptions value)
```

Webp specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WebpOptions |  |

##### getGrayscale()
```
public final boolean getGrayscale()
```

Indicates whether to convert into grayscale image.

**Returns:**
boolean
##### setGrayscale(boolean value)
```
public final void setGrayscale(boolean value)
```

Indicates whether to convert into grayscale image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRotateAngle()
```
public final int getRotateAngle()
```

Image rotation angle.

**Returns:**
int
##### setRotateAngle(int value)
```
public final void setRotateAngle(int value)
```

Image rotation angle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getJpegOptions()
```
public final JpegOptions getJpegOptions()
```

Jpeg specific convert options.

**Returns:**
JpegOptions
##### setJpegOptions(JpegOptions value)
```
public final void setJpegOptions(JpegOptions value)
```

Jpeg specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | JpegOptions |  |

##### getFlipMode()
```
public final ImageFlipModes getFlipMode()
```

Image flip mode.

**Returns:**
ImageFlipModes
##### setFlipMode(ImageFlipModes value)
```
public final void setFlipMode(ImageFlipModes value)
```

Image flip mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ImageFlipModes |  |

##### getBrightness()
```
public final int getBrightness()
```

Adjusts image brightness.

**Returns:**
int
##### setBrightness(int value)
```
public final void setBrightness(int value)
```

Adjusts image brightness.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getContrast()
```
public final int getContrast()
```

Adjusts image contrast.

**Returns:**
int
##### setContrast(int value)
```
public final void setContrast(int value)
```

Adjusts image contrast.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getGamma()
```
public final float getGamma()
```

Adjusts image gamma.

**Returns:**
float
##### setGamma(float value)
```
public final void setGamma(float value)
```

Adjusts image gamma.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getBackgroundColor()
```
public System.Drawing.Color getBackgroundColor()
```

Gets background color

**Returns:**
com.aspose.ms.System.Drawing.Color - background color

##### setBackgroundColor(System.Drawing.Color backgroundColor)
```
public void setBackgroundColor(System.Drawing.Color backgroundColor)
```

Sets background color where supported by the source format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | com.aspose.ms.System.Drawing.Color | background color
 |

### ImageFlipModes
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/imageflipmodes.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class ImageFlipModes extends Enumeration implements Serializable
```

Describes image flip modes.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageFlipModes() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| None | No flipping.
 |
| FlipX | Horizontal flip.
 |
| FlipY | Flip vertical.
 |
| FlipXY | Flip horizontal and vertical.
 |
##### ImageFlipModes()
```
public ImageFlipModes()
```

Serialization constructor

##### None
```
public static final ImageFlipModes None
```

No flipping.

##### FlipX
```
public static final ImageFlipModes FlipX
```

Horizontal flip.

##### FlipY
```
public static final ImageFlipModes FlipY
```

Flip vertical.

##### FlipXY
```
public static final ImageFlipModes FlipXY
```

Flip horizontal and vertical.

### IPagedConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipagedconvertoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IPagedConvertOptions extends IConvertOptions
```

Represents convert options that allows conversion to perform page limitation by specifying start page and pages count

#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets the page number to start conversion from.
 |
| setPageNumber(int pageNumber) | Sets the page number to start conversion from.
 |
| getPagesCount() | Gets number of pages to convert starting from PageNumber.
 |
| setPagesCount(int pagesCount) | Sets number of pages to convert starting from PageNumber.
 |
##### getPageNumber()
```
public abstract Integer getPageNumber()
```

Gets the page number to start conversion from.

**Returns:**
java.lang.Integer - The page number to start conversion from.

##### setPageNumber(int pageNumber)
```
public abstract void setPageNumber(int pageNumber)
```

Sets the page number to start conversion from.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The page number to start conversion from.
 |

##### getPagesCount()
```
public abstract Integer getPagesCount()
```

Gets number of pages to convert starting from PageNumber.

**Returns:**
java.lang.Integer - Number of pages to convert starting from PageNumber.

##### setPagesCount(int pagesCount)
```
public abstract void setPagesCount(int pagesCount)
```

Sets number of pages to convert starting from PageNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagesCount | int | Number of pages to convert starting from PageNumber.
 |

### IPageMarginConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipagemarginconvertoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IPageMarginConvertOptions extends IConvertOptions
```

Represents convert options that support page margins

#### Methods

| Method | Description |
| --- | --- |
| getMarginTop() | Gets desired page top margin in points after conversion.
 |
| setMarginTop(float marginTop) | Sets desired page top margin in points after conversion.
 |
| getMarginBottom() | Gets desired page bottom margin in points after conversion.
 |
| setMarginBottom(float marginBottom) | Sets desired page bottom margin in points after conversion.
 |
| getMarginLeft() | Gets desired page left margin in points after conversion.
 |
| setMarginLeft(float marginLeft) | Sets desired page left margin in points after conversion.
 |
| getMarginRight() | Gets desired page right margin in points after conversion.
 |
| setMarginRight(float marginRight) | Sets desired page right margin in points after conversion.
 |
##### getMarginTop()
```
public abstract float getMarginTop()
```

Gets desired page top margin in points after conversion.

**Returns:**
float
##### setMarginTop(float marginTop)
```
public abstract void setMarginTop(float marginTop)
```

Sets desired page top margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| marginTop | float |  |

##### getMarginBottom()
```
public abstract float getMarginBottom()
```

Gets desired page bottom margin in points after conversion.

**Returns:**
float
##### setMarginBottom(float marginBottom)
```
public abstract void setMarginBottom(float marginBottom)
```

Sets desired page bottom margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| marginBottom | float |  |

##### getMarginLeft()
```
public abstract float getMarginLeft()
```

Gets desired page left margin in points after conversion.

**Returns:**
float
##### setMarginLeft(float marginLeft)
```
public abstract void setMarginLeft(float marginLeft)
```

Sets desired page left margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| marginLeft | float |  |

##### getMarginRight()
```
public abstract float getMarginRight()
```

Gets desired page right margin in points after conversion.

**Returns:**
float
##### setMarginRight(float marginRight)
```
public abstract void setMarginRight(float marginRight)
```

Sets desired page right margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| marginRight | float |  |

### IPageOrientationConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipageorientationconvertoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IPageOrientationConvertOptions extends IConvertOptions
```

Represents convert options that support page orientation

#### Methods

| Method | Description |
| --- | --- |
| getPageOrientation() | Gets page orientation after conversion
 |
| setPageOrientation(PageOrientation pageOrientation) | Sets desired page orientation after conversion
 |
##### getPageOrientation()
```
public abstract PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public abstract void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

### IPageRangedConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipagerangedconvertoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IPageRangedConvertOptions extends IConvertOptions
```

Represents convert options that support conversion of specific list of pages

#### Methods

| Method | Description |
| --- | --- |
| getPages() | Gets The list of page indexes to be converted.
 |
| setPages(List<Integer> pages) | Sets the list of page indexes to be converted.
 |
##### getPages()
```
public abstract List<Integer> getPages()
```

Gets The list of page indexes to be converted. Should be specified to convert specific pages.

**Returns:**
java.util.List<java.lang.Integer> - The list of page indexes to be converted. Should be specified to convert specific pages.

##### setPages(List<Integer> pages)
```
public abstract void setPages(List<Integer> pages)
```

Sets the list of page indexes to be converted. Should be specified to convert specific pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pages | java.util.List<java.lang.Integer> | The list of page indexes to be converted. Should be specified to convert specific pages.
 |

### IPageSize
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipagesize.md

### IPageSizeConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipagesizeconvertoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IPageSizeConvertOptions extends IConvertOptions
```

Represents convert options that support page size

#### Methods

| Method | Description |
| --- | --- |
| getPageSize() | Gets desired page size after conversion
 |
| setPageSize(PageSize pageSize) | Set desired page size after conversion
 |
| getPageWidth() | Specified page width in points if is set to PageSize.Custom
 |
| setPageWidth(float pageWidth) | Set desired page width
 |
| getPageHeight() | Specified page height in points if is set to PageSize.Custom
 |
| setPageHeight(float pageHeight) | Set desired page height
 |
##### getPageSize()
```
public abstract PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public abstract void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public abstract float getPageWidth()
```

Specified page width in points if is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public abstract void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public abstract float getPageHeight()
```

Specified page height in points if is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public abstract void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

### IPdfRecognitionModeOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/ipdfrecognitionmodeoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IPdfRecognitionModeOptions extends IConvertOptions
```

Represents convert options that control recognition mode when converting from PDF

#### Methods

| Method | Description |
| --- | --- |
| getPdfRecognitionMode() | Gets recognition mode when converting from pdf
 |
| setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode) | Sets recognition mode when converting from pdf
 |
##### getPdfRecognitionMode()
```
public abstract PdfRecognitionMode getPdfRecognitionMode()
```

Gets recognition mode when converting from pdf

**Returns:**
PdfRecognitionMode
##### setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)
```
public abstract void setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)
```

Sets recognition mode when converting from pdf

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfRecognitionMode | PdfRecognitionMode |  |

### IWatermarkedConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/iwatermarkedconvertoptions.md

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IConvertOptions
```
public interface IWatermarkedConvertOptions extends IConvertOptions
```

Represents convert options that allow output of conversion to be watermarked

#### Methods

| Method | Description |
| --- | --- |
| getWatermark() | Gets watermark specific options
 |
| setWatermark(WatermarkOptions watermark) | Sets watermark specific options
 |
##### getWatermark()
```
public abstract WatermarkOptions getWatermark()
```

Gets watermark specific options

**Returns:**
WatermarkOptions - Watermark specific options

##### setWatermark(WatermarkOptions watermark)
```
public abstract void setWatermark(WatermarkOptions watermark)
```

Sets watermark specific options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | WatermarkOptions | Watermark specific options
 |

### JpegOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/jpegoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class JpegOptions extends ValueObject implements Serializable
```

Options for conversion to Jpeg file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| JpegOptions() | Initializes new instance of JpegOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getQuality() | Desired image quality.
 |
| setQuality(int value) | Desired image quality.
 |
| getColorMode() | Jpg color mode.
 |
| setColorMode(JpgColorModes value) | Jpg color mode.
 |
| getCompression() | Jpg compression method.
 |
| setCompression(JpgCompressionMethods value) | Jpg compression method.
 |
##### JpegOptions()
```
public JpegOptions()
```

Initializes new instance of JpegOptions class.

##### getQuality()
```
public final int getQuality()
```

Desired image quality. The value must be between 0 and 100. The default value is 100.

**Returns:**
int
##### setQuality(int value)
```
public final void setQuality(int value)
```

Desired image quality. The value must be between 0 and 100. The default value is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getColorMode()
```
public final JpgColorModes getColorMode()
```

Jpg color mode.

**Returns:**
JpgColorModes
##### setColorMode(JpgColorModes value)
```
public final void setColorMode(JpgColorModes value)
```

Jpg color mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | JpgColorModes |  |

##### getCompression()
```
public final JpgCompressionMethods getCompression()
```

Jpg compression method.

**Returns:**
JpgCompressionMethods
##### setCompression(JpgCompressionMethods value)
```
public final void setCompression(JpgCompressionMethods value)
```

Jpg compression method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | JpgCompressionMethods |  |

### JpgColorModes
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/jpgcolormodes.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class JpgColorModes extends Enumeration implements Serializable
```

Describes Jpg color modes enumeration.

#### Constructors

| Constructor | Description |
| --- | --- |
| JpgColorModes() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| YCbCr | YCbCr image.
 |
| Rgb | RGB.
 |
| Cmyk | CMYK.
 |
| Ycck | Ycck.
 |
| Grayscale | Grayscale.
 |
##### JpgColorModes()
```
public JpgColorModes()
```

Serialization constructor

##### YCbCr
```
public static final JpgColorModes YCbCr
```

YCbCr image. Standard option for jpeg images.

##### Rgb
```
public static final JpgColorModes Rgb
```

RGB.

##### Cmyk
```
public static final JpgColorModes Cmyk
```

CMYK.

##### Ycck
```
public static final JpgColorModes Ycck
```

Ycck.

##### Grayscale
```
public static final JpgColorModes Grayscale
```

Grayscale.

### JpgCompressionMethods
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/jpgcompressionmethods.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class JpgCompressionMethods extends Enumeration implements Serializable
```

Describes Jpg compression modes

#### Constructors

| Constructor | Description |
| --- | --- |
| JpgCompressionMethods() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Baseline | The baseline compression.
 |
| Progressive | Progressive compression.
 |
| Lossless | Lossless compression.
 |
| JpegLs | JpegLs compression.
 |
##### JpgCompressionMethods()
```
public JpgCompressionMethods()
```

Serialization constructor

##### Baseline
```
public static final JpgCompressionMethods Baseline
```

The baseline compression.

##### Progressive
```
public static final JpgCompressionMethods Progressive
```

Progressive compression.

##### Lossless
```
public static final JpgCompressionMethods Lossless
```

Lossless compression.

##### JpegLs
```
public static final JpgCompressionMethods JpegLs
```

JpegLs compression.

### NoConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/noconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions
```
public class NoConvertOptions extends ConvertOptions<FileType>
```

Special convert option class, which instructs converter to copy source document without any processing

#### Constructors

| Constructor | Description |
| --- | --- |
| NoConvertOptions() |  |
##### NoConvertOptions()
```
public NoConvertOptions()
```

### PageDescriptionLanguageConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
```
public class PageDescriptionLanguageConvertOptions extends CommonConvertOptions<PageDescriptionLanguageFileType>
```

Options for conversion to page descriptions language file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageDescriptionLanguageConvertOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Desired page width after conversion.
 |
| setWidth(int width) |  |
| getHeight() | Desired page height after conversion.
 |
| setHeight(int height) |  |
##### PageDescriptionLanguageConvertOptions()
```
public PageDescriptionLanguageConvertOptions()
```

Initializes new instance of class.

##### getWidth()
```
public int getWidth()
```

Desired page width after conversion.

**Returns:**
int
##### setWidth(int width)
```
public void setWidth(int width)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int |  |

##### getHeight()
```
public int getHeight()
```

Desired page height after conversion.

**Returns:**
int
##### setHeight(int height)
```
public void setHeight(int height)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int |  |

### PageOrientation
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pageorientation.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PageOrientation extends Enum<PageOrientation>
```
#### Fields

| Field | Description |
| --- | --- |
| LANDSCAPE |  |
| PORTRAIT |  |
| DEFAULT |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getKey() |  |
| getName() |  |
##### LANDSCAPE
```
public static final PageOrientation LANDSCAPE
```

##### PORTRAIT
```
public static final PageOrientation PORTRAIT
```

##### DEFAULT
```
public static final PageOrientation DEFAULT
```

##### values()
```
public static PageOrientation[] values()
```

**Returns:**
com.groupdocs.conversion.options.convert.PageOrientation[]
##### valueOf(String name)
```
public static PageOrientation valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageOrientation
##### getKey()
```
public String getKey()
```

**Returns:**
java.lang.String
##### getName()
```
public String getName()
```

**Returns:**
java.lang.String

### PageSize
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pagesize.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IPageSize
```
public enum PageSize extends Enum<PageSize> implements IPageSize
```
#### Fields

| Field | Description |
| --- | --- |
| A3 |  |
| A4 |  |
| A5 |  |
| B4 |  |
| B5 |  |
| CUSTOM |  |
| ENVELOPE_DL |  |
| EXECUTIVE |  |
| FOLIO |  |
| LEDGER |  |
| LEGAL |  |
| LETTER |  |
| PAPER_10_X_14 |  |
| PAPER_11_X_17 |  |
| QUARTO |  |
| STATEMENT |  |
| TABLOID |  |
| UNSET |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| createCustom(float width, float height) |  |
| getKey() |  |
| getName() |  |
| getWidth() |  |
| getHeight() |  |
| pointsToPixels(float points, int dpi) |  |
| pixelsToPoints(int pixels, int dpi) |  |
##### A3
```
public static final PageSize A3
```

##### A4
```
public static final PageSize A4
```

##### A5
```
public static final PageSize A5
```

##### B4
```
public static final PageSize B4
```

##### B5
```
public static final PageSize B5
```

##### CUSTOM
```
public static final PageSize CUSTOM
```

##### ENVELOPE_DL
```
public static final PageSize ENVELOPE_DL
```

##### EXECUTIVE
```
public static final PageSize EXECUTIVE
```

##### FOLIO
```
public static final PageSize FOLIO
```

##### LEDGER
```
public static final PageSize LEDGER
```

##### LEGAL
```
public static final PageSize LEGAL
```

##### LETTER
```
public static final PageSize LETTER
```

##### PAPER_10_X_14
```
public static final PageSize PAPER_10_X_14
```

##### PAPER_11_X_17
```
public static final PageSize PAPER_11_X_17
```

##### QUARTO
```
public static final PageSize QUARTO
```

##### STATEMENT
```
public static final PageSize STATEMENT
```

##### TABLOID
```
public static final PageSize TABLOID
```

##### UNSET
```
public static final PageSize UNSET
```

##### values()
```
public static PageSize[] values()
```

**Returns:**
com.groupdocs.conversion.options.convert.PageSize[]
##### valueOf(String name)
```
public static PageSize valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageSize
##### createCustom(float width, float height)
```
public static PageSize.PageSizeCustom createCustom(float width, float height)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | float |  |
| height | float |  |

**Returns:**
PageSizeCustom
##### getKey()
```
public String getKey()
```

**Returns:**
java.lang.String
##### getName()
```
public String getName()
```

**Returns:**
java.lang.String
##### getWidth()
```
public double getWidth()
```

**Returns:**
double
##### getHeight()
```
public double getHeight()
```

**Returns:**
double
##### pointsToPixels(float points, int dpi)
```
public static int pointsToPixels(float points, int dpi)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| points | float |  |
| dpi | int |  |

**Returns:**
int
##### pixelsToPoints(int pixels, int dpi)
```
public static float pixelsToPoints(int pixels, int dpi)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pixels | int |  |
| dpi | int |  |

**Returns:**
float

### PdfConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.convert.IPageMarginConvertOptions, com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions
```
public class PdfConvertOptions extends CommonConvertOptions<PdfFileType> implements Serializable, IPageMarginConvertOptions, IPageSizeConvertOptions, IPageOrientationConvertOptions
```

Options for conversion to Pdf file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfConvertOptions() | Initializes new instance of PdfConvertOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDpi() | Desired page DPI after conversion.
 |
| setDpi(int value) | Desired page DPI after conversion.
 |
| getPassword() | Set this property if you want to protect the converted document with a password.
 |
| setPassword(String value) | Set this property if you want to protect the converted document with a password.
 |
| getMarginTop() | Desired page top margin in points after conversion.
 |
| setMarginTop(float value) | Desired page top margin in points after conversion.
 |
| getMarginBottom() | Desired page bottom margin in points after conversion.
 |
| setMarginBottom(float value) | Desired page bottom margin in points after conversion.
 |
| getMarginLeft() | Desired page left margin in points after conversion.
 |
| setMarginLeft(float value) | Desired page left margin in points after conversion.
 |
| getMarginRight() | Desired page right margin in points after conversion.
 |
| setMarginRight(float value) | Desired page right margin in points after conversion.
 |
| getPdfOptions() | Pdf specific convert options
 |
| setPdfOptions(PdfOptions value) | Pdf specific convert options
 |
| getRotate() | Page rotation
 |
| setRotate(Rotation value) | Page rotation
 |
| getPageOrientation() |  |
| setPageOrientation(PageOrientation pageOrientation) |  |
| getPageSize() |  |
| setPageSize(PageSize pageSize) |  |
| getPageWidth() |  |
| setPageWidth(float pageWidth) |  |
| getPageHeight() |  |
| setPageHeight(float pageHeight) |  |
##### PdfConvertOptions()
```
public PdfConvertOptions()
```

Initializes new instance of PdfConvertOptions class.

##### getDpi()
```
public final int getDpi()
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Returns:**
int
##### setDpi(int value)
```
public final void setDpi(int value)
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMarginTop()
```
public final float getMarginTop()
```

Desired page top margin in points after conversion.

**Returns:**
float
##### setMarginTop(float value)
```
public final void setMarginTop(float value)
```

Desired page top margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getMarginBottom()
```
public final float getMarginBottom()
```

Desired page bottom margin in points after conversion.

**Returns:**
float
##### setMarginBottom(float value)
```
public final void setMarginBottom(float value)
```

Desired page bottom margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getMarginLeft()
```
public final float getMarginLeft()
```

Desired page left margin in points after conversion.

**Returns:**
float
##### setMarginLeft(float value)
```
public final void setMarginLeft(float value)
```

Desired page left margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getMarginRight()
```
public final float getMarginRight()
```

Desired page right margin in points after conversion.

**Returns:**
float
##### setMarginRight(float value)
```
public final void setMarginRight(float value)
```

Desired page right margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getPdfOptions()
```
public final PdfOptions getPdfOptions()
```

Pdf specific convert options

**Returns:**
PdfOptions
##### setPdfOptions(PdfOptions value)
```
public final void setPdfOptions(PdfOptions value)
```

Pdf specific convert options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfOptions |  |

##### getRotate()
```
public final Rotation getRotate()
```

Page rotation

**Returns:**
Rotation
##### setRotate(Rotation value)
```
public final void setRotate(Rotation value)
```

Page rotation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rotation |  |

##### getPageOrientation()
```
public PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

##### getPageSize()
```
public PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public float getPageWidth()
```

Specified page width in points if is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public float getPageHeight()
```

Specified page height in points if is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

### PdfDirection
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfdirection.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PdfDirection extends Enumeration implements Serializable
```

Describes Pdf text direction.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDirection() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| L2R | Left to right.
 |
| R2L | Right to left.
 |
##### PdfDirection()
```
public PdfDirection()
```

Serialization constructor

##### L2R
```
public static final PdfDirection L2R
```

Left to right.

##### R2L
```
public static final PdfDirection R2L
```

Right to left.

### PdfFormats
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfFormats extends Enumeration implements Serializable
```

Describes Pdf formats enumeration.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFormats() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Default | Default pdf format
 |
| PdfA_1A | PDF/A-1a \\u2013 Level A (accessible) conformance.
 |
| PdfA_1B | PDF/A-1b \\u2013 Level B (basic) conformance.
 |
| PdfA_2A | PDF/A-2a conformance.
 |
| PdfA_3A | PDF/A-3a conformance.
 |
| PdfA_2B | PDF/A-2b conformance.
 |
| PdfA_2U | PDF/A-2u conformance.
 |
| PdfA_3B | PDF/A-3b conformance.
 |
| PdfA_3U | PDF/A-3u conformance.
 |
| v1_3 | PDF version 1.3.
 |
| v1_4 | PDF version 1.4.
 |
| v1_5 | PDF version 1.5.
 |
| v1_6 | PDF version 1.6.
 |
| v1_7 | PDF version 1.7.
 |
| PdfX_1A | PDF/X-1a conformance.
 |
| PdfX_3 | PDF/X-3 conformance.
 |
| PdfUA_1 | PDF/UA-1 conformance.
 |
##### PdfFormats()
```
public PdfFormats()
```

Serialization constructor

##### Default
```
public static final PdfFormats Default
```

Default pdf format

##### PdfA_1A
```
public static final PdfFormats PdfA_1A
```

PDF/A-1a \\u2013 Level A (accessible) conformance.

##### PdfA_1B
```
public static final PdfFormats PdfA_1B
```

PDF/A-1b \\u2013 Level B (basic) conformance.

##### PdfA_2A
```
public static final PdfFormats PdfA_2A
```

PDF/A-2a conformance.

##### PdfA_3A
```
public static final PdfFormats PdfA_3A
```

PDF/A-3a conformance.

##### PdfA_2B
```
public static final PdfFormats PdfA_2B
```

PDF/A-2b conformance.

##### PdfA_2U
```
public static final PdfFormats PdfA_2U
```

PDF/A-2u conformance.

##### PdfA_3B
```
public static final PdfFormats PdfA_3B
```

PDF/A-3b conformance.

##### PdfA_3U
```
public static final PdfFormats PdfA_3U
```

PDF/A-3u conformance.

##### v1_3
```
public static final PdfFormats v1_3
```

PDF version 1.3.

##### v1_4
```
public static final PdfFormats v1_4
```

PDF version 1.4.

##### v1_5
```
public static final PdfFormats v1_5
```

PDF version 1.5.

##### v1_6
```
public static final PdfFormats v1_6
```

PDF version 1.6.

##### v1_7
```
public static final PdfFormats v1_7
```

PDF version 1.7.

##### PdfX_1A
```
public static final PdfFormats PdfX_1A
```

PDF/X-1a conformance.

##### PdfX_3
```
public static final PdfFormats PdfX_3
```

PDF/X-3 conformance.

##### PdfUA_1
```
public static final PdfFormats PdfUA_1
```

PDF/UA-1 conformance.

### PdfFormattingOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfformattingoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfFormattingOptions extends ValueObject implements Serializable
```

Defines Pdf formatting options.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFormattingOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getCenterWindow() | Specifies whether position of the document's window will be centered on the screen.
 |
| setCenterWindow(boolean value) | Specifies whether position of the document's window will be centered on the screen.
 |
| getDirection() | Sets reading order of text: L2R (left to right) or R2L (right to left).
 |
| setDirection(PdfDirection value) | Sets reading order of text: L2R (left to right) or R2L (right to left).
 |
| getDisplayDocTitle() | Specifies whether document's window title bar should display document title.
 |
| setDisplayDocTitle(boolean value) | Specifies whether document's window title bar should display document title.
 |
| getFitWindow() | Specifies whether document window must be resized to fit the first displayed page.
 |
| setFitWindow(boolean value) | Specifies whether document window must be resized to fit the first displayed page.
 |
| getHideMenuBar() | Specifies whether menu bar should be hidden when document is active.
 |
| setHideMenuBar(boolean value) | Specifies whether menu bar should be hidden when document is active.
 |
| getHideToolBar() | Specifies whether toolbar should be hidden when document is active.
 |
| setHideToolBar(boolean value) | Specifies whether toolbar should be hidden when document is active.
 |
| getHideWindowUI() | Specifies whether user interface elements should be hidden when document is active.
 |
| setHideWindowUI(boolean value) | Specifies whether user interface elements should be hidden when document is active.
 |
| getNonFullScreenPageMode() | Sets page mode, specifying how to display the document on exiting full-screen mode.
 |
| setNonFullScreenPageMode(PdfPageMode value) | Sets page mode, specifying how to display the document on exiting full-screen mode.
 |
| getPageLayout() | Sets page layout which shall be used when the document is opened.
 |
| setPageLayout(PdfPageLayout value) | Sets page layout which shall be used when the document is opened.
 |
| getPageMode() | Sets page mode, specifying how document should be displayed when opened.
 |
| setPageMode(PdfPageMode value) | Sets page mode, specifying how document should be displayed when opened.
 |
##### PdfFormattingOptions()
```
public PdfFormattingOptions()
```

##### getCenterWindow()
```
public final boolean getCenterWindow()
```

Specifies whether position of the document's window will be centered on the screen. Default: false.

**Returns:**
boolean
##### setCenterWindow(boolean value)
```
public final void setCenterWindow(boolean value)
```

Specifies whether position of the document's window will be centered on the screen. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDirection()
```
public final PdfDirection getDirection()
```

Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.

**Returns:**
PdfDirection
##### setDirection(PdfDirection value)
```
public final void setDirection(PdfDirection value)
```

Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfDirection |  |

##### getDisplayDocTitle()
```
public final boolean getDisplayDocTitle()
```

Specifies whether document's window title bar should display document title. Default: false.

**Returns:**
boolean
##### setDisplayDocTitle(boolean value)
```
public final void setDisplayDocTitle(boolean value)
```

Specifies whether document's window title bar should display document title. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFitWindow()
```
public final boolean getFitWindow()
```

Specifies whether document window must be resized to fit the first displayed page. Default: false.

**Returns:**
boolean
##### setFitWindow(boolean value)
```
public final void setFitWindow(boolean value)
```

Specifies whether document window must be resized to fit the first displayed page. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHideMenuBar()
```
public final boolean getHideMenuBar()
```

Specifies whether menu bar should be hidden when document is active. Default: false.

**Returns:**
boolean
##### setHideMenuBar(boolean value)
```
public final void setHideMenuBar(boolean value)
```

Specifies whether menu bar should be hidden when document is active. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHideToolBar()
```
public final boolean getHideToolBar()
```

Specifies whether toolbar should be hidden when document is active. Default: false.

**Returns:**
boolean
##### setHideToolBar(boolean value)
```
public final void setHideToolBar(boolean value)
```

Specifies whether toolbar should be hidden when document is active. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHideWindowUI()
```
public final boolean getHideWindowUI()
```

Specifies whether user interface elements should be hidden when document is active. Default: false.

**Returns:**
boolean
##### setHideWindowUI(boolean value)
```
public final void setHideWindowUI(boolean value)
```

Specifies whether user interface elements should be hidden when document is active. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getNonFullScreenPageMode()
```
public final PdfPageMode getNonFullScreenPageMode()
```

Sets page mode, specifying how to display the document on exiting full-screen mode.

**Returns:**
PdfPageMode
##### setNonFullScreenPageMode(PdfPageMode value)
```
public final void setNonFullScreenPageMode(PdfPageMode value)
```

Sets page mode, specifying how to display the document on exiting full-screen mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfPageMode |  |

##### getPageLayout()
```
public final PdfPageLayout getPageLayout()
```

Sets page layout which shall be used when the document is opened.

**Returns:**
PdfPageLayout
##### setPageLayout(PdfPageLayout value)
```
public final void setPageLayout(PdfPageLayout value)
```

Sets page layout which shall be used when the document is opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfPageLayout |  |

##### getPageMode()
```
public final PdfPageMode getPageMode()
```

Sets page mode, specifying how document should be displayed when opened.

**Returns:**
PdfPageMode
##### setPageMode(PdfPageMode value)
```
public final void setPageMode(PdfPageMode value)
```

Sets page mode, specifying how document should be displayed when opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfPageMode |  |

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfoptimizationoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfOptimizationOptions extends ValueObject implements Serializable
```

Defines Pdf optimization options.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptimizationOptions() | Initializes new instance of PdfOptimizationOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLinkDuplicateStreams() | Link duplicate streams
 |
| setLinkDuplicateStreams(boolean value) | Link duplicate streams
 |
| getRemoveUnusedObjects() | Remove unused objects
 |
| setRemoveUnusedObjects(boolean value) | Remove unused objects
 |
| getRemoveUnusedStreams() | Remove unused streams
 |
| setRemoveUnusedStreams(boolean value) | Remove unused streams
 |
| getCompressImages() | If CompressImages set to
true
, all images in the document are recompressed.
 |
| setCompressImages(boolean value) | If CompressImages set to
true
, all images in the document are recompressed.
 |
| getImageQuality() | Value in percent where 100% is unchanged quality and image size.
 |
| setImageQuality(int value) | Value in percent where 100% is unchanged quality and image size.
 |
| getUnembedFonts() | Make fonts not embedded if set to true
 |
| setUnembedFonts(boolean value) | Make fonts not embedded if set to true
 |
| getFontSubsetStrategy() |  |
| setFontSubsetStrategy(PdfFontSubsetStrategy fontSubsetStrategy) | Set font subset strategy
 |
##### PdfOptimizationOptions()
```
public PdfOptimizationOptions()
```

Initializes new instance of PdfOptimizationOptions class.

##### getLinkDuplicateStreams()
```
public final boolean getLinkDuplicateStreams()
```

Link duplicate streams

**Returns:**
boolean
##### setLinkDuplicateStreams(boolean value)
```
public final void setLinkDuplicateStreams(boolean value)
```

Link duplicate streams

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRemoveUnusedObjects()
```
public final boolean getRemoveUnusedObjects()
```

Remove unused objects

**Returns:**
boolean
##### setRemoveUnusedObjects(boolean value)
```
public final void setRemoveUnusedObjects(boolean value)
```

Remove unused objects

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRemoveUnusedStreams()
```
public final boolean getRemoveUnusedStreams()
```

Remove unused streams

**Returns:**
boolean
##### setRemoveUnusedStreams(boolean value)
```
public final void setRemoveUnusedStreams(boolean value)
```

Remove unused streams

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getCompressImages()
```
public final boolean getCompressImages()
```

If CompressImages set to
true
, all images in the document are recompressed. The compression is defined by the ImageQuality property.

**Returns:**
boolean
##### setCompressImages(boolean value)
```
public final void setCompressImages(boolean value)
```

If CompressImages set to
true
, all images in the document are recompressed. The compression is defined by the ImageQuality property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getImageQuality()
```
public final int getImageQuality()
```

Value in percent where 100% is unchanged quality and image size. To decrease the image size set this property to less than 100

**Returns:**
int
##### setImageQuality(int value)
```
public final void setImageQuality(int value)
```

Value in percent where 100% is unchanged quality and image size. To decrease the image size set this property to less than 100

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getUnembedFonts()
```
public final boolean getUnembedFonts()
```

Make fonts not embedded if set to true

**Returns:**
boolean
##### setUnembedFonts(boolean value)
```
public final void setUnembedFonts(boolean value)
```

Make fonts not embedded if set to true

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFontSubsetStrategy()
```
public PdfFontSubsetStrategy getFontSubsetStrategy()
```

**Returns:**
PdfFontSubsetStrategy
##### setFontSubsetStrategy(PdfFontSubsetStrategy fontSubsetStrategy)
```
public void setFontSubsetStrategy(PdfFontSubsetStrategy fontSubsetStrategy)
```

Set font subset strategy

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontSubsetStrategy | PdfFontSubsetStrategy |  |

### PdfOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfOptions extends ValueObject implements Serializable
```

Options for conversion to Pdf file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptions() | ctor
 |
#### Methods

| Method | Description |
| --- | --- |
| getPdfFormat() | Sets the pdf format of the converted document.
 |
| setPdfFormat(PdfFormats value) | Sets the pdf format of the converted document.
 |
| getRemovePdfACompliance() | Removes Pdf-A Compliance
 |
| setRemovePdfACompliance(boolean value) | Removes Pdf-A Compliance
 |
| getZoom() | Specifies the zoom level in percentage.
 |
| setZoom(int value) | Specifies the zoom level in percentage.
 |
| getLinearize() | Linearizes PDF Document for the Web
 |
| setLinearize(boolean value) | Linearizes PDF Document for the Web
 |
| getOptimizationOptions() | Pdf optimization options
 |
| setOptimizationOptions(PdfOptimizationOptions value) | Pdf optimization options
 |
| getGrayscale() | Convert a PDF from RGB colorspace to grayscale
 |
| setGrayscale(boolean value) | Convert a PDF from RGB colorspace to grayscale
 |
| getFormattingOptions() | Pdf formatting options
 |
| setFormattingOptions(PdfFormattingOptions value) | Pdf formatting options
 |
| getDocumentInfo() | Meta information of PDF document.
 |
| setDocumentInfo(PdfDocumentInfo documentInfo) |  |
##### PdfOptions()
```
public PdfOptions()
```

ctor

##### getPdfFormat()
```
public final PdfFormats getPdfFormat()
```

Sets the pdf format of the converted document.

**Returns:**
PdfFormats
##### setPdfFormat(PdfFormats value)
```
public final void setPdfFormat(PdfFormats value)
```

Sets the pdf format of the converted document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfFormats |  |

##### getRemovePdfACompliance()
```
public final boolean getRemovePdfACompliance()
```

Removes Pdf-A Compliance

**Returns:**
boolean
##### setRemovePdfACompliance(boolean value)
```
public final void setRemovePdfACompliance(boolean value)
```

Removes Pdf-A Compliance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLinearize()
```
public final boolean getLinearize()
```

Linearizes PDF Document for the Web

**Returns:**
boolean
##### setLinearize(boolean value)
```
public final void setLinearize(boolean value)
```

Linearizes PDF Document for the Web

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOptimizationOptions()
```
public final PdfOptimizationOptions getOptimizationOptions()
```

Pdf optimization options

**Returns:**
PdfOptimizationOptions
##### setOptimizationOptions(PdfOptimizationOptions value)
```
public final void setOptimizationOptions(PdfOptimizationOptions value)
```

Pdf optimization options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfOptimizationOptions |  |

##### getGrayscale()
```
public final boolean getGrayscale()
```

Convert a PDF from RGB colorspace to grayscale

**Returns:**
boolean
##### setGrayscale(boolean value)
```
public final void setGrayscale(boolean value)
```

Convert a PDF from RGB colorspace to grayscale

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFormattingOptions()
```
public final PdfFormattingOptions getFormattingOptions()
```

Pdf formatting options

**Returns:**
PdfFormattingOptions
##### setFormattingOptions(PdfFormattingOptions value)
```
public final void setFormattingOptions(PdfFormattingOptions value)
```

Pdf formatting options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfFormattingOptions |  |

##### getDocumentInfo()
```
public PdfDocumentInfo getDocumentInfo()
```

Meta information of PDF document.

**Returns:**
PdfDocumentInfo
##### setDocumentInfo(PdfDocumentInfo documentInfo)
```
public void setDocumentInfo(PdfDocumentInfo documentInfo)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | PdfDocumentInfo |  |

### PdfPageLayout
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfpagelayout.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PdfPageLayout extends Enumeration implements Serializable
```

Describes Pdf page layout.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfPageLayout() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Default | Default layout.
 |
| SinglePage | Single page.
 |
| OneColumn | Display pages in one column.
 |
| TwoColumnLeft | Display the pages in two columns, with odd-numbered pages on the left.
 |
| TwoColumnRight | Display the pages in two columns, with odd-numbered pages on the right.
 |
| TwoPagesLeft | Display the pages two at a time, with odd-numbered pages on the left.
 |
| TwoPagesRight | Display the pages two at a time, with odd-numbered pages on the right.
 |
##### PdfPageLayout()
```
public PdfPageLayout()
```

Serialization constructor

##### Default
```
public static final PdfPageLayout Default
```

Default layout.

##### SinglePage
```
public static final PdfPageLayout SinglePage
```

Single page.

##### OneColumn
```
public static final PdfPageLayout OneColumn
```

Display pages in one column.

##### TwoColumnLeft
```
public static final PdfPageLayout TwoColumnLeft
```

Display the pages in two columns, with odd-numbered pages on the left.

##### TwoColumnRight
```
public static final PdfPageLayout TwoColumnRight
```

Display the pages in two columns, with odd-numbered pages on the right.

##### TwoPagesLeft
```
public static final PdfPageLayout TwoPagesLeft
```

Display the pages two at a time, with odd-numbered pages on the left.

##### TwoPagesRight
```
public static final PdfPageLayout TwoPagesRight
```

Display the pages two at a time, with odd-numbered pages on the right.

### PdfPageMode
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfpagemode.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PdfPageMode extends Enumeration implements Serializable
```

Describes Pdf page mode

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfPageMode() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| UseNone | Don't use any components.
 |
| UseOutlines | Document outline visible.
 |
| UseThumbs | Thumbnail images visible.
 |
| FullScreen | FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.
 |
| UseOC | Optional content group panel visible.
 |
| UseAttachments | Attachments panel visible.
 |
##### PdfPageMode()
```
public PdfPageMode()
```

Serialization constructor

##### UseNone
```
public static final PdfPageMode UseNone
```

Don't use any components.

##### UseOutlines
```
public static final PdfPageMode UseOutlines
```

Document outline visible.

##### UseThumbs
```
public static final PdfPageMode UseThumbs
```

Thumbnail images visible.

##### FullScreen
```
public static final PdfPageMode FullScreen
```

FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.

##### UseOC
```
public static final PdfPageMode UseOC
```

Optional content group panel visible.

##### UseAttachments
```
public static final PdfPageMode UseAttachments
```

Attachments panel visible.

### PdfRecognitionMode
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/pdfrecognitionmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PdfRecognitionMode extends Enum<PdfRecognitionMode>
```
#### Fields

| Field | Description |
| --- | --- |
| TEXTBOX |  |
| FLOW |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getKey() |  |
| getName() |  |
##### TEXTBOX
```
public static final PdfRecognitionMode TEXTBOX
```

##### FLOW
```
public static final PdfRecognitionMode FLOW
```

##### values()
```
public static PdfRecognitionMode[] values()
```

**Returns:**
com.groupdocs.conversion.options.convert.PdfRecognitionMode[]
##### valueOf(String name)
```
public static PdfRecognitionMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PdfRecognitionMode
##### getKey()
```
public String getKey()
```

**Returns:**
java.lang.String
##### getName()
```
public String getName()
```

**Returns:**
java.lang.String

### PresentationConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/presentationconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public class PresentationConvertOptions extends CommonConvertOptions<PresentationFileType> implements Serializable
```

Describes options for conversion to Presentation file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationConvertOptions() | Initializes new instance of PresentationConvertOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Set this property if you want to protect the converted document with a password.
 |
| setPassword(String value) | Set this property if you want to protect the converted document with a password.
 |
| getZoom() | Specifies the zoom level in percentage.
 |
| setZoom(int value) | Specifies the zoom level in percentage.
 |
##### PresentationConvertOptions()
```
public PresentationConvertOptions()
```

Initializes new instance of PresentationConvertOptions class.

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100.
Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100.
Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProjectManagementConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/projectmanagementconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions
```
public class ProjectManagementConvertOptions extends ConvertOptions<ProjectManagementFileType>
```

Options for conversion to Project management file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementConvertOptions() | Initializes new instance of class.
 |
##### ProjectManagementConvertOptions()
```
public ProjectManagementConvertOptions()
```

Initializes new instance of class.

### PsdColorModes
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/psdcolormodes.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PsdColorModes extends Enumeration implements Serializable
```

Defines Psd color modes enumeration.

#### Constructors

| Constructor | Description |
| --- | --- |
| PsdColorModes() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Bitmap | Bitmap.
 |
| Grayscale | Grayscale.
 |
| Indexed | Indexed.
 |
| Rgb | RGB.
 |
| Cmyk | CMYK.
 |
| Multichannel | Multichannel.
 |
| Duotone | Duotone.
 |
| Lab | Lab.
 |
##### PsdColorModes()
```
public PsdColorModes()
```

Serialization constructor

##### Bitmap
```
public static final PsdColorModes Bitmap
```

Bitmap.

##### Grayscale
```
public static final PsdColorModes Grayscale
```

Grayscale.

##### Indexed
```
public static final PsdColorModes Indexed
```

Indexed.

##### Rgb
```
public static final PsdColorModes Rgb
```

RGB.

##### Cmyk
```
public static final PsdColorModes Cmyk
```

CMYK.

##### Multichannel
```
public static final PsdColorModes Multichannel
```

Multichannel.

##### Duotone
```
public static final PsdColorModes Duotone
```

Duotone.

##### Lab
```
public static final PsdColorModes Lab
```

Lab.

### PsdCompressionMethods
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/psdcompressionmethods.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PsdCompressionMethods extends Enumeration implements Serializable
```

Describes Psd compression methods.

#### Constructors

| Constructor | Description |
| --- | --- |
| PsdCompressionMethods() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Raw | RAW.
 |
| Rle | RLE.
 |
| ZipWithoutPrediction | ZipWithoutPrediction.
 |
| ZipWithPrediction | ZipWithPrediction.
 |
##### PsdCompressionMethods()
```
public PsdCompressionMethods()
```

Serialization constructor

##### Raw
```
public static final PsdCompressionMethods Raw
```

RAW.

##### Rle
```
public static final PsdCompressionMethods Rle
```

RLE.

##### ZipWithoutPrediction
```
public static final PsdCompressionMethods ZipWithoutPrediction
```

ZipWithoutPrediction.

##### ZipWithPrediction
```
public static final PsdCompressionMethods ZipWithPrediction
```

ZipWithPrediction.

### PsdOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/psdoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PsdOptions extends ValueObject implements Serializable
```

Options for converting to Psd file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| PsdOptions() | Initializes new instance of PsdOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getChannelBitsCount() | Bits count per color channel.
 |
| setChannelBitsCount(short value) | Bits count per color channel.
 |
| getChannelsCount() | Color channels count.
 |
| setChannelsCount(short value) | Color channels count.
 |
| getColorMode() | Psd color mode.
 |
| setColorMode(PsdColorModes value) | Psd color mode.
 |
| getCompression() | Psd compression method.
 |
| setCompression(PsdCompressionMethods value) | Psd compression method.
 |
| getVersion() | Psd file version.
 |
| setVersion(int value) | Psd file version.
 |
##### PsdOptions()
```
public PsdOptions()
```

Initializes new instance of PsdOptions class.

##### getChannelBitsCount()
```
public final short getChannelBitsCount()
```

Bits count per color channel.

**Returns:**
short
##### setChannelBitsCount(short value)
```
public final void setChannelBitsCount(short value)
```

Bits count per color channel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | short |  |

##### getChannelsCount()
```
public final short getChannelsCount()
```

Color channels count.

**Returns:**
short
##### setChannelsCount(short value)
```
public final void setChannelsCount(short value)
```

Color channels count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | short |  |

##### getColorMode()
```
public final PsdColorModes getColorMode()
```

Psd color mode.

**Returns:**
PsdColorModes
##### setColorMode(PsdColorModes value)
```
public final void setColorMode(PsdColorModes value)
```

Psd color mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PsdColorModes |  |

##### getCompression()
```
public final PsdCompressionMethods getCompression()
```

Psd compression method.

**Returns:**
PsdCompressionMethods
##### setCompression(PsdCompressionMethods value)
```
public final void setCompression(PsdCompressionMethods value)
```

Psd compression method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PsdCompressionMethods |  |

##### getVersion()
```
public final int getVersion()
```

Psd file version.

**Returns:**
int
##### setVersion(int value)
```
public final void setVersion(int value)
```

Psd file version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### Rotation
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/rotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class Rotation extends Enumeration implements Serializable
```

Describes page rotation enumeration

#### Constructors

| Constructor | Description |
| --- | --- |
| Rotation() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| None | None.
 |
| On90 | 90 degrees.
 |
| On180 | 180 degrees.
 |
| On270 | 270 degrees.
 |
##### Rotation()
```
public Rotation()
```

Serialization constructor

##### None
```
public static final Rotation None
```

None.

##### On90
```
public static final Rotation On90
```

90 degrees.

##### On180
```
public static final Rotation On180
```

180 degrees.

##### On270
```
public static final Rotation On270
```

270 degrees.

### RtfOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/rtfoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class RtfOptions extends ValueObject implements Serializable
```

Options for conversion to RTF file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| RtfOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getExportImagesForOldReaders() | Specifies whether the keywords for "old readers" are written to RTF or not.
 |
| setExportImagesForOldReaders(boolean value) | Specifies whether the keywords for "old readers" are written to RTF or not.
 |
##### RtfOptions()
```
public RtfOptions()
```

##### getExportImagesForOldReaders()
```
public final boolean getExportImagesForOldReaders()
```

Specifies whether the keywords for "old readers" are written to RTF or not.
This can significantly affect the size of the RTF document. Default is False.

**Returns:**
boolean
##### setExportImagesForOldReaders(boolean value)
```
public final void setExportImagesForOldReaders(boolean value)
```

Specifies whether the keywords for "old readers" are written to RTF or not.
This can significantly affect the size of the RTF document. Default is False.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### SpreadsheetConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/spreadsheetconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public class SpreadsheetConvertOptions extends CommonConvertOptions<SpreadsheetFileType> implements Serializable
```

Options for conversion to Spreadsheet file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetConvertOptions() | Initializes new instance of SpreadsheetConvertOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Set this property if you want to protect the converted document with a password.
 |
| setPassword(String value) | Set this property if you want to protect the converted document with a password.
 |
| getZoom() | Specifies the zoom level in percentage.
 |
| setZoom(int value) | Specifies the zoom level in percentage.
 |
| getSeparator() | Specifies the separator to be used when convert to a delimited formats
 |
| setSeparator(char separator) |  |
| setFormat(FileType value) |  |
##### SpreadsheetConvertOptions()
```
public SpreadsheetConvertOptions()
```

Initializes new instance of SpreadsheetConvertOptions class.

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSeparator()
```
public char getSeparator()
```

Specifies the separator to be used when convert to a delimited formats

**Returns:**
char
##### setSeparator(char separator)
```
public void setSeparator(char separator)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| separator | char |  |

##### setFormat(FileType value)
```
public void setFormat(FileType value)
```

The desired file type the input document should be converted to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### TiffCompressionMethods
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/tiffcompressionmethods.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class TiffCompressionMethods extends Enumeration implements Serializable
```

Describes Tiff compression methods enumeration.

#### Constructors

| Constructor | Description |
| --- | --- |
| TiffCompressionMethods() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Lzw | LZW compression.
 |
| None | No compression.
 |
| Ccitt3 | CCITT3 compression.
 |
| Ccitt4 | CCITT4 compression.
 |
| Rle | RLE compression.
 |
##### TiffCompressionMethods()
```
public TiffCompressionMethods()
```

Serialization constructor

##### Lzw
```
public static final TiffCompressionMethods Lzw
```

LZW compression.

##### None
```
public static final TiffCompressionMethods None
```

No compression.

##### Ccitt3
```
public static final TiffCompressionMethods Ccitt3
```

CCITT3 compression.

##### Ccitt4
```
public static final TiffCompressionMethods Ccitt4
```

CCITT4 compression.

##### Rle
```
public static final TiffCompressionMethods Rle
```

RLE compression.

### TiffOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/tiffoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class TiffOptions extends ValueObject implements Serializable
```

Options for conversion to TIFF file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| TiffOptions() | ctor
 |
#### Methods

| Method | Description |
| --- | --- |
| getCompression() | Sets Tiff compression.
 |
| setCompression(TiffCompressionMethods value) | Sets Tiff compression.
 |
##### TiffOptions()
```
public TiffOptions()
```

ctor

##### getCompression()
```
public final TiffCompressionMethods getCompression()
```

Sets Tiff compression.

**Returns:**
TiffCompressionMethods
##### setCompression(TiffCompressionMethods value)
```
public final void setCompression(TiffCompressionMethods value)
```

Sets Tiff compression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffCompressionMethods |  |

### WatermarkImageOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/watermarkimageoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.WatermarkOptions
```
public class WatermarkImageOptions extends WatermarkOptions
```

Options for settings watermark to the converted document

#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkImageOptions(byte[] image) |  |
#### Methods

| Method | Description |
| --- | --- |
| getImage() |  |
##### WatermarkImageOptions(byte[] image)
```
public WatermarkImageOptions(byte[] image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | byte[] |  |

##### getImage()
```
public byte[] getImage()
```

**Returns:**
byte[]

### WatermarkOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/watermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.lang.Cloneable, java.io.Serializable
```
public abstract class WatermarkOptions extends ValueObject implements Cloneable, Serializable
```

Options for settings watermark to the converted document

#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkOptions() | Create WatermarkOptions class and set watermark text
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Watermark width
 |
| setWidth(int value) | Watermark width
 |
| getHeight() | Watermark height
 |
| setHeight(int value) | Watermark height
 |
| getTop() | Watermark top position
 |
| setTop(int value) | Watermark top position
 |
| getLeft() | Watermark left position
 |
| setLeft(int value) | Watermark left position
 |
| getRotationAngle() | Watermark rotation angle
 |
| setRotationAngle(int value) | Watermark rotation angle
 |
| getTransparency() | Watermark transparency.
 |
| setTransparency(double value) | Watermark transparency.
 |
| getBackground() | Indicates that the watermark is stamped as background.
 |
| setBackground(boolean value) | Indicates that the watermark is stamped as background.
 |
| isAutoAlign() |  |
| setAutoAlign(boolean autoAlign) |  |
| deepClone() | Clone current instance
 |
##### WatermarkOptions()
```
public WatermarkOptions()
```

Create WatermarkOptions class and set watermark text

##### getWidth()
```
public final int getWidth()
```

Watermark width

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Watermark width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Watermark height

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Watermark height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public final int getTop()
```

Watermark top position

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Watermark top position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLeft()
```
public final int getLeft()
```

Watermark left position

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Watermark left position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRotationAngle()
```
public final int getRotationAngle()
```

Watermark rotation angle

**Returns:**
int
##### setRotationAngle(int value)
```
public final void setRotationAngle(int value)
```

Watermark rotation angle

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBackground()
```
public final boolean getBackground()
```

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

**Returns:**
boolean
##### setBackground(boolean value)
```
public final void setBackground(boolean value)
```

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### isAutoAlign()
```
public boolean isAutoAlign()
```

**Returns:**
boolean
##### setAutoAlign(boolean autoAlign)
```
public void setAutoAlign(boolean autoAlign)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoAlign | boolean |  |

##### deepClone()
```
public final Object deepClone()
```

Clone current instance

**Returns:**
java.lang.Object - instance

### WatermarkTextOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/watermarktextoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.WatermarkOptions
```
public class WatermarkTextOptions extends WatermarkOptions
```

Options for settings text watermark to the converted document

#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkTextOptions(String text) |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Watermark text
 |
| setText(String value) | Watermark text
 |
| getWatermarkFont() | Watermark font if text watermark is applied
 |
| setWatermarkFont(Font watermarkFont) | Sets Watermark font if text watermark is applied
 |
| getColor() | Watermark font color if text watermark is applied
 |
| getColorInternal() |  |
| setColor(Color value) | Watermark font color if text watermark is applied
 |
| getHexColor() |  |
##### WatermarkTextOptions(String text)
```
public WatermarkTextOptions(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

##### getText()
```
public final String getText()
```

Watermark text

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Watermark text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getWatermarkFont()
```
public Font getWatermarkFont()
```

Watermark font if text watermark is applied

**Returns:**
Font - font

##### setWatermarkFont(Font watermarkFont)
```
public void setWatermarkFont(Font watermarkFont)
```

Sets Watermark font if text watermark is applied

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermarkFont | Font | font
 |

##### getColor()
```
public final Color getColor()
```

Watermark font color if text watermark is applied

**Returns:**
java.awt.Color
##### getColorInternal()
```
public System.Drawing.Color getColorInternal()
```

**Returns:**
com.aspose.ms.System.Drawing.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Watermark font color if text watermark is applied

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### getHexColor()
```
public String getHexColor()
```

**Returns:**
java.lang.String

### WebConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/webconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
```
public class WebConvertOptions extends CommonConvertOptions<WebFileType>
```

Options for conversion to Web file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| WebConvertOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isUsePdf() |  |
| setUsePdf(boolean usePdf) |  |
| isFixedLayout() |  |
| setFixedLayout(boolean fixedLayout) |  |
| isFixedLayoutShowBorders() |  |
| setFixedLayoutShowBorders(boolean fixedLayoutShowBorders) |  |
| getZoom() |  |
| setZoom(int zoom) |  |
| isEmbedFontResources() | Specifies whether to embed font resources within the main HTML.
 |
| setEmbedFontResources(boolean embedFontResources) | Specifies whether to embed font resources within the main HTML.
 |
##### WebConvertOptions()
```
public WebConvertOptions()
```

Initializes new instance of class.

##### isUsePdf()
```
public boolean isUsePdf()
```

**Returns:**
boolean
##### setUsePdf(boolean usePdf)
```
public void setUsePdf(boolean usePdf)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| usePdf | boolean |  |

##### isFixedLayout()
```
public boolean isFixedLayout()
```

**Returns:**
boolean
##### setFixedLayout(boolean fixedLayout)
```
public void setFixedLayout(boolean fixedLayout)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixedLayout | boolean |  |

##### isFixedLayoutShowBorders()
```
public boolean isFixedLayoutShowBorders()
```

**Returns:**
boolean
##### setFixedLayoutShowBorders(boolean fixedLayoutShowBorders)
```
public void setFixedLayoutShowBorders(boolean fixedLayoutShowBorders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixedLayoutShowBorders | boolean |  |

##### getZoom()
```
public int getZoom()
```

**Returns:**
int
##### setZoom(int zoom)
```
public void setZoom(int zoom)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| zoom | int |  |

##### isEmbedFontResources()
```
public boolean isEmbedFontResources()
```

Specifies whether to embed font resources within the main HTML. Default is false. Note: If FixedLayout is set to true, font resources will always be embedded.

**Returns:**
boolean
##### setEmbedFontResources(boolean embedFontResources)
```
public void setEmbedFontResources(boolean embedFontResources)
```

Specifies whether to embed font resources within the main HTML. Default is false. Note: If FixedLayout is set to true, font resources will always be embedded.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| embedFontResources | boolean |  |

### WebpOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/webpoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class WebpOptions extends ValueObject implements Serializable
```

Options for conversion to Webp file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| WebpOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getLossless() | Indicates if the compression of the converted file will be lossless.
 |
| setLossless(boolean value) | Indicates if the compression of the converted file will be lossless.
 |
| getQuality() | Gets or sets the quality.
 |
| setQuality(int value) | Gets or sets the quality.
 |
##### WebpOptions()
```
public WebpOptions()
```

##### getLossless()
```
public final boolean getLossless()
```

Indicates if the compression of the converted file will be lossless.

**Returns:**
boolean
##### setLossless(boolean value)
```
public final void setLossless(boolean value)
```

Indicates if the compression of the converted file will be lossless.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getQuality()
```
public final int getQuality()
```

Gets or sets the quality.

**Returns:**
int
##### setQuality(int value)
```
public final void setQuality(int value)
```

Gets or sets the quality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### WordProcessingConvertOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.convert/wordprocessingconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.convert.IPageMarginConvertOptions, com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions, com.groupdocs.conversion.options.convert.IPdfRecognitionModeOptions
```
public class WordProcessingConvertOptions extends CommonConvertOptions<WordProcessingFileType> implements Serializable, IPageMarginConvertOptions, IPageSizeConvertOptions, IPageOrientationConvertOptions, IPdfRecognitionModeOptions
```

Options for conversion to WordProcessing file type.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingConvertOptions() | Initializes new instance of WordProcessingConvertOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDpi() | Desired page DPI after conversion.
 |
| setDpi(int value) | Desired page DPI after conversion.
 |
| getPassword() | Set this property if you want to protect the converted document with a password.
 |
| setPassword(String value) | Set this property if you want to protect the converted document with a password.
 |
| getRtfOptions() | RTF specific convert options
 |
| setRtfOptions(RtfOptions value) | RTF specific convert options
 |
| getZoom() | Specifies the zoom level in percentage.
 |
| setZoom(int value) | Specifies the zoom level in percentage.
 |
| getMarginTop() | Desired page top margin in points after conversion.
 |
| setMarginTop(float value) | Desired page top margin in points after conversion.
 |
| getMarginBottom() | Desired page bottom margin in points after conversion.
 |
| setMarginBottom(float value) | Desired page bottom margin in points after conversion.
 |
| getMarginLeft() | Desired page left margin in points after conversion.
 |
| setMarginLeft(float value) | Desired page left margin in points after conversion.
 |
| getMarginRight() | Desired page right margin in points after conversion.
 |
| setMarginRight(float value) | Desired page right margin in points after conversion.
 |
| getPageOrientation() |  |
| setPageOrientation(PageOrientation pageOrientation) |  |
| getPageSize() |  |
| setPageSize(PageSize pageSize) |  |
| getPageWidth() |  |
| setPageWidth(float pageWidth) |  |
| getPageHeight() |  |
| setPageHeight(float pageHeight) |  |
| getPdfRecognitionMode() |  |
| setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode) |  |
| getMarkdownOptions() | Gets
 |
| setMarkdownOptions(MarkdownOptions markdownOptions) | Sets
 |
##### WordProcessingConvertOptions()
```
public WordProcessingConvertOptions()
```

Initializes new instance of WordProcessingConvertOptions class.

##### getDpi()
```
public final int getDpi()
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Returns:**
int
##### setDpi(int value)
```
public final void setDpi(int value)
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRtfOptions()
```
public final RtfOptions getRtfOptions()
```

RTF specific convert options

**Returns:**
RtfOptions
##### setRtfOptions(RtfOptions value)
```
public final void setRtfOptions(RtfOptions value)
```

RTF specific convert options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | RtfOptions |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100.
Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100.
Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginTop()
```
public final float getMarginTop()
```

Desired page top margin in points after conversion.

**Returns:**
float
##### setMarginTop(float value)
```
public final void setMarginTop(float value)
```

Desired page top margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getMarginBottom()
```
public final float getMarginBottom()
```

Desired page bottom margin in points after conversion.

**Returns:**
float
##### setMarginBottom(float value)
```
public final void setMarginBottom(float value)
```

Desired page bottom margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getMarginLeft()
```
public final float getMarginLeft()
```

Desired page left margin in points after conversion.

**Returns:**
float
##### setMarginLeft(float value)
```
public final void setMarginLeft(float value)
```

Desired page left margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getMarginRight()
```
public final float getMarginRight()
```

Desired page right margin in points after conversion.

**Returns:**
float
##### setMarginRight(float value)
```
public final void setMarginRight(float value)
```

Desired page right margin in points after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getPageOrientation()
```
public PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

##### getPageSize()
```
public PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public float getPageWidth()
```

Specified page width in points if is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public float getPageHeight()
```

Specified page height in points if is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

##### getPdfRecognitionMode()
```
public PdfRecognitionMode getPdfRecognitionMode()
```

Gets recognition mode when converting from pdf

**Returns:**
PdfRecognitionMode
##### setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)
```
public void setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)
```

Sets recognition mode when converting from pdf

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfRecognitionMode | PdfRecognitionMode |  |

##### getMarkdownOptions()
```
public MarkdownOptions getMarkdownOptions()
```

Gets

**Returns:**
MarkdownOptions
##### setMarkdownOptions(MarkdownOptions markdownOptions)
```
public void setMarkdownOptions(MarkdownOptions markdownOptions)
```

Sets

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| markdownOptions | MarkdownOptions |  |

### com.groupdocs.conversion.options.load
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load.md

The GroupDocs.Conversion.Options.Load namespace provides classes to specify additional options for document loading process.

#### Classes

| Class | Description |
| --- | --- |
| AudioLoadOptions |  |
| CadDrawTypeMode | Represents possible modes for colorization of objects. |
| CadLoadOptions | Options for loading CAD documents. |
| CsvLoadOptions | Options for loading Csv documents. |
| DatabaseLoadOptions | Options for loading database documents. |
| DiagramLoadOptions | Options for loading Diagram documents. |
| EBookLoadOptions | Options for loading EBook documents. |
| EmailField | Describes email fields enumeration |
| EmailLoadOptions | Options for loading Email documents. |
| EpubLoadOptions | Options for loading Epub documents. |
| FontLoadOptions | Options for loading Font documents. |
| ImageLoadOptions | Options for loading Image documents. |
| LoadOptions | Abstract document load options class. |
| MboxLoadOptions | Options for loading Mbox documents. |
| NoteLoadOptions | Options for loading One documents. |
| NsfLoadOptions | Options for loading Nsf documents. |
| PageDescriptionLanguageLoadOptions | Options for loading page description language documents. |
| PdfLoadOptions | Options for loading Pdf documents. |
| PersonalStorageLoadOptions | Options for loading personal storage documents. |
| PresentationLoadOptions | Options for loading Presentation documents. |
| PublisherLoadOptions | Options for loading Publisher documents. |
| SpreadsheetLoadOptions | Options for loading Spreadsheet documents. |
| TsvLoadOptions | Options for loading Tsv documents. |
| TxtLeadingSpacesOptions | Describes txt leading spaces options enumeration. |
| TxtLoadOptions | Options for loading Txt documents. |
| TxtTrailingSpacesOptions | Describes txt trailing spaces options enumeration. |
| VcfLoadOptions | Options for loading Vcf documents. |
| VideoLoadOptions | Options for loading video documents. |
| WebLoadOptions | Options for loading web documents. |
| WordProcessingBookmarksOptions | Options for handling bookmarks in WordProcessing |
| WordProcessingLoadOptions | Options for loading WordProcessing documents. |
| XmlLoadOptions | Options for loading XML documents. |

### AudioLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/audioloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class AudioLoadOptions extends LoadOptions
```
#### Constructors

| Constructor | Description |
| --- | --- |
| AudioLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAudioConnector() |  |
| setAudioConnector(IAudioConnector audioConnector) | Sets audio connector
 |
##### AudioLoadOptions()
```
public AudioLoadOptions()
```

Initializes new instance of class.

##### getAudioConnector()
```
public IAudioConnector getAudioConnector()
```

**Returns:**
IAudioConnector
##### setAudioConnector(IAudioConnector audioConnector)
```
public void setAudioConnector(IAudioConnector audioConnector)
```

Sets audio connector

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| audioConnector | IAudioConnector | Audio connector
 |

### CadDrawTypeMode
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/caddrawtypemode.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration
```
public class CadDrawTypeMode extends Enumeration
```

Represents possible modes for colorization of objects.

#### Constructors

| Constructor | Description |
| --- | --- |
| CadDrawTypeMode() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| UseDrawColor | Allows to use common color.
 |
| UseObjectColor | Allows to use separate color for every object.
 |
##### CadDrawTypeMode()
```
public CadDrawTypeMode()
```

Serialization constructor

##### UseDrawColor
```
public static final CadDrawTypeMode UseDrawColor
```

Allows to use common color.

##### UseObjectColor
```
public static final CadDrawTypeMode UseObjectColor
```

Allows to use separate color for every object.

### CadLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/cadloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class CadLoadOptions extends LoadOptions implements Serializable
```

Options for loading CAD documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| CadLoadOptions() | Initializes new instance of CadLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getWidth() | Sets desired page width for converting CAD document
 |
| setWidth(int value) | Sets desired page width for converting CAD document
 |
| getHeight() | Sets desired page height for converting CAD document
 |
| setHeight(int value) | Sets desired page height for converting CAD document
 |
| getLayoutNames() | Specifies which CAD layouts to be converted
 |
| setLayoutNames(String[] value) | Specififies which CAD layouts to be converted
 |
| getDrawType() | Gets type of drawing.
 |
| setDrawType(CadDrawTypeMode drawType) | Sets type of drawing.
 |
| getBackgroundColor() | Gets a background color.
 |
| setBackgroundColor(System.Drawing.Color backgroundColor) | Sets a background color.
 |
| getFontDirectories() |  |
| setFontDirectories(List<String> fontDirectories) |  |
| getCtbSources() | Gets the CTB sources.
 |
| setCtbSources(Map<String,InputStream> ctbSources) | Sets the CTB sources.
 |
| getDrawColor() | Gets foreground color.
 |
| setDrawColor(System.Drawing.Color drawColor) | Sets foreground color.
 |
##### CadLoadOptions()
```
public CadLoadOptions()
```

Initializes new instance of CadLoadOptions class.

##### getFormat()
```
public CadFileType getFormat()
```

Input document file type

**Returns:**
CadFileType
##### getWidth()
```
public final int getWidth()
```

Sets desired page width for converting CAD document

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets desired page width for converting CAD document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Sets desired page height for converting CAD document

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets desired page height for converting CAD document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLayoutNames()
```
public final String[] getLayoutNames()
```

Specifies which CAD layouts to be converted

**Returns:**
java.lang.String[]
##### setLayoutNames(String[] value)
```
public final void setLayoutNames(String[] value)
```

Specififies which CAD layouts to be converted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] |  |

##### getDrawType()
```
public CadDrawTypeMode getDrawType()
```

Gets type of drawing.

**Returns:**
CadDrawTypeMode
##### setDrawType(CadDrawTypeMode drawType)
```
public void setDrawType(CadDrawTypeMode drawType)
```

Sets type of drawing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| drawType | CadDrawTypeMode |  |

##### getBackgroundColor()
```
public System.Drawing.Color getBackgroundColor()
```

Gets a background color.

**Returns:**
com.aspose.ms.System.Drawing.Color
##### setBackgroundColor(System.Drawing.Color backgroundColor)
```
public void setBackgroundColor(System.Drawing.Color backgroundColor)
```

Sets a background color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | com.aspose.ms.System.Drawing.Color |  |

##### getFontDirectories()
```
public List<String> getFontDirectories()
```

**Returns:**
java.util.List<java.lang.String>
##### setFontDirectories(List<String> fontDirectories)
```
public void setFontDirectories(List<String> fontDirectories)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontDirectories | java.util.List<java.lang.String> |  |

##### getCtbSources()
```
public Map<String,InputStream> getCtbSources()
```

Gets the CTB sources.

**Returns:**
java.util.Map<java.lang.String,java.io.InputStream>
##### setCtbSources(Map<String,InputStream> ctbSources)
```
public void setCtbSources(Map<String,InputStream> ctbSources)
```

Sets the CTB sources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ctbSources | java.util.Map<java.lang.String,java.io.InputStream> |  |

##### getDrawColor()
```
public System.Drawing.Color getDrawColor()
```

Gets foreground color.

**Returns:**
com.aspose.ms.System.Drawing.Color
##### setDrawColor(System.Drawing.Color drawColor)
```
public void setDrawColor(System.Drawing.Color drawColor)
```

Sets foreground color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| drawColor | com.aspose.ms.System.Drawing.Color |  |

### CsvLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/csvloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions, com.groupdocs.conversion.options.load.SpreadsheetLoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class CsvLoadOptions extends SpreadsheetLoadOptions implements Serializable
```

Options for loading Csv documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| CsvLoadOptions() | Initializes new instance of CsvLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSeparator() | Delimiter of a Csv file.
 |
| setSeparator(char value) | Delimiter of a Csv file.
 |
| isMultiEncoded() | True means the file contains several encodings.
 |
| setMultiEncoded(boolean value) | True means the file contains several encodings.
 |
| hasFormula() | Indicates whether text is formula if it starts with "=".
 |
| setFormula(boolean value) | Indicates whether text is formula if it starts with "=".
 |
| getConvertNumericData() | Indicates whether the string in the file is converted to numeric.
 |
| setConvertNumericData(boolean value) | Indicates whether the string in the file is converted to numeric.
 |
| getConvertDateTimeData() | Indicates whether the string in the file is converted to date.
 |
| setConvertDateTimeData(boolean value) | Indicates whether the string in the file is converted to date.
 |
| getEncoding() | Encoding.
 |
| getEncodingInternal() |  |
| setEncoding(Charset value) | Encoding.
 |
| setEncodingInternal(System.Text.Encoding value) |  |
##### CsvLoadOptions()
```
public CsvLoadOptions()
```

Initializes new instance of CsvLoadOptions class.

##### getSeparator()
```
public final char getSeparator()
```

Delimiter of a Csv file.

**Returns:**
char
##### setSeparator(char value)
```
public final void setSeparator(char value)
```

Delimiter of a Csv file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char |  |

##### isMultiEncoded()
```
public final boolean isMultiEncoded()
```

True means the file contains several encodings.

**Returns:**
boolean
##### setMultiEncoded(boolean value)
```
public final void setMultiEncoded(boolean value)
```

True means the file contains several encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### hasFormula()
```
public final boolean hasFormula()
```

Indicates whether text is formula if it starts with "=".

**Returns:**
boolean
##### setFormula(boolean value)
```
public final void setFormula(boolean value)
```

Indicates whether text is formula if it starts with "=".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertNumericData()
```
public final boolean getConvertNumericData()
```

Indicates whether the string in the file is converted to numeric. Default is True.

**Returns:**
boolean
##### setConvertNumericData(boolean value)
```
public final void setConvertNumericData(boolean value)
```

Indicates whether the string in the file is converted to numeric. Default is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertDateTimeData()
```
public final boolean getConvertDateTimeData()
```

Indicates whether the string in the file is converted to date. Default is True.

**Returns:**
boolean
##### setConvertDateTimeData(boolean value)
```
public final void setConvertDateTimeData(boolean value)
```

Indicates whether the string in the file is converted to date. Default is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEncoding()
```
public final Charset getEncoding()
```

Encoding. Default is Encoding.Default.

**Returns:**
java.nio.charset.Charset
##### getEncodingInternal()
```
public System.Text.Encoding getEncodingInternal()
```

**Returns:**
com.aspose.ms.System.Text.Encoding
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Encoding. Default is Encoding.Default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### setEncodingInternal(System.Text.Encoding value)
```
public void setEncodingInternal(System.Text.Encoding value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.Text.Encoding |  |

### DatabaseLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/databaseloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class DatabaseLoadOptions extends LoadOptions
```

Options for loading database documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| DatabaseLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type.
 |
| setFormat(DatabaseFileType format) | Sets Input document file type.
 |
##### DatabaseLoadOptions()
```
public DatabaseLoadOptions()
```

Initializes new instance of class.

##### getFormat()
```
public DatabaseFileType getFormat()
```

Gets Input document file type.

**Returns:**
DatabaseFileType
##### setFormat(DatabaseFileType format)
```
public void setFormat(DatabaseFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | DatabaseFileType |  |

### DiagramLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/diagramloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class DiagramLoadOptions extends LoadOptions implements Serializable
```

Options for loading Diagram documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramLoadOptions() | Initializes new instance of DiagramLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Diagram document.
 |
| setDefaultFont(String value) | Default font for Diagram document.
 |
##### DiagramLoadOptions()
```
public DiagramLoadOptions()
```

Initializes new instance of DiagramLoadOptions class.

##### getFormat()
```
public final DiagramFileType getFormat()
```

Input document file type

**Returns:**
DiagramFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Diagram document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Diagram document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### EBookLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/ebookloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class EBookLoadOptions extends LoadOptions
```

Options for loading EBook documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| EBookLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type.
 |
| setFormat(EBookFileType format) | Sets Input document file type.
 |
##### EBookLoadOptions()
```
public EBookLoadOptions()
```

Initializes new instance of class.

##### getFormat()
```
public EBookFileType getFormat()
```

Gets Input document file type.

**Returns:**
EBookFileType
##### setFormat(EBookFileType format)
```
public void setFormat(EBookFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | EBookFileType |  |

### EmailField
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/emailfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class EmailField extends Enumeration implements Serializable
```

Describes email fields enumeration

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailField() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Start | Default field text is "Start".
 |
| Attachments | Default field text is "Attachments".
 |
| Cc | Default field text is "Cc".
 |
| Bcc | Default field text is "Bcc".
 |
| End | Default field text is "End".
 |
| From | Default field text is "From".
 |
| Importance | Default field text is "Importance".
 |
| Location | Default field text is "Location".
 |
| Organizer | Default field text is "Organizer".
 |
| PageHeader | Default field text is "PageHeader".
 |
| Recurrence | Default field text is "Recurrence".
 |
| RecurrencePattern | Default field text is "RecurrencePattern".
 |
| RequiredAttendees | Default field text is "RequiredAttendees".
 |
| Sent | Default field text is "Sent".
 |
| ShowTimeAs | Default field text is "ShowTimeAs".
 |
| Subject | Default field text is "Subject".
 |
| TabField | Default field text is "TabField".
 |
| To | Default field text is "To".
 |
##### EmailField()
```
public EmailField()
```

Serialization constructor

##### Start
```
public static final EmailField Start
```

Default field text is "Start".

##### Attachments
```
public static final EmailField Attachments
```

Default field text is "Attachments".

##### Cc
```
public static final EmailField Cc
```

Default field text is "Cc".

##### Bcc
```
public static final EmailField Bcc
```

Default field text is "Bcc".

##### End
```
public static final EmailField End
```

Default field text is "End".

##### From
```
public static final EmailField From
```

Default field text is "From".

##### Importance
```
public static final EmailField Importance
```

Default field text is "Importance".

##### Location
```
public static final EmailField Location
```

Default field text is "Location".

##### Organizer
```
public static final EmailField Organizer
```

Default field text is "Organizer".

##### PageHeader
```
public static final EmailField PageHeader
```

Default field text is "PageHeader".

##### Recurrence
```
public static final EmailField Recurrence
```

Default field text is "Recurrence".

##### RecurrencePattern
```
public static final EmailField RecurrencePattern
```

Default field text is "RecurrencePattern".

##### RequiredAttendees
```
public static final EmailField RequiredAttendees
```

Default field text is "RequiredAttendees".

##### Sent
```
public static final EmailField Sent
```

Default field text is "Sent".

##### ShowTimeAs
```
public static final EmailField ShowTimeAs
```

Default field text is "ShowTimeAs".

##### Subject
```
public static final EmailField Subject
```

Default field text is "Subject".

##### TabField
```
public static final EmailField TabField
```

Default field text is "TabField".

##### To
```
public static final EmailField To
```

Default field text is "To".

### EmailLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/emailloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, java.lang.Cloneable, java.io.Serializable
```
public final class EmailLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions, Cloneable, Serializable
```

Options for loading Email documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailLoadOptions() | Initializes new instance of EmailLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDisplayHeader() | Option to display or hide the email header.
 |
| setDisplayHeader(boolean value) | Option to display or hide the email header.
 |
| getDisplayFromEmailAddress() | Option to display or hide "from" email address.
 |
| setDisplayFromEmailAddress(boolean value) | Option to display or hide "from" email address.
 |
| getDisplayToEmailAddress() | Option to display or hide "to" email address.
 |
| setDisplayToEmailAddress(boolean value) | Option to display or hide "to" email address.
 |
| getDisplayCcEmailAddress() | Option to display or hide "Cc" email address.
 |
| setDisplayCcEmailAddress(boolean value) | Option to display or hide "Cc" email address.
 |
| getDisplayBccEmailAddress() | Option to display or hide "Bcc" email address.
 |
| setDisplayBccEmailAddress(boolean value) | Option to display or hide "Bcc" email address.
 |
| getTimeZoneOffset() | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates.
 |
| getTimeZoneOffsetInternal() |  |
| getResourceLoadingTimeout() | Timeout for loading external resources
 |
| setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout) | Timeout for loading external resources (setter)
 |
| setTimeZoneOffset(Double value) | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates.
 |
| deepClone() | Clones current instance.
 |
| getFieldTextMap() | Gets the mapping between email message and field text representation
 |
| setFieldTextMap(Map<EmailField,String> fieldTextMap) | Sets the mapping between email message and field text representation
 |
| isPreserveOriginalDate() | Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
 |
| setPreserveOriginalDate(boolean preserveOriginalDate) | Defines whether need to keep original date header string in mail message when saving or not
 |
| isConvertOwner() |  |
| setConvertOwner(boolean convertOwner) |  |
| isConvertOwned() |  |
| setConvertOwned(boolean convertOwned) |  |
| getDepth() |  |
| setDepth(int depth) |  |
| isDisplayAttachments() | Gets option to display or hide attachments in the header.
 |
| setDisplayAttachments(boolean displayAttachments) | Sets option to display or hide attachments in the header.
 |
| isDisplaySubject() | Gets option to display or hide subject in the header.
 |
| setDisplaySubject(boolean displaySubject) | Sets option to display or hide subject in the header
 |
| isDisplaySent() | Gets option to display or hide sent date/time in the header.
 |
| setDisplaySent(boolean displaySent) | Sets option to display or hide sent date/time in the header.
 |
| isSkipExternalResources() | Skips the http resource loading if true
 |
| setSkipExternalResources(boolean skipExternalResources) |  |
##### EmailLoadOptions()
```
public EmailLoadOptions()
```

Initializes new instance of EmailLoadOptions class.

##### getFormat()
```
public final EmailFileType getFormat()
```

Input document file type

**Returns:**
EmailFileType
##### getDisplayHeader()
```
public final boolean getDisplayHeader()
```

Option to display or hide the email header. Default: true.

**Returns:**
boolean
##### setDisplayHeader(boolean value)
```
public final void setDisplayHeader(boolean value)
```

Option to display or hide the email header. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayFromEmailAddress()
```
public final boolean getDisplayFromEmailAddress()
```

Option to display or hide "from" email address. Default: true.

**Returns:**
boolean
##### setDisplayFromEmailAddress(boolean value)
```
public final void setDisplayFromEmailAddress(boolean value)
```

Option to display or hide "from" email address. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayToEmailAddress()
```
public final boolean getDisplayToEmailAddress()
```

Option to display or hide "to" email address. Default: true.

**Returns:**
boolean
##### setDisplayToEmailAddress(boolean value)
```
public final void setDisplayToEmailAddress(boolean value)
```

Option to display or hide "to" email address. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayCcEmailAddress()
```
public final boolean getDisplayCcEmailAddress()
```

Option to display or hide "Cc" email address. Default: false.

**Returns:**
boolean
##### setDisplayCcEmailAddress(boolean value)
```
public final void setDisplayCcEmailAddress(boolean value)
```

Option to display or hide "Cc" email address. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayBccEmailAddress()
```
public final boolean getDisplayBccEmailAddress()
```

Option to display or hide "Bcc" email address. Default: false.

**Returns:**
boolean
##### setDisplayBccEmailAddress(boolean value)
```
public final void setDisplayBccEmailAddress(boolean value)
```

Option to display or hide "Bcc" email address. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTimeZoneOffset()
```
public final Double getTimeZoneOffset()
```

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.

**Returns:**
java.lang.Double
##### getTimeZoneOffsetInternal()
```
public System.TimeSpan getTimeZoneOffsetInternal()
```

**Returns:**
com.aspose.ms.System.TimeSpan
##### getResourceLoadingTimeout()
```
public System.TimeSpan getResourceLoadingTimeout()
```

Timeout for loading external resources

**Returns:**
com.aspose.ms.System.TimeSpan
##### setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
```
public void setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
```

Timeout for loading external resources (setter)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resourceLoadingTimeout | com.aspose.ms.System.TimeSpan |  |

##### setTimeZoneOffset(Double value)
```
public final void setTimeZoneOffset(Double value)
```

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### deepClone()
```
public final Object deepClone()
```

Clones current instance.

**Returns:**
java.lang.Object -
##### getFieldTextMap()
```
public Map<EmailField,String> getFieldTextMap()
```

Gets the mapping between email message and field text representation

**Returns:**
java.util.Map<com.groupdocs.conversion.options.load.EmailField,java.lang.String> - mapping

##### setFieldTextMap(Map<EmailField,String> fieldTextMap)
```
public void setFieldTextMap(Map<EmailField,String> fieldTextMap)
```

Sets the mapping between email message and field text representation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldTextMap | java.util.Map<com.groupdocs.conversion.options.load.EmailField,java.lang.String> | mapping
 |

##### isPreserveOriginalDate()
```
public boolean isPreserveOriginalDate()
```

Defines whether need to keep original date header string in mail message when saving or not (Default value is true)

**Returns:**
boolean - preserve original date if true

##### setPreserveOriginalDate(boolean preserveOriginalDate)
```
public void setPreserveOriginalDate(boolean preserveOriginalDate)
```

Defines whether need to keep original date header string in mail message when saving or not

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preserveOriginalDate | boolean | preserve original date
 |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### setConvertOwner(boolean convertOwner)
```
public void setConvertOwner(boolean convertOwner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwner | boolean |  |

##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### setConvertOwned(boolean convertOwned)
```
public void setConvertOwned(boolean convertOwned)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwned | boolean |  |

##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

##### isDisplayAttachments()
```
public boolean isDisplayAttachments()
```

Gets option to display or hide attachments in the header. Default: true.

**Returns:**
boolean
##### setDisplayAttachments(boolean displayAttachments)
```
public void setDisplayAttachments(boolean displayAttachments)
```

Sets option to display or hide attachments in the header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| displayAttachments | boolean |  |

##### isDisplaySubject()
```
public boolean isDisplaySubject()
```

Gets option to display or hide subject in the header. Default: true.

**Returns:**
boolean
##### setDisplaySubject(boolean displaySubject)
```
public void setDisplaySubject(boolean displaySubject)
```

Sets option to display or hide subject in the header

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| displaySubject | boolean |  |

##### isDisplaySent()
```
public boolean isDisplaySent()
```

Gets option to display or hide sent date/time in the header. Default: true.

**Returns:**
boolean
##### setDisplaySent(boolean displaySent)
```
public void setDisplaySent(boolean displaySent)
```

Sets option to display or hide sent date/time in the header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| displaySent | boolean |  |

##### isSkipExternalResources()
```
public boolean isSkipExternalResources()
```

Skips the http resource loading if true

**Returns:**
boolean
##### setSkipExternalResources(boolean skipExternalResources)
```
public void setSkipExternalResources(boolean skipExternalResources)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skipExternalResources | boolean |  |

### EpubLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/epubloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EpubLoadOptions extends LoadOptions implements Serializable
```

Options for loading Epub documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| EpubLoadOptions() | Initializes new instance of EpubLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
##### EpubLoadOptions()
```
public EpubLoadOptions()
```

Initializes new instance of EpubLoadOptions class.

##### getFormat()
```
public final EBookFileType getFormat()
```

Input document file type

**Returns:**
EBookFileType

### FontLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/fontloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class FontLoadOptions extends LoadOptions
```

Options for loading Font documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| FontLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type.
 |
| setFormat(FontFileType format) | Sets Input document file type.
 |
##### FontLoadOptions()
```
public FontLoadOptions()
```

Initializes new instance of class.

##### getFormat()
```
public FontFileType getFormat()
```

Gets Input document file type.

**Returns:**
FontFileType
##### setFormat(FontFileType format)
```
public void setFormat(FontFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FontFileType |  |

### ImageLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/imageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class ImageLoadOptions extends LoadOptions implements Serializable
```

Options for loading Image documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageLoadOptions() | Initializes new instance of ImageLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Psd, Emf, Wmf document types.
 |
| setDefaultFont(String value) | Default font for Psd, Emf, Wmf document types.
 |
| isRecognitionEnabled() |  |
| getOcrConnector() |  |
| setOcrConnector(IOcrConnector ocrConnector) | Set image OCR connector
 |
| getResetFontFolders() | Reset font folders before loading document
 |
| setResetFontFolders(boolean resetFontFolders) |  |
##### ImageLoadOptions()
```
public ImageLoadOptions()
```

Initializes new instance of ImageLoadOptions class.

##### getFormat()
```
public final ImageFileType getFormat()
```

Input document file type

**Returns:**
ImageFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### isRecognitionEnabled()
```
public boolean isRecognitionEnabled()
```

**Returns:**
boolean
##### getOcrConnector()
```
public IOcrConnector getOcrConnector()
```

**Returns:**
IOcrConnector
##### setOcrConnector(IOcrConnector ocrConnector)
```
public void setOcrConnector(IOcrConnector ocrConnector)
```

Set image OCR connector

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | OCR connector instance
 |

##### getResetFontFolders()
```
public boolean getResetFontFolders()
```

Reset font folders before loading document

**Returns:**
boolean
##### setResetFontFolders(boolean resetFontFolders)
```
public void setResetFontFolders(boolean resetFontFolders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resetFontFolders | boolean |  |

### LoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/loadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public abstract class LoadOptions extends ValueObject implements Serializable
```

Abstract document load options class.

#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Input document file type
 |
| setFormat(FileType value) | Input document file type
 |
##### LoadOptions()
```
public LoadOptions()
```

##### getFormat()
```
public FileType getFormat()
```

Input document file type

**Returns:**
FileType
##### setFormat(FileType value)
```
public void setFormat(FileType value)
```

Input document file type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### MboxLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/mboxloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class MboxLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading Mbox documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| MboxLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isConvertOwner() | The owner will not be converted
 |
| isConvertOwned() | {@inheritDoc}
 |
| getDepth() | {@inheritDoc} Default: 3
 |
| setDepth(int depth) | {@inheritDoc}
 |
| getEqualityComponents() | {@inheritDoc}
 |
##### MboxLoadOptions()
```
public MboxLoadOptions()
```

Initializes new instance of class.

##### isConvertOwner()
```
public boolean isConvertOwner()
```

The owner will not be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion Default: 3

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

##### getEqualityComponents()
```
public List<Object> getEqualityComponents()
```

**Returns:**
java.util.List<java.lang.Object>

### NoteLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/noteloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class NoteLoadOptions extends LoadOptions implements Serializable
```

Options for loading One documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| NoteLoadOptions() | Initializes new instance of NoteLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Note document.
 |
| setDefaultFont(String value) | Default font for Note document.
 |
| getFontSubstitutes() | Substitute specific fonts when converting Note document.
 |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Note document.
 |
| getPassword() | Set password to unprotect protected document.
 |
| setPassword(String value) | Set password to unprotect protected document.
 |
##### NoteLoadOptions()
```
public NoteLoadOptions()
```

Initializes new instance of NoteLoadOptions class.

##### getFormat()
```
public final NoteFileType getFormat()
```

Input document file type

**Returns:**
NoteFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Note document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Note document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Note document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Note document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### NsfLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/nsfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class NsfLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading Nsf documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| NsfLoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| isConvertOwner() |  |
| isConvertOwned() | {@inheritDoc}
 |
| getDepth() |  |
| setDepth(int depth) |  |
##### NsfLoadOptions()
```
public NsfLoadOptions()
```

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### PageDescriptionLanguageLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class PageDescriptionLanguageLoadOptions extends LoadOptions
```

Options for loading page description language documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageDescriptionLanguageLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type.
 |
| setFormat(PageDescriptionLanguageFileType format) | Sets Input document file type.
 |
##### PageDescriptionLanguageLoadOptions()
```
public PageDescriptionLanguageLoadOptions()
```

Initializes new instance of class.

##### getFormat()
```
public PageDescriptionLanguageFileType getFormat()
```

Gets Input document file type.

**Returns:**
PageDescriptionLanguageFileType
##### setFormat(PageDescriptionLanguageFileType format)
```
public void setFormat(PageDescriptionLanguageFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | PageDescriptionLanguageFileType |  |

### PdfLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/pdfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions
```
public final class PdfLoadOptions extends LoadOptions implements Serializable, IPageNumberingLoadOptions
```

Options for loading Pdf documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfLoadOptions() | Initializes new instance of PdfLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getRemoveEmbeddedFiles() | Remove embedded files.
 |
| setRemoveEmbeddedFiles(boolean value) | Remove embedded files.
 |
| getPassword() | Set password to unprotect protected document.
 |
| setPassword(String value) | Set password to unprotect protected document.
 |
| getDefaultFont() | Default font for Pdf document.
 |
| setDefaultFont(String value) | Default font for Pdf document.
 |
| getFontSubstitutes() | Substitute specific fonts when converting Pdf document.
 |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Pdf document.
 |
| getHidePdfAnnotations() | Hide annotations in Pdf documents.
 |
| setHidePdfAnnotations(boolean value) | Hide annotations in Pdf documents.
 |
| getFlattenAllFields() | Flatten all the fields of the PDF form.
 |
| setFlattenAllFields(boolean value) | Flatten all the fields of the PDF form.
 |
| getResetFontFolders() | Reset font folders before loading document
 |
| setResetFontFolders(boolean resetFontFolders) |  |
| isPageNumbering() | Enable or disable generation of page numbering in converted document.
 |
| setPageNumbering(boolean isPageNumbering) |  |
| isRemoveJavascript() | Gets the Remove JavaScript flag
 |
| setRemoveJavascript(boolean removeJavascript) | Sets the Remove JavaScript flag
 |
##### PdfLoadOptions()
```
public PdfLoadOptions()
```

Initializes new instance of PdfLoadOptions class.

##### getFormat()
```
public final PdfFileType getFormat()
```

Input document file type

**Returns:**
PdfFileType
##### getRemoveEmbeddedFiles()
```
public final boolean getRemoveEmbeddedFiles()
```

Remove embedded files.

**Returns:**
boolean
##### setRemoveEmbeddedFiles(boolean value)
```
public final void setRemoveEmbeddedFiles(boolean value)
```

Remove embedded files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Pdf document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Pdf document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Pdf document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Pdf document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getHidePdfAnnotations()
```
public final boolean getHidePdfAnnotations()
```

Hide annotations in Pdf documents.

**Returns:**
boolean
##### setHidePdfAnnotations(boolean value)
```
public final void setHidePdfAnnotations(boolean value)
```

Hide annotations in Pdf documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFlattenAllFields()
```
public final boolean getFlattenAllFields()
```

Flatten all the fields of the PDF form.

**Returns:**
boolean
##### setFlattenAllFields(boolean value)
```
public final void setFlattenAllFields(boolean value)
```

Flatten all the fields of the PDF form.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getResetFontFolders()
```
public boolean getResetFontFolders()
```

Reset font folders before loading document

**Returns:**
boolean
##### setResetFontFolders(boolean resetFontFolders)
```
public void setResetFontFolders(boolean resetFontFolders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resetFontFolders | boolean |  |

##### isPageNumbering()
```
public boolean isPageNumbering()
```

Enable or disable generation of page numbering in converted document. Default: false

**Returns:**
boolean
##### setPageNumbering(boolean isPageNumbering)
```
public void setPageNumbering(boolean isPageNumbering)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isPageNumbering | boolean |  |

##### isRemoveJavascript()
```
public boolean isRemoveJavascript()
```

Gets the Remove JavaScript flag

**Returns:**
boolean
##### setRemoveJavascript(boolean removeJavascript)
```
public void setRemoveJavascript(boolean removeJavascript)
```

Sets the Remove JavaScript flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeJavascript | boolean |  |

### PersonalStorageLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/personalstorageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class PersonalStorageLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading personal storage documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PersonalStorageLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFolder() | Folder which to be processed Default is Inbox
 |
| setFolder(String folder) | Set folder which to be processed
 |
| isConvertOwner() | {@inheritDoc} The owner will not be converted
 |
| isConvertOwned() | {@inheritDoc}
 |
| getDepth() | {@inheritDoc}
 |
| setDepth(int depth) | {@inheritDoc}
 |
##### PersonalStorageLoadOptions()
```
public PersonalStorageLoadOptions()
```

Initializes new instance of class.

##### getFolder()
```
public String getFolder()
```

Folder which to be processed Default is Inbox

**Returns:**
java.lang.String - Folder which to be processed

##### setFolder(String folder)
```
public void setFolder(String folder)
```

Set folder which to be processed

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folder | java.lang.String | folder
 |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted The owner will not be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### PresentationLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/presentationloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class PresentationLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions, IDocumentsContainerLoadOptions
```

Options for loading Presentation documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationLoadOptions() | Initializes new instance of EmailLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for rendering the presentation.
 |
| setDefaultFont(String value) | Default font for rendering the presentation.
 |
| getFontSubstitutes() | Substitute specific fonts when converting Presentation document.
 |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Presentation document.
 |
| getPassword() | Set password to unprotect protected document.
 |
| setPassword(String value) | Set password to unprotect protected document.
 |
| getHideComments() | Hide comments.
 |
| setHideComments(boolean value) | Hide comments.
 |
| getShowHiddenSlides() | Show hidden slides.
 |
| setShowHiddenSlides(boolean value) | Show hidden slides.
 |
| getSkipExternalResources() | {@inheritDoc}
 |
| setSkipExternalResources(boolean skip) | {@inheritDoc}
 |
| getWhitelistedResources() | {@inheritDoc}
 |
| setWhitelistedResources(List<String> whiteList) | {@inheritDoc}
 |
| getDocumentFontSources() |  |
| setDocumentFontSources(List<String> documentFontSources) |  |
| getNotesPosition() | Represents the way comments are printed with the slide.
 |
| setNotesPosition(PresentationNotesPosition notesPosition) | Represents the way notes are printed with the slide.
 |
| getCommentsPosition() |  |
| setCommentsPosition(PresentationCommentsPosition commentsPosition) |  |
| isConvertOwner() |  |
| setConvertOwner(boolean convertOwner) |  |
| isConvertOwned() |  |
| setConvertOwned(boolean convertOwned) |  |
| getDepth() |  |
| setDepth(int depth) |  |
##### PresentationLoadOptions()
```
public PresentationLoadOptions()
```

Initializes new instance of EmailLoadOptions class.

##### getFormat()
```
public final PresentationFileType getFormat()
```

Input document file type

**Returns:**
PresentationFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Presentation document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Presentation document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHideComments()
```
public final boolean getHideComments()
```

Hide comments.

**Returns:**
boolean
##### setHideComments(boolean value)
```
public final void setHideComments(boolean value)
```

Hide comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getShowHiddenSlides()
```
public final boolean getShowHiddenSlides()
```

Show hidden slides.

**Returns:**
boolean
##### setShowHiddenSlides(boolean value)
```
public final void setShowHiddenSlides(boolean value)
```

Show hidden slides.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSkipExternalResources()
```
public boolean getSkipExternalResources()
```

If true all external resource will not be loading with exception of the resources in the

**Returns:**
boolean
##### setSkipExternalResources(boolean skip)
```
public void setSkipExternalResources(boolean skip)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean |  |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

External resources that will be always loaded

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whiteList)
```
public void setWhitelistedResources(List<String> whiteList)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteList | java.util.List<java.lang.String> |  |

##### getDocumentFontSources()
```
public List<String> getDocumentFontSources()
```

**Returns:**
java.util.List<java.lang.String>
##### setDocumentFontSources(List<String> documentFontSources)
```
public void setDocumentFontSources(List<String> documentFontSources)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentFontSources | java.util.List<java.lang.String> |  |

##### getNotesPosition()
```
public PresentationNotesPosition getNotesPosition()
```

Represents the way comments are printed with the slide. Default is None.

**Returns:**
PresentationNotesPosition
##### setNotesPosition(PresentationNotesPosition notesPosition)
```
public void setNotesPosition(PresentationNotesPosition notesPosition)
```

Represents the way notes are printed with the slide. Default is None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| notesPosition | PresentationNotesPosition |  |

##### getCommentsPosition()
```
public PresentationCommentsPosition getCommentsPosition()
```

**Returns:**
PresentationCommentsPosition -
##### setCommentsPosition(PresentationCommentsPosition commentsPosition)
```
public void setCommentsPosition(PresentationCommentsPosition commentsPosition)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| commentsPosition | PresentationCommentsPosition |  |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### setConvertOwner(boolean convertOwner)
```
public void setConvertOwner(boolean convertOwner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwner | boolean |  |

##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### setConvertOwned(boolean convertOwned)
```
public void setConvertOwned(boolean convertOwned)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwned | boolean |  |

##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### PublisherLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/publisherloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class PublisherLoadOptions extends LoadOptions
```

Options for loading Publisher documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PublisherLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type.
 |
| setFormat(PublisherFileType format) | Sets Input document file type.
 |
##### PublisherLoadOptions()
```
public PublisherLoadOptions()
```

Initializes new instance of class.

##### getFormat()
```
public PublisherFileType getFormat()
```

Gets Input document file type.

**Returns:**
PublisherFileType
##### setFormat(PublisherFileType format)
```
public void setFormat(PublisherFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | PublisherFileType |  |

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/spreadsheetloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.lang.Cloneable, java.io.Serializable, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class SpreadsheetLoadOptions extends LoadOptions implements Cloneable, Serializable, IDocumentsContainerLoadOptions
```

Options for loading Spreadsheet documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Initializes new instance of SpreadsheetLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSheets() | Get sheet name to convert
 |
| setSheets(List<String> sheets) | Set sheet name to convert
 |
| getCultureInfo() | Get the system culture info at the time file is loaded
 |
| setCultureInfo(System.Globalization.CultureInfo cultureInfo) | Set the system culture info at the time file is loaded
 |
| getFormat() |  |
| getDefaultFont() | Default font for spreadsheet document.
 |
| setDefaultFont(String value) | Default font for spreadsheet document.
 |
| getFontSubstitutes() | Substitute specific fonts when converting spreadsheet document.
 |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting spreadsheet document.
 |
| getShowGridLines() | Show grid lines when converting Excel files.
 |
| setShowGridLines(boolean value) | Show grid lines when converting Excel files.
 |
| getShowHiddenSheets() | Show hidden sheets when converting Excel files.
 |
| setShowHiddenSheets(boolean value) | Show hidden sheets when converting Excel files.
 |
| getOnePagePerSheet() | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
 |
| setOnePagePerSheet(boolean value) | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
 |
| getAllColumnsInOnePagePerSheet() | Gets AllColumnsInOnePagePerSheet property
 |
| setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet) | Sets AllColumnsInOnePagePerSheet property
 |
| getOptimizePdfSize() | If True and converting to Pdf the conversion is optimized for better file size than print quality.
 |
| setOptimizePdfSize(boolean value) | If True and converting to Pdf the conversion is optimized for better file size than print quality.
 |
| getConvertRange() | Convert specific range when converting to other than spreadsheet format.
 |
| setConvertRange(String value) | Convert specific range when converting to other than spreadsheet format.
 |
| getSkipEmptyRowsAndColumns() | Skips empty rows and columns when converting.
 |
| setSkipEmptyRowsAndColumns(boolean value) | Skips empty rows and columns when converting.
 |
| getPassword() | Set password to unprotect protected document.
 |
| setPassword(String value) | Set password to unprotect protected document.
 |
| getHideComments() | Hide comments.
 |
| setHideComments(boolean value) | Hide comments.
 |
| isCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects.
 |
| setCheckExcelRestriction(boolean checkExcelRestriction) |  |
| getSheetIndexes() | Gets List of sheet indexes to convert.
 |
| setSheetIndexes(List<Integer> sheetIndexes) | Sets List of sheet indexes to convert.
 |
| isAutoFitRows() | Autofits all rows when converting
 |
| setAutoFitRows(boolean autoFitRows) |  |
| getResetFontFolders() | Reset font folders before loading document
 |
| setResetFontFolders(boolean resetFontFolders) |  |
| deepClone() | Clones current instance.
 |
| getRowsPerPage() | Split a worksheet into pages by rows.
 |
| setRowsPerPage(int rowsPerPage) | Split a worksheet into pages by rows.
 |
| getColumnsPerPage() | Split a worksheet into pages by columns.
 |
| setColumnsPerPage(int columnsPerPage) | Split a worksheet into pages by columns.
 |
| isConvertOwner() |  |
| setConvertOwner(boolean convertOwner) |  |
| isConvertOwned() |  |
| setConvertOwned(boolean convertOwned) |  |
| getDepth() |  |
| setDepth(int depth) |  |
##### SpreadsheetLoadOptions()
```
public SpreadsheetLoadOptions()
```

Initializes new instance of SpreadsheetLoadOptions class.

##### getSheets()
```
public List<String> getSheets()
```

Get sheet name to convert

**Returns:**
java.util.List<java.lang.String>
##### setSheets(List<String> sheets)
```
public void setSheets(List<String> sheets)
```

Set sheet name to convert

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sheets | java.util.List<java.lang.String> |  |

##### getCultureInfo()
```
public System.Globalization.CultureInfo getCultureInfo()
```

Get the system culture info at the time file is loaded

**Returns:**
com.aspose.ms.System.Globalization.CultureInfo
##### setCultureInfo(System.Globalization.CultureInfo cultureInfo)
```
public void setCultureInfo(System.Globalization.CultureInfo cultureInfo)
```

Set the system culture info at the time file is loaded

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cultureInfo | com.aspose.ms.System.Globalization.CultureInfo |  |

##### getFormat()
```
public final SpreadsheetFileType getFormat()
```

Input document file type

**Returns:**
SpreadsheetFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for spreadsheet document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for spreadsheet document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting spreadsheet document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting spreadsheet document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getShowGridLines()
```
public final boolean getShowGridLines()
```

Show grid lines when converting Excel files.

**Returns:**
boolean
##### setShowGridLines(boolean value)
```
public final void setShowGridLines(boolean value)
```

Show grid lines when converting Excel files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getShowHiddenSheets()
```
public final boolean getShowHiddenSheets()
```

Show hidden sheets when converting Excel files.

**Returns:**
boolean
##### setShowHiddenSheets(boolean value)
```
public final void setShowHiddenSheets(boolean value)
```

Show hidden sheets when converting Excel files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOnePagePerSheet()
```
public final boolean getOnePagePerSheet()
```

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is false.

**Returns:**
boolean
##### setOnePagePerSheet(boolean value)
```
public final void setOnePagePerSheet(boolean value)
```

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAllColumnsInOnePagePerSheet()
```
public boolean getAllColumnsInOnePagePerSheet()
```

Gets AllColumnsInOnePagePerSheet property

**Returns:**
boolean - true if fit all columns to ont page

##### setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)
```
public void setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)
```

Sets AllColumnsInOnePagePerSheet property

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allColumnsInOnePagePerSheet | boolean | AllColumnsInOnePagePerSheet property
 |

##### getOptimizePdfSize()
```
public final boolean getOptimizePdfSize()
```

If True and converting to Pdf the conversion is optimized for better file size than print quality.

**Returns:**
boolean
##### setOptimizePdfSize(boolean value)
```
public final void setOptimizePdfSize(boolean value)
```

If True and converting to Pdf the conversion is optimized for better file size than print quality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertRange()
```
public final String getConvertRange()
```

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

**Returns:**
java.lang.String
##### setConvertRange(String value)
```
public final void setConvertRange(String value)
```

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSkipEmptyRowsAndColumns()
```
public final boolean getSkipEmptyRowsAndColumns()
```

Skips empty rows and columns when converting. Default is True.

**Returns:**
boolean
##### setSkipEmptyRowsAndColumns(boolean value)
```
public final void setSkipEmptyRowsAndColumns(boolean value)
```

Skips empty rows and columns when converting. Default is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHideComments()
```
public final boolean getHideComments()
```

Hide comments.

**Returns:**
boolean
##### setHideComments(boolean value)
```
public final void setHideComments(boolean value)
```

Hide comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### isCheckExcelRestriction()
```
public boolean isCheckExcelRestriction()
```

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

**Returns:**
boolean - check restriction flag

##### setCheckExcelRestriction(boolean checkExcelRestriction)
```
public void setCheckExcelRestriction(boolean checkExcelRestriction)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| checkExcelRestriction | boolean |  |

##### getSheetIndexes()
```
public List<Integer> getSheetIndexes()
```

Gets List of sheet indexes to convert.

**Returns:**
java.util.List<java.lang.Integer>
##### setSheetIndexes(List<Integer> sheetIndexes)
```
public void setSheetIndexes(List<Integer> sheetIndexes)
```

Sets List of sheet indexes to convert. The indexes must be zero-based

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sheetIndexes | java.util.List<java.lang.Integer> |  |

##### isAutoFitRows()
```
public boolean isAutoFitRows()
```

Autofits all rows when converting

**Returns:**
boolean
##### setAutoFitRows(boolean autoFitRows)
```
public void setAutoFitRows(boolean autoFitRows)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoFitRows | boolean |  |

##### getResetFontFolders()
```
public boolean getResetFontFolders()
```

Reset font folders before loading document

**Returns:**
boolean
##### setResetFontFolders(boolean resetFontFolders)
```
public void setResetFontFolders(boolean resetFontFolders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resetFontFolders | boolean |  |

##### deepClone()
```
public final Object deepClone()
```

Clones current instance.

**Returns:**
java.lang.Object -
##### getRowsPerPage()
```
public int getRowsPerPage()
```

Split a worksheet into pages by rows. Default is 0, no pagination.

**Returns:**
int
##### setRowsPerPage(int rowsPerPage)
```
public void setRowsPerPage(int rowsPerPage)
```

Split a worksheet into pages by rows. Default is 0, no pagination.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowsPerPage | int |  |

##### getColumnsPerPage()
```
public int getColumnsPerPage()
```

Split a worksheet into pages by columns. Default is 0, no pagination.

**Returns:**
int
##### setColumnsPerPage(int columnsPerPage)
```
public void setColumnsPerPage(int columnsPerPage)
```

Split a worksheet into pages by columns. Default is 0, no pagination.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnsPerPage | int |  |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### setConvertOwner(boolean convertOwner)
```
public void setConvertOwner(boolean convertOwner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwner | boolean |  |

##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### setConvertOwned(boolean convertOwned)
```
public void setConvertOwned(boolean convertOwned)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwned | boolean |  |

##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### TsvLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/tsvloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions, com.groupdocs.conversion.options.load.SpreadsheetLoadOptions
```
public class TsvLoadOptions extends SpreadsheetLoadOptions
```

Options for loading Tsv documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| TsvLoadOptions() | Initializes new instance of class.
 |
##### TsvLoadOptions()
```
public TsvLoadOptions()
```

Initializes new instance of class.

### TxtLeadingSpacesOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/txtleadingspacesoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class TxtLeadingSpacesOptions extends Enumeration implements Serializable
```

Describes txt leading spaces options enumeration.

#### Constructors

| Constructor | Description |
| --- | --- |
| TxtLeadingSpacesOptions() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| ConvertToIndent | Converts leading spaces to indents.
 |
| Preserve | Preserves leading spaces.
 |
| Trim | Trims leading spaces.
 |
##### TxtLeadingSpacesOptions()
```
public TxtLeadingSpacesOptions()
```

Serialization constructor

##### ConvertToIndent
```
public static final TxtLeadingSpacesOptions ConvertToIndent
```

Converts leading spaces to indents.

##### Preserve
```
public static final TxtLeadingSpacesOptions Preserve
```

Preserves leading spaces.

##### Trim
```
public static final TxtLeadingSpacesOptions Trim
```

Trims leading spaces.

### TxtLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/txtloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class TxtLoadOptions extends LoadOptions implements Serializable
```

Options for loading Txt documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| TxtLoadOptions() | Initializes new instance of TxtLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDetectNumberingWithWhitespaces() | Allows to specify how numbered list items are recognized when plain text document is converted.
 |
| setDetectNumberingWithWhitespaces(boolean value) | Allows to specify how numbered list items are recognized when plain text document is converted.
 |
| getTrailingSpacesOptions() | Gets or sets preferred option of a trailing space handling.
 |
| setTrailingSpacesOptions(TxtTrailingSpacesOptions value) | Gets or sets preferred option of a trailing space handling.
 |
| getLeadingSpacesOptions() | Gets or sets preferred option of a leading space handling.
 |
| setLeadingSpacesOptions(TxtLeadingSpacesOptions value) | Gets or sets preferred option of a leading space handling.
 |
| getEncoding() | Gets or sets the encoding that will be used when loading Txt document.
 |
| getEncodingInternal() |  |
| setEncoding(Charset value) | Gets or sets the encoding that will be used when loading Txt document.
 |
##### TxtLoadOptions()
```
public TxtLoadOptions()
```

Initializes new instance of TxtLoadOptions class.

##### getFormat()
```
public WordProcessingFileType getFormat()
```

Input document file type

**Returns:**
WordProcessingFileType
##### getDetectNumberingWithWhitespaces()
```
public final boolean getDetectNumberingWithWhitespaces()
```

Allows to specify how numbered list items are recognized when plain text document is converted.
The default value is true.

<br />

*** ** * ** ***

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with
either dot, right bracket or bullet symbols (such as "\\u2022", "\*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters:
list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

<br />

**Returns:**
boolean
##### setDetectNumberingWithWhitespaces(boolean value)
```
public final void setDetectNumberingWithWhitespaces(boolean value)
```

Allows to specify how numbered list items are recognized when plain text document is converted.
The default value is true.

<br />

*** ** * ** ***

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with
either dot, right bracket or bullet symbols (such as "\\u2022", "\*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters:
list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTrailingSpacesOptions()
```
public final TxtTrailingSpacesOptions getTrailingSpacesOptions()
```

Gets or sets preferred option of a trailing space handling.
Default value is TxtTrailingSpacesOptions.Trim.

**Returns:**
TxtTrailingSpacesOptions
##### setTrailingSpacesOptions(TxtTrailingSpacesOptions value)
```
public final void setTrailingSpacesOptions(TxtTrailingSpacesOptions value)
```

Gets or sets preferred option of a trailing space handling.
Default value is TxtTrailingSpacesOptions.Trim.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TxtTrailingSpacesOptions |  |

##### getLeadingSpacesOptions()
```
public final TxtLeadingSpacesOptions getLeadingSpacesOptions()
```

Gets or sets preferred option of a leading space handling.
Default value is TxtLeadingSpacesOptions.ConvertToIndent.

**Returns:**
TxtLeadingSpacesOptions
##### setLeadingSpacesOptions(TxtLeadingSpacesOptions value)
```
public final void setLeadingSpacesOptions(TxtLeadingSpacesOptions value)
```

Gets or sets preferred option of a leading space handling.
Default value is TxtLeadingSpacesOptions.ConvertToIndent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TxtLeadingSpacesOptions |  |

##### getEncoding()
```
public final Charset getEncoding()
```

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

**Returns:**
java.nio.charset.Charset
##### getEncodingInternal()
```
public System.Text.Encoding getEncodingInternal()
```

**Returns:**
com.aspose.ms.System.Text.Encoding
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

### TxtTrailingSpacesOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/txttrailingspacesoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class TxtTrailingSpacesOptions extends Enumeration implements Serializable
```

Describes txt trailing spaces options enumeration.

#### Constructors

| Constructor | Description |
| --- | --- |
| TxtTrailingSpacesOptions() | Serialization constructor
 |
#### Fields

| Field | Description |
| --- | --- |
| Preserve | Preserves trailing spaces
 |
| Trim | Trims trailing spaces
 |
##### TxtTrailingSpacesOptions()
```
public TxtTrailingSpacesOptions()
```

Serialization constructor

##### Preserve
```
public static final TxtTrailingSpacesOptions Preserve
```

Preserves trailing spaces

##### Trim
```
public static final TxtTrailingSpacesOptions Trim
```

Trims trailing spaces

### VcfLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/vcfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class VcfLoadOptions extends LoadOptions
```

Options for loading Vcf documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| VcfLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets or sets the encoding that will be used when loading Vcf document.
 |
| setEncoding(System.Text.Encoding encoding) |  |
##### VcfLoadOptions()
```
public VcfLoadOptions()
```

Initializes new instance of class.

##### getEncoding()
```
public System.Text.Encoding getEncoding()
```

Gets or sets the encoding that will be used when loading Vcf document. Default is Encoding.Default.

**Returns:**
com.aspose.ms.System.Text.Encoding
##### setEncoding(System.Text.Encoding encoding)
```
public void setEncoding(System.Text.Encoding encoding)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | com.aspose.ms.System.Text.Encoding |  |

### VideoLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/videoloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class VideoLoadOptions extends LoadOptions
```

Options for loading video documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| VideoLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getVideoConnector() |  |
| setVideoConnector(IVideoConnector videoConnector) | Set video document connector
 |
##### VideoLoadOptions()
```
public VideoLoadOptions()
```

Initializes new instance of class.

##### getVideoConnector()
```
public IVideoConnector getVideoConnector()
```

**Returns:**
IVideoConnector
##### setVideoConnector(IVideoConnector videoConnector)
```
public void setVideoConnector(IVideoConnector videoConnector)
```

Set video document connector

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| videoConnector | IVideoConnector | Video connector instance
 |

### WebLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/webloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions
```
public class WebLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions, IPageNumberingLoadOptions
```

Options for loading web documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| WebLoadOptions() | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type.
 |
| setFormat(WebFileType format) | Sets Input document file type.
 |
| isPageNumbering() |  |
| setPageNumbering(boolean pageNumbering) |  |
| getBasePath() |  |
| setBasePath(String basePath) |  |
| getEncoding() |  |
| setEncoding(String encoding) |  |
| getResourceLoadingTimeout() | Gets timeout for loading external resources in milliseconds
 |
| setResourceLoadingTimeout(long resourceLoadingTimeout) | Sets timeout for loading external resources in milliseconds
 |
| getSkipExternalResources() | {@inheritDoc}
 |
| setSkipExternalResources(boolean skip) | {@inheritDoc}
 |
| getWhitelistedResources() | {@inheritDoc}
 |
| setWhitelistedResources(List<String> whiteList) | {@inheritDoc}
 |
| isUsePdf() | Use pdf for the conversion.
 |
| setUsePdf(boolean usePdf) |  |
##### WebLoadOptions()
```
public WebLoadOptions()
```

Initializes new instance of class.

##### getFormat()
```
public WebFileType getFormat()
```

Gets Input document file type.

**Returns:**
WebFileType
##### setFormat(WebFileType format)
```
public void setFormat(WebFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | WebFileType |  |

##### isPageNumbering()
```
public boolean isPageNumbering()
```

Enable or disable generation of page numbering in converted document. Default: false

**Returns:**
boolean
##### setPageNumbering(boolean pageNumbering)
```
public void setPageNumbering(boolean pageNumbering)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbering | boolean |  |

##### getBasePath()
```
public String getBasePath()
```

**Returns:**
java.lang.String
##### setBasePath(String basePath)
```
public void setBasePath(String basePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| basePath | java.lang.String |  |

##### getEncoding()
```
public String getEncoding()
```

**Returns:**
java.lang.String
##### setEncoding(String encoding)
```
public void setEncoding(String encoding)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | java.lang.String |  |

##### getResourceLoadingTimeout()
```
public long getResourceLoadingTimeout()
```

Gets timeout for loading external resources in milliseconds

**Returns:**
long
##### setResourceLoadingTimeout(long resourceLoadingTimeout)
```
public void setResourceLoadingTimeout(long resourceLoadingTimeout)
```

Sets timeout for loading external resources in milliseconds

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resourceLoadingTimeout | long |  |

##### getSkipExternalResources()
```
public boolean getSkipExternalResources()
```

If true all external resource will not be loading with exception of the resources in the

**Returns:**
boolean
##### setSkipExternalResources(boolean skip)
```
public void setSkipExternalResources(boolean skip)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean |  |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

External resources that will be always loaded

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whiteList)
```
public void setWhitelistedResources(List<String> whiteList)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteList | java.util.List<java.lang.String> |  |

##### isUsePdf()
```
public boolean isUsePdf()
```

Use pdf for the conversion. Default: false

**Returns:**
boolean
##### setUsePdf(boolean usePdf)
```
public void setUsePdf(boolean usePdf)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| usePdf | boolean |  |

### WordProcessingBookmarksOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/wordprocessingbookmarksoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public class WordProcessingBookmarksOptions extends ValueObject implements Serializable
```

Options for handling bookmarks in WordProcessing

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingBookmarksOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getBookmarksOutlineLevel() | Specifies the default level in the document outline at which to display Word bookmarks.
 |
| setBookmarksOutlineLevel(int value) | Specifies the default level in the document outline at which to display Word bookmarks.
 |
| getHeadingsOutlineLevels() | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.
 |
| setHeadingsOutlineLevels(int value) | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.
 |
| getExpandedOutlineLevels() | Specifies how many levels in the document outline to show expanded when the file is viewed.
 |
| setExpandedOutlineLevels(int value) | Specifies how many levels in the document outline to show expanded when the file is viewed.
 |
##### WordProcessingBookmarksOptions()
```
public WordProcessingBookmarksOptions()
```

##### getBookmarksOutlineLevel()
```
public final int getBookmarksOutlineLevel()
```

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.

**Returns:**
int
##### setBookmarksOutlineLevel(int value)
```
public final void setBookmarksOutlineLevel(int value)
```

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeadingsOutlineLevels()
```
public final int getHeadingsOutlineLevels()
```

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.

**Returns:**
int
##### setHeadingsOutlineLevels(int value)
```
public final void setHeadingsOutlineLevels(int value)
```

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExpandedOutlineLevels()
```
public final int getExpandedOutlineLevels()
```

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.

**Returns:**
int
##### setExpandedOutlineLevels(int value)
```
public final void setExpandedOutlineLevels(int value)
```

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/wordprocessingloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class WordProcessingLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions, IPageNumberingLoadOptions, IDocumentsContainerLoadOptions
```

Options for loading WordProcessing documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingLoadOptions() | Initializes new instance of WordProcessingLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Words document.
 |
| setDefaultFont(String value) | Default font for Words document.
 |
| getAutoFontSubstitution() | If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts.
 |
| setAutoFontSubstitution(boolean value) | If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts.
 |
| getFontSubstitutes() | Substitute specific fonts when converting Words document.
 |
| isEmbedTrueTypeFonts() | If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document.
 |
| setEmbedTrueTypeFonts(boolean embedTrueTypeFonts) |  |
| isUpdatePageLayout() | Update page layout after loading.
 |
| setUpdatePageLayout(boolean updatePageLayout) |  |
| isUpdateFields() | Update fields after loading.
 |
| setUpdateFields(boolean updateFields) |  |
| isKeepDateFieldOriginalValue() | Keep original value of date field.
 |
| setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue) | Sets Keep original value of date field.
 |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Words document.
 |
| getPassword() | Set password to unprotect protected document.
 |
| setPassword(String value) | Set password to unprotect protected document.
 |
| getHideWordTrackedChanges() | Hide markup and track changes for Word documents.
 |
| setHideWordTrackedChanges(boolean value) | Hide markup and track changes for Word documents.
 |
| setHideComments(boolean value) | Hide comments.
 |
| getBookmarkOptions() | Bookmarks options
 |
| setBookmarkOptions(WordProcessingBookmarksOptions value) | Bookmarks options
 |
| isPreserveFontFields() | Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
 |
| setPreserveFontFields(boolean preserveFontFields) | Sets preserveFontFields flag
 |
| isUseTextShaper() | Specifies whether to use a text shaper for better kerning display.
 |
| setUseTextShaper(boolean isUseTextShaper) | Specifies whether to use a text shaper for better kerning display.
 |
| isPreserveDocumentStructure() | Determines whether the document structure should be preserved when converting to PDF (default is false).
 |
| setPreserveDocumentStructure(boolean preserveDocumentStructure) |  |
| getSkipExternalResources() | {@inheritDoc}
 |
| setSkipExternalResources(boolean skip) | {@inheritDoc}
 |
| getWhitelistedResources() | {@inheritDoc}
 |
| setWhitelistedResources(List<String> whiteList) | {@inheritDoc}
 |
| getCommentDisplayMode() | Specifies how comments should be displayed in the output document.
 |
| setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode) |  |
| getShowFullCommenterName() | Show full commenter name in comments.
 |
| setShowFullCommenterName(boolean showFullCommenterName) |  |
| isPageNumbering() | Enable or disable generation of page numbering in converted document.
 |
| setPageNumbering(boolean isPageNumbering) |  |
| getHyphenationOptions() | Gets hyphenation options for WordProcessing documents.
 |
| setHyphenationOptions(HyphenationOptions hyphenationOptions) | Sets hyphenation options for WordProcessing documents.
 |
| isInterruptThreadIfImageExceptionThrown() | Gets InterruptThreadIfImageExceptionThrown flag Default: false If true then interrupt the main conversion thread if an exception in a image processing thread occurred
 |
| setInterruptThreadIfImageExceptionThrown(boolean interruptThreadIfImageExceptionThrown) | Sets InterruptThreadIfImageExceptionThrown flag
 |
| isAutoDetectRtlDirection() | When enabled (default), paragraphs and runs whose text is dominantly right-to-left (RTL) will have their bidi flags repaired before conversion.
 |
| setAutoDetectRtlDirection(boolean autoDetectRtlDirection) | Sets the autoDetectRtlDirection
 |
| isConvertOwner() |  |
| setConvertOwner(boolean convertOwner) |  |
| isConvertOwned() |  |
| setConvertOwned(boolean convertOwned) |  |
| getDepth() |  |
| setDepth(int depth) |  |
##### WordProcessingLoadOptions()
```
public WordProcessingLoadOptions()
```

Initializes new instance of WordProcessingLoadOptions class.

##### getFormat()
```
public final WordProcessingFileType getFormat()
```

Input document file type

**Returns:**
WordProcessingFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Words document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Words document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAutoFontSubstitution()
```
public final boolean getAutoFontSubstitution()
```

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled,
GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources.
Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.

**Returns:**
boolean
##### setAutoFontSubstitution(boolean value)
```
public final void setAutoFontSubstitution(boolean value)
```

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled,
GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources.
Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Words document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### isEmbedTrueTypeFonts()
```
public boolean isEmbedTrueTypeFonts()
```

If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: false

**Returns:**
boolean
##### setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
```
public void setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| embedTrueTypeFonts | boolean |  |

##### isUpdatePageLayout()
```
public boolean isUpdatePageLayout()
```

Update page layout after loading. Default: false

**Returns:**
boolean
##### setUpdatePageLayout(boolean updatePageLayout)
```
public void setUpdatePageLayout(boolean updatePageLayout)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updatePageLayout | boolean |  |

##### isUpdateFields()
```
public boolean isUpdateFields()
```

Update fields after loading. Default: false

**Returns:**
boolean
##### setUpdateFields(boolean updateFields)
```
public void setUpdateFields(boolean updateFields)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updateFields | boolean |  |

##### isKeepDateFieldOriginalValue()
```
public boolean isKeepDateFieldOriginalValue()
```

Keep original value of date field. Default: false

**Returns:**
boolean
##### setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue)
```
public void setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue)
```

Sets Keep original value of date field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keepDateFieldOriginalValue | boolean |  |

##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Words document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHideWordTrackedChanges()
```
public final boolean getHideWordTrackedChanges()
```

Hide markup and track changes for Word documents.

**Returns:**
boolean
##### setHideWordTrackedChanges(boolean value)
```
public final void setHideWordTrackedChanges(boolean value)
```

Hide markup and track changes for Word documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### setHideComments(boolean value)
```
public final void setHideComments(boolean value)
```

Hide comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getBookmarkOptions()
```
public final WordProcessingBookmarksOptions getBookmarkOptions()
```

Bookmarks options

**Returns:**
WordProcessingBookmarksOptions
##### setBookmarkOptions(WordProcessingBookmarksOptions value)
```
public final void setBookmarkOptions(WordProcessingBookmarksOptions value)
```

Bookmarks options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WordProcessingBookmarksOptions |  |

##### isPreserveFontFields()
```
public boolean isPreserveFontFields()
```

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

**Returns:**
boolean - preserveFontFields flag

##### setPreserveFontFields(boolean preserveFontFields)
```
public void setPreserveFontFields(boolean preserveFontFields)
```

Sets preserveFontFields flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preserveFontFields | boolean | preserve Microsoft Word form fields as form fields in PDF or convert them to text
 |

##### isUseTextShaper()
```
public boolean isUseTextShaper()
```

Specifies whether to use a text shaper for better kerning display. Default is false.

**Returns:**
boolean
##### setUseTextShaper(boolean isUseTextShaper)
```
public void setUseTextShaper(boolean isUseTextShaper)
```

Specifies whether to use a text shaper for better kerning display. Default is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isUseTextShaper | boolean | isUseTextShaper flag
 |

##### isPreserveDocumentStructure()
```
public boolean isPreserveDocumentStructure()
```

Determines whether the document structure should be preserved when converting to PDF (default is false). Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

**Returns:**
boolean
##### setPreserveDocumentStructure(boolean preserveDocumentStructure)
```
public void setPreserveDocumentStructure(boolean preserveDocumentStructure)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preserveDocumentStructure | boolean |  |

##### getSkipExternalResources()
```
public boolean getSkipExternalResources()
```

If true all external resource will not be loading with exception of the resources in the

**Returns:**
boolean
##### setSkipExternalResources(boolean skip)
```
public void setSkipExternalResources(boolean skip)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean |  |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

External resources that will be always loaded

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whiteList)
```
public void setWhitelistedResources(List<String> whiteList)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteList | java.util.List<java.lang.String> |  |

##### getCommentDisplayMode()
```
public WordProcessingCommentDisplay getCommentDisplayMode()
```

Specifies how comments should be displayed in the output document. Default is ShowInBalloons.

**Returns:**
WordProcessingCommentDisplay
##### setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode)
```
public void setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| commentDisplayMode | WordProcessingCommentDisplay |  |

##### getShowFullCommenterName()
```
public boolean getShowFullCommenterName()
```

Show full commenter name in comments. Default is false.

**Returns:**
boolean
##### setShowFullCommenterName(boolean showFullCommenterName)
```
public void setShowFullCommenterName(boolean showFullCommenterName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| showFullCommenterName | boolean |  |

##### isPageNumbering()
```
public boolean isPageNumbering()
```

Enable or disable generation of page numbering in converted document. Default: false

**Returns:**
boolean
##### setPageNumbering(boolean isPageNumbering)
```
public void setPageNumbering(boolean isPageNumbering)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isPageNumbering | boolean |  |

##### getHyphenationOptions()
```
public HyphenationOptions getHyphenationOptions()
```

Gets hyphenation options for WordProcessing documents.

**Returns:**
HyphenationOptions
##### setHyphenationOptions(HyphenationOptions hyphenationOptions)
```
public void setHyphenationOptions(HyphenationOptions hyphenationOptions)
```

Sets hyphenation options for WordProcessing documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| hyphenationOptions | HyphenationOptions |  |

##### isInterruptThreadIfImageExceptionThrown()
```
public boolean isInterruptThreadIfImageExceptionThrown()
```

Gets InterruptThreadIfImageExceptionThrown flag Default: false If true then interrupt the main conversion thread if an exception in a image processing thread occurred

**Returns:**
boolean
##### setInterruptThreadIfImageExceptionThrown(boolean interruptThreadIfImageExceptionThrown)
```
public void setInterruptThreadIfImageExceptionThrown(boolean interruptThreadIfImageExceptionThrown)
```

Sets InterruptThreadIfImageExceptionThrown flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| interruptThreadIfImageExceptionThrown | boolean |  |

##### isAutoDetectRtlDirection()
```
public boolean isAutoDetectRtlDirection()
```

When enabled (default), paragraphs and runs whose text is dominantly right-to-left (RTL) will have their bidi flags repaired before conversion.

This matches the heuristic applied by Microsoft Word and LibreOffice and
fixes rendering of Arabic/Hebrew documents produced by generators
(notably Google Docs) that emit OOXML without

and with

 on runs containing only RTL script.

Set to
false
 to preserve strict OOXML interpretation of the
source markup.

**Returns:**
boolean
##### setAutoDetectRtlDirection(boolean autoDetectRtlDirection)
```
public void setAutoDetectRtlDirection(boolean autoDetectRtlDirection)
```

Sets the autoDetectRtlDirection

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoDetectRtlDirection | boolean | autoDetectRtlDirection
 |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### setConvertOwner(boolean convertOwner)
```
public void setConvertOwner(boolean convertOwner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwner | boolean |  |

##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### setConvertOwned(boolean convertOwned)
```
public void setConvertOwned(boolean convertOwned)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwned | boolean |  |

##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### XmlLoadOptions
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.options.load/xmlloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions, com.groupdocs.conversion.options.load.WebLoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class XmlLoadOptions extends WebLoadOptions implements Serializable
```

Options for loading XML documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| XmlLoadOptions() | Initializes new instance of XmlLoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getXslFoFactory() | XSL-FO document stream to convert XML-FO using XSL.
 |
| setXslFoFactory(Supplier<System.IO.Stream> value) | XSL document stream to convert XML-FO using XSL.
 |
| getXsltFactory() | get XSLT document stream to convert XML performing XSL transformation to HTML.
 |
| setXsltFactory(Supplier<System.IO.Stream> value) | set XSLT document stream to convert XML performing XSL transformation to HTML.
 |
| isUseAsDataSource() | Use Xml document as data source
 |
| setUseAsDataSource(boolean useAsDataSource) | Set use Xml document as data source
 |
##### XmlLoadOptions()
```
public XmlLoadOptions()
```

Initializes new instance of XmlLoadOptions class.

##### getXslFoFactory()
```
public final Supplier<System.IO.Stream> getXslFoFactory()
```

XSL-FO document stream to convert XML-FO using XSL.

**Returns:**
java.util.function.Supplier<com.aspose.ms.System.IO.Stream>
##### setXslFoFactory(Supplier<System.IO.Stream> value)
```
public final void setXslFoFactory(Supplier<System.IO.Stream> value)
```

XSL document stream to convert XML-FO using XSL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.function.Supplier<com.aspose.ms.System.IO.Stream> |  |

##### getXsltFactory()
```
public final Supplier<System.IO.Stream> getXsltFactory()
```

get XSLT document stream to convert XML performing XSL transformation to HTML.

**Returns:**
java.util.function.Supplier<com.aspose.ms.System.IO.Stream>
##### setXsltFactory(Supplier<System.IO.Stream> value)
```
public final void setXsltFactory(Supplier<System.IO.Stream> value)
```

set XSLT document stream to convert XML performing XSL transformation to HTML.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.function.Supplier<com.aspose.ms.System.IO.Stream> |  |

##### isUseAsDataSource()
```
public boolean isUseAsDataSource()
```

Use Xml document as data source

**Returns:**
boolean - true if use

##### setUseAsDataSource(boolean useAsDataSource)
```
public void setUseAsDataSource(boolean useAsDataSource)
```

Set use Xml document as data source

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useAsDataSource | boolean | use Xml document as data source
 |

### com.groupdocs.conversion.reporting
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.reporting.md

The GroupDocs.Conversion.Options.Load namespace provides classes to implement converter listening.
**Learn more** More about monitoring conversion progress: Listening to conversion process events

#### Interfaces

| Interface | Description |
| --- | --- |
| IConverterListener | Defines the methods that are used to perform converter listening. |

### IConverterListener
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.reporting/iconverterlistener.md

### com.groupdocs.conversion
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion.md

The scope for GroupDocs.Conversion classes

#### Classes

| Class | Description |
| --- | --- |
| Converter | Represents main class that controls document conversion process. |
| ConverterSettings | Defines settings for customizing Converter behaviour. |

### Converter
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion/converter.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Converter implements Closeable
```

Represents main class that controls document conversion process.

#### Constructors

| Constructor | Description |
| --- | --- |
| Converter() | Initializes new instance of class for fluent conversion setup.
 |
| Converter(Supplier<InputStream> document) | Initializes new instance of Converter class.
 |
| Converter(Supplier<InputStream> document, ConverterSettingsProvider settings) | Initializes new instance of Converter class.
 |
| Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions) | Initializes new instance of Converter class.
 |
| Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of Converter class.
 |
| Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions) | Initializes new instance of class.
 |
| Converter(Supplier<InputStream> document, LoadOptionsForNameFileTypeStreamProvider loadOptions) | Initializes new instance of class.
 |
| Converter(Supplier<InputStream> document, LoadOptionsForNameFileTypeStreamProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of class.
 |
| Converter(String filePath) | Initializes new instance of Converter class.
 |
| Converter(String filePath, ConverterSettingsProvider settings) | Initializes new instance of Converter class.
 |
| Converter(String filePath, LoadOptionsProvider loadOptions) | Initializes new instance of Converter class.
 |
| Converter(String filePath, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of Converter class.
 |
| Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions) | Initializes new instance of class.
 |
| Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings) |  |
| Converter(String filePath, LoadOptionsForNameFileTypeStreamProvider loadOptions) |  |
| Converter(String filePath, LoadOptionsForNameFileTypeStreamProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of class.
 |
#### Methods

| Method | Description |
| --- | --- |
| tweakPackageUtil(String vendor, String version, String specTitle) |  |
| convert(SaveDocumentStream document, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(String filePath, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SavePageStream document, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(SavePageStreamForFileType document, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions) | Converts source document.
 |
| convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document.
 |
| withSettings(ConverterSettingsProvider settingsProvider) |  |
| load(String fileName) |  |
| load(String[] fileNames) |  |
| load(DocumentStreamProvider documentStreamProvider) |  |
| load(DocumentStreamsProvider documentStreamProvider) |  |
| getDocumentInfo() | Gets source document info - pages count and other document properties specific to the file type.
 |
| isDocumentPasswordProtected() | Checks is source document is password protected
 |
| getPossibleConversions() | Gets possible conversions for the source document.
 |
| getAllPossibleConversions() | Gets all supported conversions **Learn more** Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
 |
| getPossibleConversions(String extension) | Gets supported conversions for provided document extension Converter.GetPossibleConversions(".docx") Converter.GetPossibleConversions("docx") **Learn more** Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
 |
| dispose() | Releases resources.
 |
| close() |  |
##### Converter()
```
public Converter()
```

Initializes new instance of class for fluent conversion setup. Sample fluent conversion usage: `
var converter = new Converter();
` `
converter`
`
.Load("")`
`
.ConvertTo("")`
`
.Convert();
` `
converter`
`
.WithSettings(() => new ConverterSettings())`
`
.Load("").WithOptions(new PdfLoadOptions())`
`
.ConvertTo("").WithOptions(new PdfConvertOptions())`
`
.OnConversionCompleted(convertedDocumentStream => { })`
`
.Convert();
` `
converter`
`
.Load("").WithOptions(new PdfLoadOptions())`
`
.ConvertByPageTo((number => new FileStream("", FileMode.Create))).WithOptions(new PdfConvertOptions())`
`
.OnConversionCompleted((number, stream) => {})`
`
.Convert();
` `
converter.Load("").GetPossibleConversions();`
`
converter.Load("").GetDocumentInfo();`
`
converter.Load("").WithOptions(new PdfLoadOptions()).GetPossibleConversions();`
`
converter.Load("").WithOptions(new PdfLoadOptions()).GetDocumentInfo();`
`
`

##### Converter(Supplier<InputStream> document)
```
public Converter(Supplier<InputStream> document)
```

Initializes new instance of Converter class.

**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | input stream supplier.
 |

##### Converter(Supplier<InputStream> document, ConverterSettingsProvider settings)
```
public Converter(Supplier<InputStream> document, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier.
 |
| settings | ConverterSettingsProvider | A Converter settings supplier.
 |

##### Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions)
```
public Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier.
 |
| loadOptions | LoadOptionsProvider | A load options supplier.
 |

##### Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier.
 |
| loadOptions | LoadOptionsProvider | A document load options supplier.
 |
| settings | ConverterSettingsProvider | A Converter settings supplier.
 |

##### Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions)
```
public Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions)
```

Initializes new instance of class. **Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier.
 |
| loadOptions | LoadOptionsForFileTypeProvider | The function that return document load options.
 |

##### Converter(Supplier<InputStream> document, LoadOptionsForNameFileTypeStreamProvider loadOptions)
```
public Converter(Supplier<InputStream> document, LoadOptionsForNameFileTypeStreamProvider loadOptions)
```

Initializes new instance of class. **Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | A supplier that returns readable stream.
 |
| loadOptions | LoadOptionsForNameFileTypeStreamProvider | A function that returns document load options.
 |

##### Converter(Supplier<InputStream> document, LoadOptionsForNameFileTypeStreamProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(Supplier<InputStream> document, LoadOptionsForNameFileTypeStreamProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of class. **Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | A supplier that returns readable stream.
 |
| loadOptions | LoadOptionsForNameFileTypeStreamProvider | A function that returns document load options.
 |
| settings | ConverterSettingsProvider | A Converter settings supplier.
 |

##### Converter(String filePath)
```
public Converter(String filePath)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |

##### Converter(String filePath, ConverterSettingsProvider settings)
```
public Converter(String filePath, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |
| settings | ConverterSettingsProvider | A Converter settings supplier.
 |

##### Converter(String filePath, LoadOptionsProvider loadOptions)
```
public Converter(String filePath, LoadOptionsProvider loadOptions)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |
| loadOptions | LoadOptionsProvider | The load options supplier.
 |

##### Converter(String filePath, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(String filePath, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.
**Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |
| loadOptions | LoadOptionsProvider | The document load options supplier.
 |
| settings | ConverterSettingsProvider | The Converter settings supplier.
 |

##### Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions)
```
public Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions)
```

Initializes new instance of class. **Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |
| loadOptions | LoadOptionsForFileTypeProvider | The document load options function.
 |

##### Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| loadOptions | LoadOptionsForFileTypeProvider |  |
| settings | ConverterSettingsProvider |  |

##### Converter(String filePath, LoadOptionsForNameFileTypeStreamProvider loadOptions)
```
public Converter(String filePath, LoadOptionsForNameFileTypeStreamProvider loadOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| loadOptions | LoadOptionsForNameFileTypeStreamProvider |  |

##### Converter(String filePath, LoadOptionsForNameFileTypeStreamProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(String filePath, LoadOptionsForNameFileTypeStreamProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of class. **Learn more** More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |
| loadOptions | LoadOptionsForNameFileTypeStreamProvider | The document load options function.
 |
| settings | ConverterSettingsProvider | The Converter settings supplier.
 |

##### tweakPackageUtil(String vendor, String version, String specTitle)
```
public static void tweakPackageUtil(String vendor, String version, String specTitle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| vendor | java.lang.String |  |
| version | java.lang.String |  |
| specTitle | java.lang.String |  |

##### convert(SaveDocumentStream document, ConvertOptions convertOptions)
```
public final void convert(SaveDocumentStream document, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document.
**Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | The output stream supplier.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | output stream supplier
 |
| documentCompleted | ConvertedDocumentStream | the delegate that receive converted document stream.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | the convert options specific to desired target file type.
 |

##### convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | The output stream supplier.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | The output stream supplier.
 |
| documentCompleted | ConvertedDocumentStream | The delegate that receive converted document stream.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions)
```
public void convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function
 |
| documentCompleted | ConvertedDocumentStream | The delegate that receive converted document stream
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type
 |

##### convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function.
 |
| documentCompleted | ConvertedDocumentStream | The delegate that receive converted document stream.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(String filePath, ConvertOptions convertOptions)
```
public final void convert(String filePath, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document.
**Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SavePageStream document, ConvertOptions convertOptions)
```
public final void convert(SavePageStream document, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page.
**Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | The page output stream function.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | The output stream function.
 |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | The output stream function.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | Output stream function.
 |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(SavePageStreamForFileType document, ConvertOptions convertOptions)
```
public void convert(SavePageStreamForFileType document, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function.
 |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream.
 |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type.
 |

##### convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page. **Learn more** More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function.
 |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream.
 |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
 |

##### withSettings(ConverterSettingsProvider settingsProvider)
```
public IConversionFrom withSettings(ConverterSettingsProvider settingsProvider)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| settingsProvider | ConverterSettingsProvider |  |

**Returns:**
IConversionFrom
##### load(String fileName)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(String fileName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### load(String[] fileNames)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(String[] fileNames)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileNames | java.lang.String[] |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### load(DocumentStreamProvider documentStreamProvider)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(DocumentStreamProvider documentStreamProvider)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | DocumentStreamProvider |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### load(DocumentStreamsProvider documentStreamProvider)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(DocumentStreamsProvider documentStreamProvider)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | DocumentStreamsProvider |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets source document info - pages count and other document properties specific to the file type.
**Learn more** Learn more about converted document - file type, pages count, creation date and many other format specific properties: How to get document info

**Returns:**
IDocumentInfo - document info

##### isDocumentPasswordProtected()
```
public boolean isDocumentPasswordProtected()
```

Checks is source document is password protected

**Returns:**
boolean - true if document is password protected **Learn more** Learn more about converted document - file type, pages count, creation date and many other format specific properties: How to check is the document password protected

##### getPossibleConversions()
```
public final PossibleConversions getPossibleConversions()
```

Gets possible conversions for the source document.
**Learn more** Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code

**Returns:**
PossibleConversions - possible conversions

##### getAllPossibleConversions()
```
public static List<PossibleConversions> getAllPossibleConversions()
```

Gets all supported conversions **Learn more** Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.PossibleConversions> - supported conversions

##### getPossibleConversions(String extension)
```
public static PossibleConversions getPossibleConversions(String extension)
```

Gets supported conversions for provided document extension Converter.GetPossibleConversions(".docx") Converter.GetPossibleConversions("docx") **Learn more** Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | Document extension
 |

**Returns:**
PossibleConversions - possible conversions

##### dispose()
```
public final void dispose()
```

Releases resources.

##### close()
```
public void close()
```

### ConverterSettings
Path: https://reference.groupdocs.com/conversion/java/com.groupdocs.conversion/convertersettings.md

**Inheritance:**
java.lang.Object
```
public final class ConverterSettings
```

Defines settings for customizing Converter behaviour.

#### Constructors

| Constructor | Description |
| --- | --- |
| ConverterSettings() |  |
#### Methods

| Method | Description |
| --- | --- |
| getCache() | The cache implementation used for storing conversion results.
 |
| setCache(ICache value) | The cache implementation used for storing conversion results.
 |
| getLogger() | The logger implementation used for logging conversion process.
 |
| setLogger(ILogger value) | The logger implementation used for logging conversion process.
 |
| getListener() | Gets the converter listener implementation used for monitoring conversion status and progress
 |
| setListener(IConverterListener listener) | Sets the converter listener implementation used for monitoring conversion status and progress
 |
| getFontDirectories() | The custom font directories paths
 |
| getFontDirectoriesInternal() |  |
| setFontDirectories(List<String> value) | The custom font directories paths
 |
| listConverterSettings() |  |
| getTempFolder() | Temp folder used for conversion
 |
| setTempFolder(String tempFolder) | Sets Temp folder used for conversion
 |
##### ConverterSettings()
```
public ConverterSettings()
```

##### getCache()
```
public final ICache getCache()
```

The cache implementation used for storing conversion results.

**Returns:**
ICache
##### setCache(ICache value)
```
public final void setCache(ICache value)
```

The cache implementation used for storing conversion results.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICache |  |

##### getLogger()
```
public final ILogger getLogger()
```

The logger implementation used for logging conversion process.

**Returns:**
ILogger
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

The logger implementation used for logging conversion process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ILogger |  |

##### getListener()
```
public IConverterListener getListener()
```

Gets the converter listener implementation used for monitoring conversion status and progress

**Returns:**
IConverterListener - The converter listener

##### setListener(IConverterListener listener)
```
public void setListener(IConverterListener listener)
```

Sets the converter listener implementation used for monitoring conversion status and progress

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| listener | IConverterListener | The converter listener
 |

##### getFontDirectories()
```
public final List<String> getFontDirectories()
```

The custom font directories paths

**Returns:**
java.util.List<java.lang.String>
##### getFontDirectoriesInternal()
```
public List<String> getFontDirectoriesInternal()
```

**Returns:**
java.util.List<java.lang.String>
##### setFontDirectories(List<String> value)
```
public void setFontDirectories(List<String> value)
```

The custom font directories paths

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### listConverterSettings()
```
public List<String> listConverterSettings()
```

**Returns:**
java.util.List<java.lang.String>
##### getTempFolder()
```
public String getTempFolder()
```

Temp folder used for conversion

**Returns:**
java.lang.String
##### setTempFolder(String tempFolder)
```
public void setTempFolder(String tempFolder)
```

Sets Temp folder used for conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tempFolder | java.lang.String |  |

## .NET

### GroupDocs.Conversion for .NET
Path: https://reference.groupdocs.com/conversion/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Conversion | The namespace provides classes to convert documents into all popular file formats in a simple and intuitive way. |
| GroupDocs.Conversion.Caching | The namespace provides classes for customizing caching behaviour. |
| GroupDocs.Conversion.Contracts | The namespace provides members to instantiate and release output document, manage font substitutions etc. |
| GroupDocs.Conversion.Exceptions | The namespace provides different exceptions classes. |
| GroupDocs.Conversion.FileTypes | The namespace provides classes which represent supported file types. |
| GroupDocs.Conversion.Fluent | The namespace provides interfaces for fluent conversion. |
| GroupDocs.Conversion.Integration.Audio | The namespace provides interfaces and classes, required for audio conversion support. |
| GroupDocs.Conversion.Integration.Heic | The namespace provides interfaces and classes, required for heic conversion support. |
| GroupDocs.Conversion.Integration.Ocr | The namespace provides interfaces and classes, required for Optical Character Recognition (OCR) support. |
| GroupDocs.Conversion.Integration.Video | The namespace provides interfaces and classes, required for video conversion support. |
| GroupDocs.Conversion.Logging | The namespace provides classes for customizing logging behaviour. |
| GroupDocs.Conversion.Options | The namespace provides classes to specify additional options for document loading and conversion process. |
| GroupDocs.Conversion.Options.Convert | The namespace provides classes to specify additional options for document conversion process. |
| GroupDocs.Conversion.Options.Load | The namespace provides classes to specify additional options for document loading process. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### GroupDocs.Conversion.Caching
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching.md

The namespace provides classes for customizing caching behaviour.

#### Classes

| Class | Description |
| --- | --- |
| FileCache | File caching behaviour. Means that cache is stored on the file system |
| MemoryCache | Memory caching behaviour. Means that cache is stored in the memory |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICache | Defines methods required for storing rendered document and document resources сache. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### FileCache
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/filecache.md

#### FileCache class

File caching behaviour. Means that cache is stored on the file system

```csharp
public sealed class FileCache : ICache
```

#### Constructors

| Name | Description |
| --- | --- |
| FileCache(string) | Creates new instance of FileCache class |

#### Methods

| Name | Description |
| --- | --- |
| GetKeys(string) | Returns all keys matching filter. |
| Set(string, object) | Inserts a cache entry into the cache. |
| TryGetValue(string, out object) | Gets the entry associated with this key if present. |

### FileCache
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/filecache/filecache.md

#### FileCache constructor

Creates new instance of FileCache class

```csharp
public FileCache(string cachePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | String | Relative or absolute path where document cache will be stored |

### GetKeys
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/filecache/getkeys.md

#### FileCache.GetKeys method

Returns all keys matching filter.

```csharp
public IEnumerable<string> GetKeys(string filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | String | The filter to use. |

##### Return Value

Keys matching the filter.

### Set
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/filecache/set.md

#### FileCache.Set method

Inserts a cache entry into the cache.

```csharp
public void Set(string key, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A unique identifier for the cache entry. |
| value | Object | The object to insert. |

### TryGetValue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/filecache/trygetvalue.md

#### FileCache.TryGetValue method

Gets the entry associated with this key if present.

```csharp
public bool TryGetValue(string key, out object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A key identifying the requested entry. |
| value | Object& | The located value or null. |

##### Return Value

```csharp
True
```

if the key was found.

### ICache
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/icache.md

#### ICache interface

Defines methods required for storing rendered document and document resources сache.

```csharp
public interface ICache
```

#### Methods

| Name | Description |
| --- | --- |
| GetKeys(string) | Returns all keys matching filter. |
| Set(string, object) | Inserts a cache entry into the cache. |
| TryGetValue(string, out object) | Gets the entry associated with this key if present. |

### GetKeys
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/icache/getkeys.md

#### ICache.GetKeys method

Returns all keys matching filter.

```csharp
public IEnumerable<string> GetKeys(string filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | String | The filter to use. |

##### Return Value

Keys matching the filter.

### Set
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/icache/set.md

#### ICache.Set method

Inserts a cache entry into the cache.

```csharp
public void Set(string key, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A unique identifier for the cache entry. |
| value | Object | The object to insert. |

### TryGetValue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/icache/trygetvalue.md

#### ICache.TryGetValue method

Gets the entry associated with this key if present.

```csharp
public bool TryGetValue(string key, out object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A key identifying the requested entry. |
| value | Object& | The located value or null. |

##### Return Value

```csharp
True
```

if the key was found.

### MemoryCache
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/memorycache.md

#### MemoryCache class

Memory caching behaviour. Means that cache is stored in the memory

```csharp
public sealed class MemoryCache : ICache
```

#### Constructors

| Name | Description |
| --- | --- |
| MemoryCache() | Creates new instance of MemoryCache class |

#### Methods

| Name | Description |
| --- | --- |
| GetKeys(string) | Returns all keys matching filter. |
| Set(string, object) | Inserts a cache entry into the cache. |
| TryGetValue(string, out object) | Gets the entry associated with this key if present. |

### GetKeys
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/memorycache/getkeys.md

#### MemoryCache.GetKeys method

Returns all keys matching filter.

```csharp
public IEnumerable<string> GetKeys(string filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | String | The filter to use. |

##### Return Value

Keys matching the filter.

### MemoryCache
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/memorycache/memorycache.md

#### MemoryCache constructor

Creates new instance of MemoryCache class

```csharp
public MemoryCache()
```

### Set
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/memorycache/set.md

#### MemoryCache.Set method

Inserts a cache entry into the cache.

```csharp
public void Set(string key, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A unique identifier for the cache entry. |
| value | Object | The object to insert. |

### TryGetValue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.caching/memorycache/trygetvalue.md

#### MemoryCache.TryGetValue method

Gets the entry associated with this key if present.

```csharp
public bool TryGetValue(string key, out object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A key identifying the requested entry. |
| value | Object& | The located value or null. |

##### Return Value

```csharp
True
```

if the key was found.

### GroupDocs.Conversion.Contracts
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts.md

The namespace provides members to instantiate and release output document, manage font substitutions etc.

#### Classes

| Class | Description |
| --- | --- |
| AudioDocumentInfo | Contains Audio document metadata |
| BitmapInfo | Object containing array of pixels and bitmap information. |
| Bzip2DocumentInfo | Contains Bzip2 document metadata |
| CabDocumentInfo | Contains Cab document metadata |
| CadDocumentInfo | Contains Cad document metadata |
| CgmDocumentInfo | Contains Cgm document metadata |
| CompressionNodeInfo | Represents a node in a compressed file |
| CpioDocumentInfo | Contains Cpio document metadata |
| CsvDocumentInfo | Contains Csv document metadata |
| DiagramDocumentInfo | Contains Diagram document metadata |
| DjVuDocumentInfo | Contains DjVu document metadata |
| DocumentInfo | Provides base implementation for retrieving polymorphic document information |
| EmailDocumentInfo | Contains Email document metadata |
| Enumeration | Generic enumeration class. |
| EpsDocumentInfo | Contains Ps document metadata |
| FlagsEnumeration | Represents an abstract base class for creating enumerations that support bitwise flag operations. |
| FontDocumentInfo | Contains Font document metadata |
| FontSubstitute | Describes substitution for missing font. |
| FontSubstitutionContext | Describes a single font substitution that occurred while loading or rendering a source document. Instances are passed to `OnFontSubstituted`. |
| FontTransformation | Describes font transformation configuration including font attributes. Font transformations are applied after document loading and font substitution. |
| GisDocumentInfo | Contains GIS document metadata |
| GzipDocumentInfo | Contains Gzip document metadata |
| HeicDocumentInfo | Contains Heic document metadata |
| IcoDocumentInfo | Contains Ico document metadata |
| ImageDocumentInfo | Contains Image document metadata |
| InlineXbrlDocumentInfo | Contains iXbrl document metadata |
| IsoDocumentInfo | Contains ISO document metadata |
| JsonDocumentInfo | Contains Json document metadata |
| LhaDocumentInfo | Contains compression document metadata |
| Lz4DocumentInfo | Contains Lzip document metadata |
| LzipDocumentInfo | Contains Lzip document metadata |
| LzmaDocumentInfo | Contains Lzma document metadata |
| NoteDocumentInfo | Contains Note document metadata |
| OlmDocumentInfo | Contains personal storage document metadata |
| OlmFolderInfo | Personal Storage Folder info |
| PasswordProtectedDocumentInfo | Provided document is password protected |
| PclDocumentInfo | Contains Pcl document metadata |
| PdfDocumentInfo | Contains Pdf document metadata |
| PersonalStorageDocumentInfo | Contains personal storage document metadata |
| PersonalStorageFolderInfo | Personal Storage Folder info |
| PersonalStorageItemInfo | Personal Storage Item info |
| BitmapInfo.PixelFormat | Describes pixel format enumeration |
| PossibleConversions | Represents a mapping what conversion pairs are supported for specific source file format |
| PresentationDocumentInfo | Contains Presentation document metadata |
| ProjectManagementDocumentInfo | Contains ProjectManagement document metadata |
| PsdDocumentInfo | Contains Psd document metadata |
| PsDocumentInfo | Contains Ps document metadata |
| PublisherDocumentInfo | Contains Publisher document metadata |
| RarDocumentInfo | Contains Rar document metadata |
| Rectangle | Represents a rectangle defined by its edges for cropping purposes. |
| SevenZipDocumentInfo | Contains 7Zip document metadata |
| SpreadsheetDocumentInfo | Contains Spreadsheet document metadata |
| SvgDocumentInfo | Contains Svg document metadata |
| TableOfContentsItem | Contains Table of contents item metadata |
| TarDocumentInfo | Contains Tar document metadata |
| TargetConversion | Represents possible target conversion and a flag is it a primary or secondary |
| TexDocumentInfo | Contains Tex document metadata |
| ThreeDDocumentInfo | Contains 3D document metadata |
| TsvDocumentInfo | Contains Tsv document metadata |
| TxtDocumentInfo | Contains Txt document metadata |
| UueDocumentInfo | Contains Uue document metadata |
| ValueObject | Abstract value object class. |
| VcfDocumentInfo | Contains Vcf document metadata |
| VideoDocumentInfo | Contains Video document metadata |
| WebDocumentInfo | Contains Web document metadata |
| WordProcessingDocumentInfo | Contains WordProcessing document metadata |
| XbrlDocumentInfo | Contains Xbrl document metadata |
| XmlDocumentInfo | Contains Xml document metadata |
| XpsDocumentInfo | Contains Xps document metadata |
| XslFoDocumentInfo | Contains XslFo document metadata |
| XzDocumentInfo | Contains Xz document metadata |
| ZDocumentInfo | Contains Z document metadata |
| ZipDocumentInfo | Contains compression document metadata |
| ZstDocumentInfo | Contains Zst document metadata |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICompressionDocumentHierarchyInfo | Defines metadata for a compression document hierarchy. |
| IDocumentInfo | Contains metadata for a document. |
| IDocumentsContainerLoadOptions | Loading options for documents container |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### AudioDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/audiodocumentinfo.md

#### AudioDocumentInfo class

Contains Audio document metadata

```csharp
public class AudioDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### BitmapInfo.PixelFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat.md

#### BitmapInfo.PixelFormat class

Describes pixel format enumeration

```csharp
public class PixelFormat : Enumeration
```

#### Constructors

| Name | Description |
| --- | --- |
| PixelFormat() | Serialization constructor |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Argb32 | Argb32 pixel format. |
| static readonly Bgr24 | Bgr24 pixel format. |
| static readonly Bgra32 | Bgra32 pixel format. |
| static readonly Rgb24 | Rgb24 pixel format. |
| static readonly Rgba32 | Rgba32 pixel format. |

### Argb32
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat/argb32.md

#### BitmapInfo.PixelFormat.Argb32 field

Argb32 pixel format.

```csharp
public static readonly PixelFormat Argb32;
```

### Bgr24
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat/bgr24.md

#### BitmapInfo.PixelFormat.Bgr24 field

Bgr24 pixel format.

```csharp
public static readonly PixelFormat Bgr24;
```

### Bgra32
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat/bgra32.md

#### BitmapInfo.PixelFormat.Bgra32 field

Bgra32 pixel format.

```csharp
public static readonly PixelFormat Bgra32;
```

### PixelFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat/pixelformat.md

#### BitmapInfo.PixelFormat constructor

Serialization constructor

```csharp
public PixelFormat()
```

### Rgb24
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat/rgb24.md

#### BitmapInfo.PixelFormat.Rgb24 field

Rgb24 pixel format.

```csharp
public static readonly PixelFormat Rgb24;
```

### Rgba32
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.pixelformat/rgba32.md

#### BitmapInfo.PixelFormat.Rgba32 field

Rgba32 pixel format.

```csharp
public static readonly PixelFormat Rgba32;
```

### BitmapInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo.md

#### BitmapInfo class

Object containing array of pixels and bitmap information.

```csharp
public class BitmapInfo : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Gets the pixel format of the bitmap. |
| Height { get; } | Gets the height of the bitmap. |
| PixelBytes { get; } | Gets the array of pixels. |
| Width { get; } | Gets the width of the bitmap. |

#### Methods

| Name | Description |
| --- | --- |
| static Create(byte[], int, int, PixelFormat) | Create new BitmapInfo instance |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

#### Other Members

| Name | Description |
| --- | --- |
| class PixelFormat | Describes pixel format enumeration |

### Create
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo/create.md

#### BitmapInfo.Create method

Create new BitmapInfo instance

```csharp
public static BitmapInfo Create(byte[] pixelBytes, int width, int height, PixelFormat format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pixelBytes | Byte[] | Array of pixels. |
| width | Int32 | Width of the bitmap. |
| height | Int32 | Height of the bitmap. |
| format | PixelFormat | Pixel format of the bitmap. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo/format.md

#### BitmapInfo.Format property

Gets the pixel format of the bitmap.

```csharp
public PixelFormat Format { get; }
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo/height.md

#### BitmapInfo.Height property

Gets the height of the bitmap.

```csharp
public int Height { get; }
```

### PixelBytes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo/pixelbytes.md

#### BitmapInfo.PixelBytes property

Gets the array of pixels.

```csharp
public byte[] PixelBytes { get; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bitmapinfo/width.md

#### BitmapInfo.Width property

Gets the width of the bitmap.

```csharp
public int Width { get; }
```

### Bzip2DocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/bzip2documentinfo.md

#### Bzip2DocumentInfo class

Contains Bzip2 document metadata

```csharp
public class Bzip2DocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### CabDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/cabdocumentinfo.md

#### CabDocumentInfo class

Contains Cab document metadata

```csharp
public class CabDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/cabdocumentinfo/contenttree.md

#### CabDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### CadDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/caddocumentinfo.md

#### CadDocumentInfo class

Contains Cad document metadata

```csharp
public class CadDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Height |
| Item { get; } | Implements `Item` |
| Layers { get; } | Layers in the document |
| Layouts { get; } | Layouts in the document |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Width { get; } | Width |

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/caddocumentinfo/height.md

#### CadDocumentInfo.Height property

Height

```csharp
public int Height { get; }
```

### Layers
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/caddocumentinfo/layers.md

#### CadDocumentInfo.Layers property

Layers in the document

```csharp
public IList<string> Layers { get; }
```

### Layouts
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/caddocumentinfo/layouts.md

#### CadDocumentInfo.Layouts property

Layouts in the document

```csharp
public IList<string> Layouts { get; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/caddocumentinfo/width.md

#### CadDocumentInfo.Width property

Width

```csharp
public int Width { get; }
```

### CgmDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/cgmdocumentinfo.md

#### CgmDocumentInfo class

Contains Cgm document metadata

```csharp
public class CgmDocumentInfo : PdfDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets page height |
| IsLandscape { get; } | Gets is page landscaped |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| TableOfContents { get; } | Table of contents |
| Title { get; } | Gets title |
| Version { get; } | Gets version |
| Width { get; } | Gets page width |

### CompressionNodeInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/compressionnodeinfo.md

#### CompressionNodeInfo class

Represents a node in a compressed file

```csharp
public class CompressionNodeInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| CompressionNodeInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Children { get; } | Child nodes of this node |
| FileSize { get; set; } | Size of the file in bytes (only relevant for file nodes) |
| IsFile { get; set; } | Whether the node is a file or a directory |
| Name { get; set; } | The name of the node |

### Children
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/compressionnodeinfo/children.md

#### CompressionNodeInfo.Children property

Child nodes of this node

```csharp
public List<CompressionNodeInfo> Children { get; }
```

### CompressionNodeInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/compressionnodeinfo/compressionnodeinfo.md

#### CompressionNodeInfo constructor

The default constructor.

```csharp
public CompressionNodeInfo()
```

### FileSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/compressionnodeinfo/filesize.md

#### CompressionNodeInfo.FileSize property

Size of the file in bytes (only relevant for file nodes)

```csharp
public ulong FileSize { get; set; }
```

### IsFile
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/compressionnodeinfo/isfile.md

#### CompressionNodeInfo.IsFile property

Whether the node is a file or a directory

```csharp
public bool IsFile { get; set; }
```

### Name
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/compressionnodeinfo/name.md

#### CompressionNodeInfo.Name property

The name of the node

```csharp
public string Name { get; set; }
```

### CpioDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/cpiodocumentinfo.md

#### CpioDocumentInfo class

Contains Cpio document metadata

```csharp
public class CpioDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/cpiodocumentinfo/contenttree.md

#### CpioDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### CsvDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/csvdocumentinfo.md

#### CsvDocumentInfo class

Contains Csv document metadata

```csharp
public class CsvDocumentInfo : SpreadsheetDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ActiveWorksheetIndex { get; } | Gets active worksheet index |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Title { get; } | Gets title |
| Worksheets { get; } | Worksheets names |
| WorksheetsCount { get; } | Gets worksheets count |

### DiagramDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/diagramdocumentinfo.md

#### DiagramDocumentInfo class

Contains Diagram document metadata

```csharp
public class DiagramDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### DjVuDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/djvudocumentinfo.md

#### DjVuDocumentInfo class

Contains DjVu document metadata

```csharp
public class DjVuDocumentInfo : ImageDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets bits per pixel |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets height |
| HorizontalResolution { get; } | Get horizontal resolution |
| Item { get; } | Implements `Item` |
| Opacity { get; } | Gets image opacity |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| VerticalResolution { get; } | Gets vertical resolution |
| Width { get; } | Gets width |

### HorizontalResolution
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/djvudocumentinfo/horizontalresolution.md

#### DjVuDocumentInfo.HorizontalResolution property

Get horizontal resolution

```csharp
public double HorizontalResolution { get; }
```

### Opacity
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/djvudocumentinfo/opacity.md

#### DjVuDocumentInfo.Opacity property

Gets image opacity

```csharp
public float Opacity { get; }
```

### VerticalResolution
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/djvudocumentinfo/verticalresolution.md

#### DjVuDocumentInfo.VerticalResolution property

Gets vertical resolution

```csharp
public double VerticalResolution { get; }
```

### DocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo.md

#### DocumentInfo class

Provides base implementation for retrieving polymorphic document information

```csharp
public abstract class DocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### CreationDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo/creationdate.md

#### DocumentInfo.CreationDate property

Implements `CreationDate`

```csharp
public DateTime CreationDate { get; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo/format.md

#### DocumentInfo.Format property

Implements `Format`

```csharp
public string Format { get; }
```

### Item
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo/item.md

#### DocumentInfo indexer

Implements `Item`

```csharp
public object this[string propertyName] { get; }
```

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo/pagescount.md

#### DocumentInfo.PagesCount property

Implements `PagesCount`

```csharp
public int PagesCount { get; }
```

### PropertyNames
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo/propertynames.md

#### DocumentInfo.PropertyNames property

Implements `PropertyNames`

```csharp
public string[] PropertyNames { get; }
```

### Size
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/documentinfo/size.md

#### DocumentInfo.Size property

Implements `Size`

```csharp
public long Size { get; }
```

### EmailDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/emaildocumentinfo.md

#### EmailDocumentInfo class

Contains Email document metadata

```csharp
public class EmailDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| AttachmentsCount { get; } | Gets attachments count |
| AttachmentsNames { get; } | Gets attachments names |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsEncrypted { get; } | Gets is encrypted |
| IsHtml { get; } | Gets is html |
| IsSigned { get; } | Gets is signed |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### AttachmentsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/emaildocumentinfo/attachmentscount.md

#### EmailDocumentInfo.AttachmentsCount property

Gets attachments count

```csharp
public int AttachmentsCount { get; }
```

### AttachmentsNames
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/emaildocumentinfo/attachmentsnames.md

#### EmailDocumentInfo.AttachmentsNames property

Gets attachments names

```csharp
public IList<string> AttachmentsNames { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/emaildocumentinfo/isencrypted.md

#### EmailDocumentInfo.IsEncrypted property

Gets is encrypted

```csharp
public bool IsEncrypted { get; }
```

### IsHtml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/emaildocumentinfo/ishtml.md

#### EmailDocumentInfo.IsHtml property

Gets is html

```csharp
public bool IsHtml { get; }
```

### IsSigned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/emaildocumentinfo/issigned.md

#### EmailDocumentInfo.IsSigned property

Gets is signed

```csharp
public bool IsSigned { get; }
```

### Enumeration
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration.md

#### Enumeration class

Generic enumeration class.

```csharp
public abstract class Enumeration : IComparable, IEquatable<Enumeration>
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |
| static FromDisplayName&lt;T&gt;(string) | Returns object by display name. |
| static FromValue&lt;T&gt;(string) | Returns object by key. |
| static GetAll&lt;T&gt;() | Returns all enumeration values. |
| operator == | Equality operator. |
| operator != | Inequality operator. |

### CompareTo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/compareto.md

#### Enumeration.CompareTo method

Compares current object to other.

```csharp
public int CompareTo(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The other object |

##### Return Value

zero if equal

### Equals
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/equals.md

#### Equals(object)

Determines whether two object instances are equal.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object. |

##### Return Value

`true` if the specified object is equal to the current object; otherwise, `false`.

#### Equals(Enumeration)

Determines whether two object instances are equal.

```csharp
public virtual bool Equals(Enumeration other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Enumeration | The object to compare with the current object. |

##### Return Value

`true` if the specified object is equal to the current object; otherwise, `false`.

### FromDisplayName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/fromdisplayname.md

#### Enumeration.FromDisplayName&lt;T&gt; method

Returns object by display name.

```csharp
public static T FromDisplayName<T>(string displayName)
    where T : Enumeration
```

| Parameter | Type | Description |
| --- | --- | --- |
| displayName | String | The display name |

##### Return Value

The object

### FromValue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/fromvalue.md

#### Enumeration.FromValue&lt;T&gt; method

Returns object by key.

```csharp
public static T FromValue<T>(string value)
    where T : Enumeration
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value |

##### Return Value

The object

### GetAll
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/getall.md

#### Enumeration.GetAll&lt;T&gt; method

Returns all enumeration values.

```csharp
public static IEnumerable<T> GetAll<T>()
    where T : Enumeration
```

| Parameter | Description |
| --- | --- |
| T | Enumerated object type. |

##### Return Value

Enumerable of the provided type

### GetHashCode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/gethashcode.md

#### Enumeration.GetHashCode method

Serves as the default hash function.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current object.

### op_Equality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/op_equality.md

#### Enumeration Equality operator

Equality operator.

```csharp
public static bool operator ==(Enumeration left, Enumeration right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Enumeration | The first object |
| right | Enumeration | The second object |

##### Return Value

`true` if objects are equal

### op_Inequality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/op_inequality.md

#### Enumeration Inequality operator

Inequality operator.

```csharp
public static bool operator !=(Enumeration left, Enumeration right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Enumeration | The first object |
| right | Enumeration | The second object |

##### Return Value

`true` if objects are not equal

### ToString
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/enumeration/tostring.md

#### Enumeration.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

String representation

### EpsDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/epsdocumentinfo.md

#### EpsDocumentInfo class

Contains Ps document metadata

```csharp
public class EpsDocumentInfo : ImageDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets bits per pixel |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets height |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Width { get; } | Gets width |

### FlagsEnumeration
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/flagsenumeration.md

#### FlagsEnumeration class

Represents an abstract base class for creating enumerations that support bitwise flag operations.

```csharp
public abstract class FlagsEnumeration : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| virtual HasFlag&lt;T&gt;(T) | Checks if the current flag has the specified flag. |
| virtual HasFlagValue(int) | Checks if the current flag has the specified value. |
| override ToString() | Converts the current object to a string. |
| static Combine&lt;T&gt;(T, T) | Combines two flags enumerations into one. |

### Combine
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/flagsenumeration/combine.md

#### FlagsEnumeration.Combine&lt;T&gt; method

Combines two flags enumerations into one.

```csharp
public static T Combine<T>(T left, T right)
    where T : FlagsEnumeration
```

| Parameter | Description |
| --- | --- |
| T |  |
| left |  |
| right |  |

### HasFlag
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/flagsenumeration/hasflag.md

#### FlagsEnumeration.HasFlag&lt;T&gt; method

Checks if the current flag has the specified flag.

```csharp
public virtual bool HasFlag<T>(T flag)
    where T : FlagsEnumeration
```

| Parameter | Type | Description |
| --- | --- | --- |
| flag | T | The flag to check. |

##### Return Value

`true` if the flag is present; otherwise, `false`.

### HasFlagValue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/flagsenumeration/hasflagvalue.md

#### FlagsEnumeration.HasFlagValue method

Checks if the current flag has the specified value.

```csharp
public virtual bool HasFlagValue(int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int32 | The flag value to check. |

##### Return Value

`true` if the value is present; otherwise, `false`.

### ToString
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/flagsenumeration/tostring.md

#### FlagsEnumeration.ToString method

Converts the current object to a string.

```csharp
public override string ToString()
```

##### Return Value

The string representation of the key.

### FontDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontdocumentinfo.md

#### FontDocumentInfo class

Contains Font document metadata

```csharp
public class FontDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### FontSubstitute
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitute.md

#### FontSubstitute class

Describes substitution for missing font.

```csharp
public class FontSubstitute : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| OriginalFontName { get; } | The original font name. |
| SubstituteFontName { get; } | The substitute font name. |

#### Methods

| Name | Description |
| --- | --- |
| static Create(string, string) | Instantiate new font substitution pair. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Create
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitute/create.md

#### FontSubstitute.Create method

Instantiate new font substitution pair.

```csharp
public static FontSubstitute Create(string originalFont, string substituteWith)
```

| Parameter | Type | Description |
| --- | --- | --- |
| originalFont | String | Font from the source document. |
| substituteWith | String | Font which will be used to replace "originalFont. |

### OriginalFontName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitute/originalfontname.md

#### FontSubstitute.OriginalFontName property

The original font name.

```csharp
public string OriginalFontName { get; }
```

### SubstituteFontName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitute/substitutefontname.md

#### FontSubstitute.SubstituteFontName property

The substitute font name.

```csharp
public string SubstituteFontName { get; }
```

### FontSubstitutionContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitutioncontext.md

#### FontSubstitutionContext class

Describes a single font substitution that occurred while loading or rendering a source document. Instances are passed to `OnFontSubstituted`.

```csharp
public sealed class FontSubstitutionContext
```

#### Constructors

| Name | Description |
| --- | --- |
| FontSubstitutionContext(string, string, string, string) | Creates a new `FontSubstitutionContext`. |

#### Properties

| Name | Description |
| --- | --- |
| OriginalFontName { get; } | Name of the font referenced by the source document but unavailable to the conversion pipeline. |
| Reason { get; } | The substitution message exactly as reported by the conversion pipeline, verbatim and unparsed. For documents that expose font names structurally this may be `null` (use `OriginalFontName` / `SubstituteFontName`); for others it carries the full human-readable description, which names both the missing and the substitute font. |
| SourceFileName { get; } | File name of the source document being converted. When the source was provided as a stream that is not a FileStream, this contains a generated identifier rather than a real file name. |
| SubstituteFontName { get; } | Name of the font used as a substitute. May be `null` for documents whose engine reports the substitution only as descriptive text — in that case read `Reason`. |

### FontSubstitutionContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitutioncontext/fontsubstitutioncontext.md

#### FontSubstitutionContext constructor

Creates a new `FontSubstitutionContext`.

```csharp
public FontSubstitutionContext(string sourceFileName, string originalFontName, 
    string substituteFontName, string reason)
```

### OriginalFontName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitutioncontext/originalfontname.md

#### FontSubstitutionContext.OriginalFontName property

Name of the font referenced by the source document but unavailable to the conversion pipeline.

```csharp
public string OriginalFontName { get; }
```

### Reason
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitutioncontext/reason.md

#### FontSubstitutionContext.Reason property

The substitution message exactly as reported by the conversion pipeline, verbatim and unparsed. For documents that expose font names structurally this may be `null` (use `OriginalFontName` / `SubstituteFontName`); for others it carries the full human-readable description, which names both the missing and the substitute font.

```csharp
public string Reason { get; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitutioncontext/sourcefilename.md

#### FontSubstitutionContext.SourceFileName property

File name of the source document being converted. When the source was provided as a stream that is not a FileStream, this contains a generated identifier rather than a real file name.

```csharp
public string SourceFileName { get; }
```

### SubstituteFontName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fontsubstitutioncontext/substitutefontname.md

#### FontSubstitutionContext.SubstituteFontName property

Name of the font used as a substitute. May be `null` for documents whose engine reports the substitution only as descriptive text — in that case read `Reason`.

```csharp
public string SubstituteFontName { get; }
```

### FontTransformation
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation.md

#### FontTransformation class

Describes font transformation configuration including font attributes. Font transformations are applied after document loading and font substitution.

```csharp
public class FontTransformation : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| MatchAnySize { get; } | When true, matches any font size for the original font name. When false, matches exact font size specified in OriginalFont. |
| MatchAnyStyle { get; } | When true, matches any font style (bold, italic, underline) for the original font. When false, matches exact font style specified in OriginalFont. |
| OriginalFont { get; } | The original font specification to match and replace. |
| ReplacementFont { get; } | The replacement font specification. |

#### Methods

| Name | Description |
| --- | --- |
| static Create(Font, Font) | Creates a font transformation with exact font matching (size and style must match). |
| static CreateByName(string, string) | Creates a font transformation by name only, matching any size and style. The replacement font will preserve the original font's size and style. |
| static CreateFlexible(Font, Font, bool, bool) | Creates a font transformation with flexible matching options. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Create
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/create.md

#### FontTransformation.Create method

Creates a font transformation with exact font matching (size and style must match).

```csharp
public static FontTransformation Create(Font originalFont, Font replacementFont)
```

| Parameter | Type | Description |
| --- | --- | --- |
| originalFont | Font | Font specification to transform. |
| replacementFont | Font | Font specification to transform to. |

### CreateByName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/createbyname.md

#### FontTransformation.CreateByName method

Creates a font transformation by name only, matching any size and style. The replacement font will preserve the original font's size and style.

```csharp
public static FontTransformation CreateByName(string originalFontName, string replacementFontName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| originalFontName | String | Original font family name to transform. |
| replacementFontName | String | Replacement font family name. |

### CreateFlexible
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/createflexible.md

#### FontTransformation.CreateFlexible method

Creates a font transformation with flexible matching options.

```csharp
public static FontTransformation CreateFlexible(Font originalFont, Font replacementFont, 
    bool matchAnySize, bool matchAnyStyle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| originalFont | Font | Font specification to match. |
| replacementFont | Font | Font specification to transform to. |
| matchAnySize | Boolean | True to match any size, false to match exact size. |
| matchAnyStyle | Boolean | True to match any style, false to match exact style. |

### MatchAnySize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/matchanysize.md

#### FontTransformation.MatchAnySize property

When true, matches any font size for the original font name. When false, matches exact font size specified in OriginalFont.

```csharp
public bool MatchAnySize { get; }
```

### MatchAnyStyle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/matchanystyle.md

#### FontTransformation.MatchAnyStyle property

When true, matches any font style (bold, italic, underline) for the original font. When false, matches exact font style specified in OriginalFont.

```csharp
public bool MatchAnyStyle { get; }
```

### OriginalFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/originalfont.md

#### FontTransformation.OriginalFont property

The original font specification to match and replace.

```csharp
public Font OriginalFont { get; }
```

### ReplacementFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/fonttransformation/replacementfont.md

#### FontTransformation.ReplacementFont property

The replacement font specification.

```csharp
public Font ReplacementFont { get; }
```

### GisDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/gisdocumentinfo.md

#### GisDocumentInfo class

Contains GIS document metadata

```csharp
public class GisDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### GzipDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/gzipdocumentinfo.md

#### GzipDocumentInfo class

Contains Gzip document metadata

```csharp
public class GzipDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### HeicDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/heicdocumentinfo.md

#### HeicDocumentInfo class

Contains Heic document metadata

```csharp
public class HeicDocumentInfo : ImageDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets bits per pixel |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets height |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Width { get; } | Gets width |

### IcoDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/icodocumentinfo.md

#### IcoDocumentInfo class

Contains Ico document metadata

```csharp
public class IcoDocumentInfo : ImageDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets bits per pixel |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets height |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Width { get; } | Gets width |

### ICompressionDocumentHierarchyInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/icompressiondocumenthierarchyinfo.md

#### ICompressionDocumentHierarchyInfo interface

Defines metadata for a compression document hierarchy.

```csharp
public interface ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/icompressiondocumenthierarchyinfo/contenttree.md

#### ICompressionDocumentHierarchyInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### IDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo.md

#### IDocumentInfo interface

Contains metadata for a document.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Document creation date |
| Format { get; } | Document format |
| Item { get; } | Get value for a property provided as a key |
| PagesCount { get; } | Document pages count. |
| PropertyNames { get; } | Enumerable of all properties which could be get for the current document info |
| Size { get; } | Document size in bytes |

### CreationDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo/creationdate.md

#### IDocumentInfo.CreationDate property

Document creation date

```csharp
public DateTime CreationDate { get; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo/format.md

#### IDocumentInfo.Format property

Document format

```csharp
public string Format { get; }
```

### Item
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo/item.md

#### IDocumentInfo indexer

Get value for a property provided as a key

```csharp
public object this[string propertyName] { get; }
```

| Parameter | Description |
| --- | --- |
| propertyName | property name |

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo/pagescount.md

#### IDocumentInfo.PagesCount property

Document pages count.

```csharp
public int PagesCount { get; }
```

### PropertyNames
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo/propertynames.md

#### IDocumentInfo.PropertyNames property

Enumerable of all properties which could be get for the current document info

```csharp
public string[] PropertyNames { get; }
```

### Size
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentinfo/size.md

#### IDocumentInfo.Size property

Document size in bytes

```csharp
public long Size { get; }
```

### IDocumentsContainerLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentscontainerloadoptions.md

#### IDocumentsContainerLoadOptions interface

Loading options for documents container

```csharp
public interface IDocumentsContainerLoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ConvertOwned { get; } | Option to control whether the owned documents in the documents container must be converted |
| ConvertOwner { get; } | Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document |
| Depth { get; } | Option to control how many levels in depth to perform conversion |

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/convertowned.md

#### IDocumentsContainerLoadOptions.ConvertOwned property

Option to control whether the owned documents in the documents container must be converted

```csharp
public bool ConvertOwned { get; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/convertowner.md

#### IDocumentsContainerLoadOptions.ConvertOwner property

Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document

```csharp
public bool ConvertOwner { get; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/depth.md

#### IDocumentsContainerLoadOptions.Depth property

Option to control how many levels in depth to perform conversion

```csharp
public int Depth { get; }
```

### ImageDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/imagedocumentinfo.md

#### ImageDocumentInfo class

Contains Image document metadata

```csharp
public class ImageDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets bits per pixel |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets height |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Width { get; } | Gets width |

### BitsPerPixel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/imagedocumentinfo/bitsperpixel.md

#### ImageDocumentInfo.BitsPerPixel property

Gets bits per pixel

```csharp
public int BitsPerPixel { get; }
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/imagedocumentinfo/height.md

#### ImageDocumentInfo.Height property

Gets height

```csharp
public int Height { get; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/imagedocumentinfo/width.md

#### ImageDocumentInfo.Width property

Gets width

```csharp
public int Width { get; }
```

### InlineXbrlDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/inlinexbrldocumentinfo.md

#### InlineXbrlDocumentInfo class

Contains iXbrl document metadata

```csharp
public class InlineXbrlDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### IsoDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/isodocumentinfo.md

#### IsoDocumentInfo class

Contains ISO document metadata

```csharp
public class IsoDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/isodocumentinfo/contenttree.md

#### IsoDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### JsonDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/jsondocumentinfo.md

#### JsonDocumentInfo class

Contains Json document metadata

```csharp
public class JsonDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### LhaDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/lhadocumentinfo.md

#### LhaDocumentInfo class

Contains compression document metadata

```csharp
public class LhaDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/lhadocumentinfo/contenttree.md

#### LhaDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### Lz4DocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/lz4documentinfo.md

#### Lz4DocumentInfo class

Contains Lzip document metadata

```csharp
public class Lz4DocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### LzipDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/lzipdocumentinfo.md

#### LzipDocumentInfo class

Contains Lzip document metadata

```csharp
public class LzipDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### LzmaDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/lzmadocumentinfo.md

#### LzmaDocumentInfo class

Contains Lzma document metadata

```csharp
public class LzmaDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### NoteDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/notedocumentinfo.md

#### NoteDocumentInfo class

Contains Note document metadata

```csharp
public class NoteDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Title { get; } | Gets title |

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/notedocumentinfo/title.md

#### NoteDocumentInfo.Title property

Gets title

```csharp
public string Title { get; }
```

### OlmDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/olmdocumentinfo.md

#### OlmDocumentInfo class

Contains personal storage document metadata

```csharp
public class OlmDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Folders { get; } | Folders in the storage |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### Folders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/olmdocumentinfo/folders.md

#### OlmDocumentInfo.Folders property

Folders in the storage

```csharp
public IList<OlmFolderInfo> Folders { get; }
```

### OlmFolderInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/olmfolderinfo.md

#### OlmFolderInfo class

Personal Storage Folder info

```csharp
public sealed class OlmFolderInfo : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| ItemsCount { get; } | Count of the items in the folder |
| Name { get; } | Name of the folder |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation of personal storage folder info |

### ItemsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/olmfolderinfo/itemscount.md

#### OlmFolderInfo.ItemsCount property

Count of the items in the folder

```csharp
public int ItemsCount { get; }
```

### Name
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/olmfolderinfo/name.md

#### OlmFolderInfo.Name property

Name of the folder

```csharp
public string Name { get; }
```

### ToString
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/olmfolderinfo/tostring.md

#### OlmFolderInfo.ToString method

String representation of personal storage folder info

```csharp
public override string ToString()
```

##### Return Value

String representation of personal storage folder info in format FolderName (ItemsCount)

### PasswordProtectedDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo.md

#### PasswordProtectedDocumentInfo class

Provided document is password protected

```csharp
public class PasswordProtectedDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### IsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/ispasswordprotected.md

#### PasswordProtectedDocumentInfo.IsPasswordProtected property

Gets is document password protected

```csharp
public bool IsPasswordProtected { get; }
```

### PclDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pcldocumentinfo.md

#### PclDocumentInfo class

Contains Pcl document metadata

```csharp
public class PclDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### PdfDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo.md

#### PdfDocumentInfo class

Contains Pdf document metadata

```csharp
public class PdfDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets page height |
| IsLandscape { get; } | Gets is page landscaped |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| TableOfContents { get; } | Table of contents |
| Title { get; } | Gets title |
| Version { get; } | Gets version |
| Width { get; } | Gets page width |

### Author
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/author.md

#### PdfDocumentInfo.Author property

Gets author

```csharp
public string Author { get; }
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/height.md

#### PdfDocumentInfo.Height property

Gets page height

```csharp
public double Height { get; }
```

### IsLandscape
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/islandscape.md

#### PdfDocumentInfo.IsLandscape property

Gets is page landscaped

```csharp
public bool IsLandscape { get; }
```

### IsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/ispasswordprotected.md

#### PdfDocumentInfo.IsPasswordProtected property

Gets is document password protected

```csharp
public bool IsPasswordProtected { get; }
```

### TableOfContents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/tableofcontents.md

#### PdfDocumentInfo.TableOfContents property

Table of contents

```csharp
public IList<TableOfContentsItem> TableOfContents { get; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/title.md

#### PdfDocumentInfo.Title property

Gets title

```csharp
public string Title { get; }
```

### Version
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/version.md

#### PdfDocumentInfo.Version property

Gets version

```csharp
public string Version { get; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/pdfdocumentinfo/width.md

#### PdfDocumentInfo.Width property

Gets page width

```csharp
public double Width { get; }
```

### PersonalStorageDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragedocumentinfo.md

#### PersonalStorageDocumentInfo class

Contains personal storage document metadata

```csharp
public class PersonalStorageDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentCount { get; } | Get count of contents in the root folder |
| CreationDate { get; } | Implements `CreationDate` |
| Folders { get; } | Folders in the storage |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Is storage password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| RootFolderName { get; } | Root folder name |
| Size { get; } | Implements `Size` |

### ContentCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragedocumentinfo/contentcount.md

#### PersonalStorageDocumentInfo.ContentCount property

Get count of contents in the root folder

```csharp
public int ContentCount { get; }
```

### Folders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragedocumentinfo/folders.md

#### PersonalStorageDocumentInfo.Folders property

Folders in the storage

```csharp
public IList<PersonalStorageFolderInfo> Folders { get; }
```

### IsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragedocumentinfo/ispasswordprotected.md

#### PersonalStorageDocumentInfo.IsPasswordProtected property

Is storage password protected

```csharp
public bool IsPasswordProtected { get; }
```

### RootFolderName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragedocumentinfo/rootfoldername.md

#### PersonalStorageDocumentInfo.RootFolderName property

Root folder name

```csharp
public string RootFolderName { get; }
```

### PersonalStorageFolderInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragefolderinfo.md

#### PersonalStorageFolderInfo class

Personal Storage Folder info

```csharp
public sealed class PersonalStorageFolderInfo : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| Items { get; } | Items in the folder |
| ItemsCount { get; } | Count of the items in the folder |
| Name { get; } | Name of the folder |
| SubFolders { get; } | Sub Folders |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation of personal storage folder info |

### Items
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragefolderinfo/items.md

#### PersonalStorageFolderInfo.Items property

Items in the folder

```csharp
public IList<PersonalStorageItemInfo> Items { get; }
```

### ItemsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragefolderinfo/itemscount.md

#### PersonalStorageFolderInfo.ItemsCount property

Count of the items in the folder

```csharp
public int ItemsCount { get; }
```

### Name
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragefolderinfo/name.md

#### PersonalStorageFolderInfo.Name property

Name of the folder

```csharp
public string Name { get; }
```

### SubFolders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragefolderinfo/subfolders.md

#### PersonalStorageFolderInfo.SubFolders property

Sub Folders

```csharp
public IList<PersonalStorageFolderInfo> SubFolders { get; }
```

### ToString
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstoragefolderinfo/tostring.md

#### PersonalStorageFolderInfo.ToString method

String representation of personal storage folder info

```csharp
public override string ToString()
```

##### Return Value

String representation of personal storage folder info in format FolderName (ItemsCount)

### PersonalStorageItemInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo.md

#### PersonalStorageItemInfo class

Personal Storage Item info

```csharp
public sealed class PersonalStorageItemInfo : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| AttachmentsCount { get; } | Item Attachments Count |
| Bcc { get; } | Item Bcc |
| Cc { get; } | Item Cc |
| From { get; } | Item From |
| Sent { get; } | Item Sent DateTime |
| Size { get; } | Item Size |
| Subject { get; } | Item Subject |
| Title { get; } | Item Title |
| To { get; } | Item To |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AttachmentsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/attachmentscount.md

#### PersonalStorageItemInfo.AttachmentsCount property

Item Attachments Count

```csharp
public int AttachmentsCount { get; }
```

### Bcc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/bcc.md

#### PersonalStorageItemInfo.Bcc property

Item Bcc

```csharp
public string Bcc { get; }
```

### Cc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/cc.md

#### PersonalStorageItemInfo.Cc property

Item Cc

```csharp
public string Cc { get; }
```

### From
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/from.md

#### PersonalStorageItemInfo.From property

Item From

```csharp
public string From { get; }
```

### Sent
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/sent.md

#### PersonalStorageItemInfo.Sent property

Item Sent DateTime

```csharp
public DateTime? Sent { get; }
```

### Size
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/size.md

#### PersonalStorageItemInfo.Size property

Item Size

```csharp
public long Size { get; }
```

### Subject
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/subject.md

#### PersonalStorageItemInfo.Subject property

Item Subject

```csharp
public string Subject { get; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/title.md

#### PersonalStorageItemInfo.Title property

Item Title

```csharp
public string Title { get; }
```

### To
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/personalstorageiteminfo/to.md

#### PersonalStorageItemInfo.To property

Item To

```csharp
public string To { get; }
```

### PossibleConversions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions.md

#### PossibleConversions class

Represents a mapping what conversion pairs are supported for specific source file format

```csharp
public sealed class PossibleConversions : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| All { get; } | All target file types and primary/secondary flag IEnumerable of `TargetConversion` |
| Item { get; } | Returns target conversion for specified target file type (2 indexers) |
| LoadOptions { get; } | Predefined load options which could be used to convert from current type |
| Primary { get; } | Primary target file types |
| Secondary { get; } | Secondary target file types |
| Source { get; } | Source file formats |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### All
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions/all.md

#### PossibleConversions.All property

All target file types and primary/secondary flag IEnumerable of `TargetConversion`

```csharp
public IEnumerable<TargetConversion> All { get; }
```

### Item
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions/item.md

#### PossibleConversions indexer (1 of 2)

Returns target conversion for specified target file type

```csharp
public TargetConversion this[FileType target] { get; }
```

| Parameter | Description |
| --- | --- |
| target | The file type for which to get the target conversion |

##### Return Value

`TargetConversion` or null

#### PossibleConversions indexer (2 of 2)

Returns target conversion for specified target file type extension

```csharp
public TargetConversion this[string extension] { get; }
```

| Parameter | Description |
| --- | --- |
| extension | file extension for which to return the target conversion |

##### Return Value

`TargetConversion` or null

### LoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions/loadoptions.md

#### PossibleConversions.LoadOptions property

Predefined load options which could be used to convert from current type

```csharp
public LoadOptions LoadOptions { get; }
```

### Primary
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions/primary.md

#### PossibleConversions.Primary property

Primary target file types

```csharp
public IEnumerable<FileType> Primary { get; }
```

### Secondary
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions/secondary.md

#### PossibleConversions.Secondary property

Secondary target file types

```csharp
public IEnumerable<FileType> Secondary { get; }
```

### Source
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/possibleconversions/source.md

#### PossibleConversions.Source property

Source file formats

```csharp
public FileType Source { get; }
```

### PresentationDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/presentationdocumentinfo.md

#### PresentationDocumentInfo class

Contains Presentation document metadata

```csharp
public class PresentationDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is the document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Title { get; } | Gets title |

### Author
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/presentationdocumentinfo/author.md

#### PresentationDocumentInfo.Author property

Gets author

```csharp
public string Author { get; }
```

### IsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/presentationdocumentinfo/ispasswordprotected.md

#### PresentationDocumentInfo.IsPasswordProtected property

Gets is the document password protected

```csharp
public bool IsPasswordProtected { get; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/presentationdocumentinfo/title.md

#### PresentationDocumentInfo.Title property

Gets title

```csharp
public string Title { get; }
```

### ProjectManagementDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/projectmanagementdocumentinfo.md

#### ProjectManagementDocumentInfo class

Contains ProjectManagement document metadata

```csharp
public class ProjectManagementDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| EndDate { get; } | Project end date |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| StartDate { get; } | Project start date |
| TasksCount { get; } | Tasks count |

### EndDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/enddate.md

#### ProjectManagementDocumentInfo.EndDate property

Project end date

```csharp
public DateTime EndDate { get; }
```

### StartDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/startdate.md

#### ProjectManagementDocumentInfo.StartDate property

Project start date

```csharp
public DateTime StartDate { get; }
```

### TasksCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/taskscount.md

#### ProjectManagementDocumentInfo.TasksCount property

Tasks count

```csharp
public int TasksCount { get; }
```

### PsdDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/psddocumentinfo.md

#### PsdDocumentInfo class

Contains Psd document metadata

```csharp
public class PsdDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets bits per pixel |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets height |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Width { get; } | Gets width |

### BitsPerPixel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/psddocumentinfo/bitsperpixel.md

#### PsdDocumentInfo.BitsPerPixel property

Gets bits per pixel

```csharp
public int BitsPerPixel { get; }
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/psddocumentinfo/height.md

#### PsdDocumentInfo.Height property

Gets height

```csharp
public int Height { get; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/psddocumentinfo/width.md

#### PsdDocumentInfo.Width property

Gets width

```csharp
public int Width { get; }
```

### PsDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/psdocumentinfo.md

#### PsDocumentInfo class

Contains Ps document metadata

```csharp
public class PsDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### PublisherDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/publisherdocumentinfo.md

#### PublisherDocumentInfo class

Contains Publisher document metadata

```csharp
public class PublisherDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### RarDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rardocumentinfo.md

#### RarDocumentInfo class

Contains Rar document metadata

```csharp
public class RarDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rardocumentinfo/contenttree.md

#### RarDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### Rectangle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle.md

#### Rectangle class

Represents a rectangle defined by its edges for cropping purposes.

```csharp
public sealed class Rectangle : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| Rectangle(int, int, int, int) | Initializes a new instance of the `Rectangle` struct with specified edges. |

#### Properties

| Name | Description |
| --- | --- |
| Bottom { get; } | Gets the bottom edge of the rectangle. |
| Height { get; } | Gets the height of the rectangle based on top and bottom edges. |
| Left { get; } | Gets the left edge of the rectangle. |
| Right { get; } | Gets the right edge of the rectangle. |
| Top { get; } | Gets the top edge of the rectangle. |
| Width { get; } | Gets the width of the rectangle based on left and right edges. |

#### Methods

| Name | Description |
| --- | --- |
| Crop(int, int, int, int) | Creates a cropped version of the current rectangle by removing specified margins. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string representation of the rectangle. |

### Bottom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/bottom.md

#### Rectangle.Bottom property

Gets the bottom edge of the rectangle.

```csharp
public int Bottom { get; }
```

### Crop
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/crop.md

#### Rectangle.Crop method

Creates a cropped version of the current rectangle by removing specified margins.

```csharp
public Rectangle Crop(int cropLeft, int cropTop, int cropRight, int cropBottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cropLeft | Int32 | The number of pixels to remove from the left side. |
| cropTop | Int32 | The number of pixels to remove from the top side. |
| cropRight | Int32 | The number of pixels to remove from the right side. |
| cropBottom | Int32 | The number of pixels to remove from the bottom side. |

##### Return Value

A new cropped rectangle.

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/height.md

#### Rectangle.Height property

Gets the height of the rectangle based on top and bottom edges.

```csharp
public int Height { get; }
```

### Left
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/left.md

#### Rectangle.Left property

Gets the left edge of the rectangle.

```csharp
public int Left { get; }
```

### Rectangle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/rectangle.md

#### Rectangle constructor

Initializes a new instance of the `Rectangle` struct with specified edges.

```csharp
public Rectangle(int left, int top, int right, int bottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Int32 | The left edge of the rectangle. |
| top | Int32 | The top edge of the rectangle. |
| right | Int32 | The right edge of the rectangle. |
| bottom | Int32 | The bottom edge of the rectangle. |

### Right
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/right.md

#### Rectangle.Right property

Gets the right edge of the rectangle.

```csharp
public int Right { get; }
```

### Top
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/top.md

#### Rectangle.Top property

Gets the top edge of the rectangle.

```csharp
public int Top { get; }
```

### ToString
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/tostring.md

#### Rectangle.ToString method

Returns a string representation of the rectangle.

```csharp
public override string ToString()
```

##### Return Value

A string representing the rectangle's position and size.

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/rectangle/width.md

#### Rectangle.Width property

Gets the width of the rectangle based on left and right edges.

```csharp
public int Width { get; }
```

### SevenZipDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/sevenzipdocumentinfo.md

#### SevenZipDocumentInfo class

Contains 7Zip document metadata

```csharp
public class SevenZipDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/sevenzipdocumentinfo/contenttree.md

#### SevenZipDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### SpreadsheetDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo.md

#### SpreadsheetDocumentInfo class

Contains Spreadsheet document metadata

```csharp
public class SpreadsheetDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ActiveWorksheetIndex { get; } | Gets active worksheet index |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Title { get; } | Gets title |
| Worksheets { get; } | Worksheets names |
| WorksheetsCount { get; } | Gets worksheets count |

### ActiveWorksheetIndex
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/activeworksheetindex.md

#### SpreadsheetDocumentInfo.ActiveWorksheetIndex property

Gets active worksheet index

```csharp
public int ActiveWorksheetIndex { get; }
```

### Author
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/author.md

#### SpreadsheetDocumentInfo.Author property

Gets author

```csharp
public string Author { get; }
```

### IsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/ispasswordprotected.md

#### SpreadsheetDocumentInfo.IsPasswordProtected property

Gets is document password protected

```csharp
public bool IsPasswordProtected { get; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/title.md

#### SpreadsheetDocumentInfo.Title property

Gets title

```csharp
public string Title { get; }
```

### Worksheets
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/worksheets.md

#### SpreadsheetDocumentInfo.Worksheets property

Worksheets names

```csharp
public string[] Worksheets { get; }
```

### WorksheetsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/worksheetscount.md

#### SpreadsheetDocumentInfo.WorksheetsCount property

Gets worksheets count

```csharp
public int WorksheetsCount { get; }
```

### SvgDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/svgdocumentinfo.md

#### SvgDocumentInfo class

Contains Svg document metadata

```csharp
public class SvgDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### TableOfContentsItem
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/tableofcontentsitem.md

#### TableOfContentsItem class

Contains Table of contents item metadata

```csharp
public class TableOfContentsItem
```

#### Properties

| Name | Description |
| --- | --- |
| Page { get; } | Bookmark page |
| Title { get; } | Bookmark title |

### Page
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/tableofcontentsitem/page.md

#### TableOfContentsItem.Page property

Bookmark page

```csharp
public int Page { get; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/tableofcontentsitem/title.md

#### TableOfContentsItem.Title property

Bookmark title

```csharp
public string Title { get; }
```

### TarDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/tardocumentinfo.md

#### TarDocumentInfo class

Contains Tar document metadata

```csharp
public class TarDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/tardocumentinfo/contenttree.md

#### TarDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### TargetConversion
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/targetconversion.md

#### TargetConversion class

Represents possible target conversion and a flag is it a primary or secondary

```csharp
public sealed class TargetConversion
```

#### Properties

| Name | Description |
| --- | --- |
| ConvertOptions { get; } | Predefined convert options which could be used to convert to current type |
| Format { get; } | Target document format |
| IsPrimary { get; } | Is the conversion primary |

### ConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/targetconversion/convertoptions.md

#### TargetConversion.ConvertOptions property

Predefined convert options which could be used to convert to current type

```csharp
public ConvertOptions ConvertOptions { get; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/targetconversion/format.md

#### TargetConversion.Format property

Target document format

```csharp
public FileType Format { get; }
```

### IsPrimary
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/targetconversion/isprimary.md

#### TargetConversion.IsPrimary property

Is the conversion primary

```csharp
public bool IsPrimary { get; }
```

### TexDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/texdocumentinfo.md

#### TexDocumentInfo class

Contains Tex document metadata

```csharp
public class TexDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ThreeDDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/threeddocumentinfo.md

#### ThreeDDocumentInfo class

Contains 3D document metadata

```csharp
public class ThreeDDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### TsvDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/tsvdocumentinfo.md

#### TsvDocumentInfo class

Contains Tsv document metadata

```csharp
public class TsvDocumentInfo : SpreadsheetDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ActiveWorksheetIndex { get; } | Gets active worksheet index |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| Title { get; } | Gets title |
| Worksheets { get; } | Worksheets names |
| WorksheetsCount { get; } | Gets worksheets count |

### TxtDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/txtdocumentinfo.md

#### TxtDocumentInfo class

Contains Txt document metadata

```csharp
public class TxtDocumentInfo : WordProcessingDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| Lines { get; } | Gets lines count |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| TableOfContents { get; } | Table of contents |
| Title { get; } | Gets title |
| Words { get; } | Gets words count |

### UueDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/uuedocumentinfo.md

#### UueDocumentInfo class

Contains Uue document metadata

```csharp
public class UueDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ValueObject
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/valueobject.md

#### ValueObject class

Abstract value object class.

```csharp
public abstract class ValueObject : IEquatable<ValueObject>
```

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| operator == | Equality operator. |
| operator != | Inequality operator. |

### Equals
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/valueobject/equals.md

#### Equals(object)

Determines whether two object instances are equal.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current object. |

##### Return Value

`true` if the specified object is equal to the current object; otherwise, `false`.

#### Equals(ValueObject)

Determines whether two object instances are equal.

```csharp
public virtual bool Equals(ValueObject other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ValueObject | The object to compare with the current object. |

##### Return Value

`true` if the specified object is equal to the current object; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/valueobject/gethashcode.md

#### ValueObject.GetHashCode method

Serves as the default hash function.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current object.

### op_Equality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/valueobject/op_equality.md

#### ValueObject Equality operator

Equality operator.

```csharp
public static bool operator ==(ValueObject a, ValueObject b)
```

| Parameter | Type | Description |
| --- | --- | --- |
| a | ValueObject | The first object |
| b | ValueObject | The second object |

##### Return Value

`true` if objects are equal

### op_Inequality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/valueobject/op_inequality.md

#### ValueObject Inequality operator

Inequality operator.

```csharp
public static bool operator !=(ValueObject a, ValueObject b)
```

| Parameter | Type | Description |
| --- | --- | --- |
| a | ValueObject | The first object |
| b | ValueObject | The second object |

##### Return Value

`true` if objects are not equal

### VcfDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/vcfdocumentinfo.md

#### VcfDocumentInfo class

Contains Vcf document metadata

```csharp
public class VcfDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContactsCount { get; } | Contacts count |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContactsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/vcfdocumentinfo/contactscount.md

#### VcfDocumentInfo.ContactsCount property

Contacts count

```csharp
public int ContactsCount { get; }
```

### VideoDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/videodocumentinfo.md

#### VideoDocumentInfo class

Contains Video document metadata

```csharp
public class VideoDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### WebDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/webdocumentinfo.md

#### WebDocumentInfo class

Contains Web document metadata

```csharp
public class WebDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Encoding { get; } | Detected document encoding |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### Encoding
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/webdocumentinfo/encoding.md

#### WebDocumentInfo.Encoding property

Detected document encoding

```csharp
public Encoding Encoding { get; }
```

### WordProcessingDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo.md

#### WordProcessingDocumentInfo class

Contains WordProcessing document metadata

```csharp
public class WordProcessingDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| Lines { get; } | Gets lines count |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| TableOfContents { get; } | Table of contents |
| Title { get; } | Gets title |
| Words { get; } | Gets words count |

### Author
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/author.md

#### WordProcessingDocumentInfo.Author property

Gets author

```csharp
public string Author { get; }
```

### IsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/ispasswordprotected.md

#### WordProcessingDocumentInfo.IsPasswordProtected property

Gets is document password protected

```csharp
public bool IsPasswordProtected { get; }
```

### Lines
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/lines.md

#### WordProcessingDocumentInfo.Lines property

Gets lines count

```csharp
public int Lines { get; }
```

### TableOfContents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/tableofcontents.md

#### WordProcessingDocumentInfo.TableOfContents property

Table of contents

```csharp
public IList<TableOfContentsItem> TableOfContents { get; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/title.md

#### WordProcessingDocumentInfo.Title property

Gets title

```csharp
public string Title { get; }
```

### Words
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/words.md

#### WordProcessingDocumentInfo.Words property

Gets words count

```csharp
public int Words { get; }
```

### XbrlDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/xbrldocumentinfo.md

#### XbrlDocumentInfo class

Contains Xbrl document metadata

```csharp
public class XbrlDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### XmlDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/xmldocumentinfo.md

#### XmlDocumentInfo class

Contains Xml document metadata

```csharp
public class XmlDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### XpsDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/xpsdocumentinfo.md

#### XpsDocumentInfo class

Contains Xps document metadata

```csharp
public class XpsDocumentInfo : PdfDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets page height |
| IsLandscape { get; } | Gets is page landscaped |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| TableOfContents { get; } | Table of contents |
| Title { get; } | Gets title |
| Version { get; } | Gets version |
| Width { get; } | Gets page width |

### XslFoDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/xslfodocumentinfo.md

#### XslFoDocumentInfo class

Contains XslFo document metadata

```csharp
public class XslFoDocumentInfo : PdfDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets author |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Height { get; } | Gets page height |
| IsLandscape { get; } | Gets is page landscaped |
| IsPasswordProtected { get; } | Gets is document password protected |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |
| TableOfContents { get; } | Table of contents |
| Title { get; } | Gets title |
| Version { get; } | Gets version |
| Width { get; } | Gets page width |

### XzDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/xzdocumentinfo.md

#### XzDocumentInfo class

Contains Xz document metadata

```csharp
public class XzDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ZDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/zdocumentinfo.md

#### ZDocumentInfo class

Contains Z document metadata

```csharp
public class ZDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ZipDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/zipdocumentinfo.md

#### ZipDocumentInfo class

Contains compression document metadata

```csharp
public class ZipDocumentInfo : DocumentInfo, ICompressionDocumentHierarchyInfo
```

#### Properties

| Name | Description |
| --- | --- |
| ContentTree { get; } | Gets the hierarchical structure of the compressed content. |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### ContentTree
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/zipdocumentinfo/contenttree.md

#### ZipDocumentInfo.ContentTree property

Gets the hierarchical structure of the compressed content.

```csharp
public CompressionNodeInfo ContentTree { get; }
```

### ZstDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.contracts/zstdocumentinfo.md

#### ZstDocumentInfo class

Contains Zst document metadata

```csharp
public class ZstDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| CreationDate { get; } | Implements `CreationDate` |
| Format { get; } | Implements `Format` |
| Item { get; } | Implements `Item` |
| PagesCount { get; } | Implements `PagesCount` |
| PropertyNames { get; } | Implements `PropertyNames` |
| Size { get; } | Implements `Size` |

### GroupDocs.Conversion.Exceptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions.md

The namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| ConversionByPageFailedException | Conversion by page failed exception |
| ConversionFailedException | Conversion failed exception |
| ConversionNotSupportedException | GroupDocs exception thrown when the conversion from source file to target file type is not supported |
| CorruptOrDamagedFileException | GroupDocs exception thrown when the file is corrupt or damaged |
| FileTypeNotSupportedException | GroupDocs exception thrown when the file type is not supported |
| FontSubstituteException | Thrown if font substitute is illegal |
| GroupDocsConversionException | GroupDocs.Conversion general exception |
| IncorrectPasswordException | GroupDocs exception thrown when the file is password protected, password is provided but is incorrect |
| InvalidConverterSettingsException | Thrown if provided converter settings are invalid |
| InvalidConvertOptionsException | Thrown if provided convert options are invalid |
| InvalidLoadOptionsException | Thrown if provided load options are invalid |
| PasswordRequiredException | GroupDocs exception thrown when the file is password protected and password is not provided |
| SourceDocumentFactoryNotProvidedException | GroupDocs exception thrown when the source document factory is not provided |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### ConversionByPageFailedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionbypagefailedexception.md

#### ConversionByPageFailedException class

Conversion by page failed exception

```csharp
public class ConversionByPageFailedException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| ConversionByPageFailedException() | Default constructor |
| ConversionByPageFailedException(ConvertedPageContext, Exception) | Creates an exception with a specific message and propagates the inner exception |

#### Properties

| Name | Description |
| --- | --- |
| ConversionContext { get; } | Conversion context that caused the conversion to fail |
| Exception { get; } | Exception that caused the conversion to fail |

#### Methods

| Name | Description |
| --- | --- |
| override GetObjectData(SerializationInfo, StreamingContext) | Populates a SerializationInfo with the data needed to serialize the target object. |

### ConversionByPageFailedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionbypagefailedexception/conversionbypagefailedexception.md

#### ConversionByPageFailedException()

Default constructor

```csharp
public ConversionByPageFailedException()
```

#### ConversionByPageFailedException(ConvertedPageContext, Exception)

Creates an exception with a specific message and propagates the inner exception

```csharp
public ConversionByPageFailedException(ConvertedPageContext convertedContext, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertedContext | ConvertedPageContext |  |
| exception | Exception | The inner exception |

### ConversionContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionbypagefailedexception/conversioncontext.md

#### ConversionByPageFailedException.ConversionContext property

Conversion context that caused the conversion to fail

```csharp
public ConvertedPageContext ConversionContext { get; }
```

### Exception
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionbypagefailedexception/exception.md

#### ConversionByPageFailedException.Exception property

Exception that caused the conversion to fail

```csharp
public Exception Exception { get; }
```

### GetObjectData
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionbypagefailedexception/getobjectdata.md

#### ConversionByPageFailedException.GetObjectData method

Populates a SerializationInfo with the data needed to serialize the target object.

```csharp
public override void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | The SerializationInfo to populate with data. |
| context | StreamingContext | The destination for this serialization. |

### ConversionFailedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionfailedexception.md

#### ConversionFailedException class

Conversion failed exception

```csharp
public class ConversionFailedException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| ConversionFailedException() | Default constructor |
| ConversionFailedException(ConvertedContext, Exception) | Creates an exception with a specific message and propagates the inner exception |

#### Properties

| Name | Description |
| --- | --- |
| ConversionContext { get; } | Conversion context that caused the conversion to fail |
| Exception { get; } | Exception that caused the conversion to fail |

#### Methods

| Name | Description |
| --- | --- |
| override GetObjectData(SerializationInfo, StreamingContext) | Populates a SerializationInfo with the data needed to serialize the target object. |

### ConversionContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionfailedexception/conversioncontext.md

#### ConversionFailedException.ConversionContext property

Conversion context that caused the conversion to fail

```csharp
public ConvertedContext ConversionContext { get; }
```

### ConversionFailedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionfailedexception/conversionfailedexception.md

#### ConversionFailedException()

Default constructor

```csharp
public ConversionFailedException()
```

#### ConversionFailedException(ConvertedContext, Exception)

Creates an exception with a specific message and propagates the inner exception

```csharp
public ConversionFailedException(ConvertedContext convertedContext, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertedContext | ConvertedContext |  |
| exception | Exception | The inner exception |

### Exception
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionfailedexception/exception.md

#### ConversionFailedException.Exception property

Exception that caused the conversion to fail

```csharp
public Exception Exception { get; }
```

### GetObjectData
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionfailedexception/getobjectdata.md

#### ConversionFailedException.GetObjectData method

Populates a SerializationInfo with the data needed to serialize the target object.

```csharp
public override void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | The SerializationInfo to populate with data. |
| context | StreamingContext | The destination for this serialization. |

### ConversionNotSupportedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionnotsupportedexception.md

#### ConversionNotSupportedException class

GroupDocs exception thrown when the conversion from source file to target file type is not supported

```csharp
public sealed class ConversionNotSupportedException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| ConversionNotSupportedException(string) | Creates an exception instance with a message |

### ConversionNotSupportedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/conversionnotsupportedexception/conversionnotsupportedexception.md

#### ConversionNotSupportedException constructor

Creates an exception instance with a message

```csharp
public ConversionNotSupportedException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### CorruptOrDamagedFileException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/corruptordamagedfileexception.md

#### CorruptOrDamagedFileException class

GroupDocs exception thrown when the file is corrupt or damaged

```csharp
public sealed class CorruptOrDamagedFileException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| CorruptOrDamagedFileException() | Default constructor |
| CorruptOrDamagedFileException(FileType) | Creates an exception instance with a FileType |
| CorruptOrDamagedFileException(string) | Creates an exception instance with a message |
| CorruptOrDamagedFileException(string, Exception) | Creates an exception instance with a message and propagates the inner exception |

### CorruptOrDamagedFileException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/corruptordamagedfileexception/corruptordamagedfileexception.md

#### CorruptOrDamagedFileException()

Default constructor

```csharp
public CorruptOrDamagedFileException()
```

#### CorruptOrDamagedFileException(FileType)

Creates an exception instance with a FileType

```csharp
public CorruptOrDamagedFileException(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type |

#### CorruptOrDamagedFileException(string)

Creates an exception instance with a message

```csharp
public CorruptOrDamagedFileException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

#### CorruptOrDamagedFileException(string, Exception)

Creates an exception instance with a message and propagates the inner exception

```csharp
public CorruptOrDamagedFileException(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |
| exception | Exception | The inner exception |

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

GroupDocs exception thrown when the file type is not supported

```csharp
public sealed class FileTypeNotSupportedException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| FileTypeNotSupportedException() | Default constructor |
| FileTypeNotSupportedException(FileType) | Creates an exception instance with a FileType |
| FileTypeNotSupportedException(string) | Creates an exception instance with a message |

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/filetypenotsupportedexception/filetypenotsupportedexception.md

#### FileTypeNotSupportedException()

Default constructor

```csharp
public FileTypeNotSupportedException()
```

#### FileTypeNotSupportedException(FileType)

Creates an exception instance with a FileType

```csharp
public FileTypeNotSupportedException(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type |

#### FileTypeNotSupportedException(string)

Creates an exception instance with a message

```csharp
public FileTypeNotSupportedException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### FontSubstituteException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/fontsubstituteexception.md

#### FontSubstituteException class

Thrown if font substitute is illegal

```csharp
public sealed class FontSubstituteException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| FontSubstituteException() | Default constructor |
| FontSubstituteException(string) | Creates an exception with a specific message |

### FontSubstituteException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/fontsubstituteexception/fontsubstituteexception.md

#### FontSubstituteException()

Default constructor

```csharp
public FontSubstituteException()
```

#### FontSubstituteException(string)

Creates an exception with a specific message

```csharp
public FontSubstituteException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### GroupDocsConversionException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/groupdocsconversionexception.md

#### GroupDocsConversionException class

GroupDocs.Conversion general exception

```csharp
public class GroupDocsConversionException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsConversionException() | Default constructor |
| GroupDocsConversionException(string) | Creates an exception with a specific message |
| GroupDocsConversionException(string, Exception) | Creates an exception with a specific message and propagates the inner exception |

### GroupDocsConversionException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/groupdocsconversionexception/groupdocsconversionexception.md

#### GroupDocsConversionException()

Default constructor

```csharp
public GroupDocsConversionException()
```

#### GroupDocsConversionException(string)

Creates an exception with a specific message

```csharp
public GroupDocsConversionException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

#### GroupDocsConversionException(string, Exception)

Creates an exception with a specific message and propagates the inner exception

```csharp
public GroupDocsConversionException(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |
| exception | Exception | The inner exception |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

GroupDocs exception thrown when the file is password protected, password is provided but is incorrect

```csharp
public sealed class IncorrectPasswordException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| IncorrectPasswordException() | Default constructor |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/incorrectpasswordexception/incorrectpasswordexception.md

#### IncorrectPasswordException constructor

Default constructor

```csharp
public IncorrectPasswordException()
```

### InvalidConverterSettingsException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/invalidconvertersettingsexception.md

#### InvalidConverterSettingsException class

Thrown if provided converter settings are invalid

```csharp
public sealed class InvalidConverterSettingsException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidConverterSettingsException() | Default constructor |
| InvalidConverterSettingsException(string) | Creates an exception with a specific message |

### InvalidConverterSettingsException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/invalidconvertersettingsexception/invalidconvertersettingsexception.md

#### InvalidConverterSettingsException()

Default constructor

```csharp
public InvalidConverterSettingsException()
```

#### InvalidConverterSettingsException(string)

Creates an exception with a specific message

```csharp
public InvalidConverterSettingsException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### InvalidConvertOptionsException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/invalidconvertoptionsexception.md

#### InvalidConvertOptionsException class

Thrown if provided convert options are invalid

```csharp
public sealed class InvalidConvertOptionsException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidConvertOptionsException() | Default constructor |
| InvalidConvertOptionsException(string) | Creates an exception with a specific message |

### InvalidConvertOptionsException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/invalidconvertoptionsexception/invalidconvertoptionsexception.md

#### InvalidConvertOptionsException()

Default constructor

```csharp
public InvalidConvertOptionsException()
```

#### InvalidConvertOptionsException(string)

Creates an exception with a specific message

```csharp
public InvalidConvertOptionsException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### InvalidLoadOptionsException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/invalidloadoptionsexception.md

#### InvalidLoadOptionsException class

Thrown if provided load options are invalid

```csharp
public sealed class InvalidLoadOptionsException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidLoadOptionsException() | Default constructor |
| InvalidLoadOptionsException(string) | Creates an exception with a specific message |

### InvalidLoadOptionsException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/invalidloadoptionsexception/invalidloadoptionsexception.md

#### InvalidLoadOptionsException()

Default constructor

```csharp
public InvalidLoadOptionsException()
```

#### InvalidLoadOptionsException(string)

Creates an exception with a specific message

```csharp
public InvalidLoadOptionsException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### PasswordRequiredException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

GroupDocs exception thrown when the file is password protected and password is not provided

```csharp
public sealed class PasswordRequiredException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| PasswordRequiredException() | Default constructor |
| PasswordRequiredException(FileType) | Creates an exception instance with a FileType |
| PasswordRequiredException(string) | Creates an exception instance with a message |

### PasswordRequiredException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/passwordrequiredexception/passwordrequiredexception.md

#### PasswordRequiredException()

Default constructor

```csharp
public PasswordRequiredException()
```

#### PasswordRequiredException(FileType)

Creates an exception instance with a FileType

```csharp
public PasswordRequiredException(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type |

#### PasswordRequiredException(string)

Creates an exception instance with a message

```csharp
public PasswordRequiredException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message |

### SourceDocumentFactoryNotProvidedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/sourcedocumentfactorynotprovidedexception.md

#### SourceDocumentFactoryNotProvidedException class

GroupDocs exception thrown when the source document factory is not provided

```csharp
public sealed class SourceDocumentFactoryNotProvidedException : GroupDocsConversionException
```

#### Constructors

| Name | Description |
| --- | --- |
| SourceDocumentFactoryNotProvidedException() | Creates an exception instance with a message |

### SourceDocumentFactoryNotProvidedException
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.exceptions/sourcedocumentfactorynotprovidedexception/sourcedocumentfactorynotprovidedexception.md

#### SourceDocumentFactoryNotProvidedException constructor

Creates an exception instance with a message

```csharp
public SourceDocumentFactoryNotProvidedException()
```

### GroupDocs.Conversion.FileTypes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes.md

The namespace provides classes which represent supported file types.

#### Classes

| Class | Description |
| --- | --- |
| AudioFileType | Defines Audio documents Includes the following types: `Mp3`, `Aac`, `Aiff`, `Flac`, `M4a`, `Wma`, `Ac3`, `Ogg`, `Wav`, Learn more about audio formats [here](https://docs.fileformat.com/audio/). |
| CadFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. Includes the following types: `Cf2``Dgn`, `Dwf`, `Dwfx``Dwg`, `Dwt`, `Dxf`, `Ifc`, `Igs`, `Plt`, `Stl`. Learn more about CAD formats [here](https://wiki.fileformat.com/cad). |
| CompressionFileType | Defines compression formats. Includes the following file types: `Zip`. `Rar`. `SevenZ`. `Tar`. `Gz`. `Gzip`. `Bz2`. `Lz`. `Z`. `Xz`. `Xz`. `Cpio`. `Cab`. `Lzma`. `Zst`. `Uue`. `Lha`. `Lz4`. Learn more about compression formats [here](https://docs.fileformat.com/compression/). |
| DatabaseFileType | Defines database documents. Includes the following file types: `Nsf``Log``Sql` |
| DiagramFileType | Defines Diagram documents. Includes the following types: `Vdw`, `Vdx`, `Vsd`, `Vsdm`, `Vsdx`, `Vss`, `Vssm`, `Vssx`, `Vst`, `Vstm`, `Vstx`, `Vsx`, `Vtx`. |
| EBookFileType | Defines EBook documents. Includes the following file types: `Epub``Mobi``Azw3` |
| EmailFileType | Defines Email file formats that are used by email applications to store their various data including email messages, attachments, folders, address books etc. Includes the following file types: `Eml`, `Emlx`, `Msg`, `Vcf`. `Mbox`. `Pst`. `Ost`. `Olm`. Learn more about Email formats [here](https://wiki.fileformat.com/email). |
| FileType | File type base class |
| FinanceFileType | Defines Finance documents Includes the following types: `Xbrl``IXbrl``Ofx` Learn more about Finance formats [here](https://docs.fileformat.com/finance/). |
| FontFileType | Defines Font documents Includes the following types: `Ttf``Eot``Otf``Cff``Type1``Woff``Woff2` Learn more about Font formats [here](https://docs.fileformat.com/font/). |
| GisFileType | Defines GIS documents. Includes the following file types: `Shp`. `GeoJson`. `Gdb`. `Gml`. `Kml`. `Gpx`. `TopoJson`. `Osm`. |
| ImageFileType | Defines image documents. Includes the following file types: `Ai`, `Avif`, `Bmp`, `Cdr`, `Cmx`, `Dcm`, `Dib`, `DjVu`, `Dng`, `Emf`, `Emz`, `Gif`, `Heic``Ico`, `J2c`, `J2k`, `Jls`, `Jp2`, `Jpc`, `Jfif`. `Jpeg`, `Jpf`, `Jpg`, `Jpm`, `Jpx`, `Odg`, `Png`, `Psd`, `Tif`, `Tiff`, `Webp`, `Wmf`. `Wmz`. Learn more about Image formats [here](https://wiki.fileformat.com/image). |
| NoteFileType | Defines Note-taking formats. Includes the following file types: `One`. Learn more about Note-taking formats [here](https://wiki.fileformat.com/note-taking). |
| PageDescriptionLanguageFileType | Defines Page description documents. Includes the following file types: `Svg``Svgz``Eps``Cgm``Xps``Tex``Ps``Pcl``Oxps` |
| PdfFileType | Defines Pdf documents. Includes the following file types: `Pdf`, |
| PresentationFileType | Defines Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. Includes the following file types: `Odp`, `Otp`, `Pot`, `Potm`, `Potx`, `Pps`, `Ppsm`, `Ppsx`, `Ppt`, `Pptm`, `Pptx`. Learn more about Presentation formats [here](https://wiki.fileformat.com/presentation). |
| ProjectManagementFileType | Defines Project file formats that are created by Project Management software such as Microsoft Project, Primavera P6 etc. A project file is a collection of tasks, resources, and their scheduling to get a measurable output in the form or a product or a service. Project management documents. Includes the following file types: `Mpp`, `Mpt`, `Mpx`. Learn more about Project Management formats [here](https://wiki.fileformat.com/project-management). |
| PublisherFileType | Defines Publisher documents Includes the following types: `Pub` Learn more about Publisher formats [here](https://docs.fileformat.com/publisher/). |
| SpreadsheetFileType | Defines Spreadsheet documents. Includes the following file types: `Csv`, `Fods`, `Ods`, `Ots`, `Tsv`, `Xlam`, `Xls`, `Xlsb`, `Xlsm`, `Xlsx`, `Xlt`, `Xltm`, `Xltx`. Learn more about Spreadsheet formats [here](https://wiki.fileformat.com/spreadsheet). |
| ThreeDFileType | Defines 3D documents Includes the following types: `Fbx``ThreeDS``ThreeMF``Amf``Ase``Rvm``Dae``Drc``Gltf``Obj``Ply``Jt``U3d``Usd``Usdz``Vrml``X``Glb``Ma``Mb` Learn more about 3D formats [here](https://wiki.fileformat.com/3d). |
| VideoFileType | Defines Video documents Includes the following types: `Mp4`, `Avi`, `Flv`, `Mkv`, `Mov`, `Webm`, `Wmv`, Learn more about video formats [here](https://docs.fileformat.com/video/). |
| WebFileType | Defines Web documents. Includes the following file types: `Xml``Json``Html``Htm``Mht``Mhtml``Chm` |
| WordProcessingFileType | Defines Word Processing files that contain user information in plain text or rich text format. A plain text file format contains unformatted text and no font or page settings etc. can be applied. In contrast, a rich text file format allows formatting options such as setting fonts type, styles (bold, italic, underline, etc.), page margins, headings, bullets and numbers, and several other formatting features. Includes the following file types: `Doc`, `Docm`, `Docx`, `Dot`, `Dotm`, `Dotx`, `Odt`, `Ott`, `Rtf`, `Txt`. `Md`. Learn more about Word Processing formats [here](https://wiki.fileformat.com/word-processing). |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### AudioFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype.md

#### AudioFileType class

Defines Audio documents Includes the following types: `Mp3`, `Aac`, `Aiff`, `Flac`, `M4a`, `Wma`, `Ac3`, `Ogg`, `Wav`, Learn more about audio formats [here](https://docs.fileformat.com/audio/).

```csharp
public sealed class AudioFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| AudioFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Aac | AAC (Advanced Audio Coding) refers to digital audio coding standard that represent audio files based on lossy audio compression. Learn more about this file format [here](https://docs.fileformat.com/audio/aac/). |
| static readonly Ac3 | A file with a .ac3 extension is an Audio Codec 3 file, introduced by Dolby Laboratories. It is an audio format that can contain up to six channels of audio output. Learn more about this file format [here](https://docs.fileformat.com/audio/ac3/). |
| static readonly Aiff | The AIFF (Audio Interchange File Format) is an uncompressed audio file format developed by Apple in 1998, but is based on EA IFF 85 Learn more about this file format [here](https://docs.fileformat.com/audio/aiff/). |
| static readonly Flac | FLAC(Free Lossless Audio Codec) is a lossless compression audio coding format developed by Xiph.Org Foundation Learn more about this file format [here](https://docs.fileformat.com/audio/flac/). |
| static readonly M4a | The M4A file format is an audio file created by using the AAC (Advanced Audio Coding) which is known as a lossy compression. Learn more about this file format [here](https://docs.fileformat.com/audio/m4a/). |
| static readonly Mp3 | Files with .mp3 extension are digitally encoded file formats for audio files that are formally based on the MPEG-1 Audio Layer III or MPEG-2 Audio Layer III. Learn more about this file format [here](https://docs.fileformat.com/audio/mp3/). |
| static readonly Ogg | OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension. OGG files are used for storing audio data and can include artist and track information and metadata as well. Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/). |
| static readonly Wav | WAV, known for WAVE (Waveform Audio File Format), is a subset of Microsoft’s Resource Interchange File Format (RIFF) specification for storing digital audio files. Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/). |
| static readonly Wma | A file with .wma extension represents an audio file that is saved in the Advanced Systems Format (ASF) format. Learn more about this file format [here](https://docs.fileformat.com/audio/wma/). |

### Aac
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/aac.md

#### AudioFileType.Aac field

AAC (Advanced Audio Coding) refers to digital audio coding standard that represent audio files based on lossy audio compression. Learn more about this file format [here](https://docs.fileformat.com/audio/aac/).

```csharp
public static readonly AudioFileType Aac;
```

### Ac3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/ac3.md

#### AudioFileType.Ac3 field

A file with a .ac3 extension is an Audio Codec 3 file, introduced by Dolby Laboratories. It is an audio format that can contain up to six channels of audio output. Learn more about this file format [here](https://docs.fileformat.com/audio/ac3/).

```csharp
public static readonly AudioFileType Ac3;
```

### Aiff
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/aiff.md

#### AudioFileType.Aiff field

The AIFF (Audio Interchange File Format) is an uncompressed audio file format developed by Apple in 1998, but is based on EA IFF 85 Learn more about this file format [here](https://docs.fileformat.com/audio/aiff/).

```csharp
public static readonly AudioFileType Aiff;
```

### AudioFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/audiofiletype.md

#### AudioFileType constructor

Serialization constructor

```csharp
public AudioFileType()
```

### Flac
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/flac.md

#### AudioFileType.Flac field

FLAC(Free Lossless Audio Codec) is a lossless compression audio coding format developed by Xiph.Org Foundation Learn more about this file format [here](https://docs.fileformat.com/audio/flac/).

```csharp
public static readonly AudioFileType Flac;
```

### M4a
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/m4a.md

#### AudioFileType.M4a field

The M4A file format is an audio file created by using the AAC (Advanced Audio Coding) which is known as a lossy compression. Learn more about this file format [here](https://docs.fileformat.com/audio/m4a/).

```csharp
public static readonly AudioFileType M4a;
```

### Mp3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/mp3.md

#### AudioFileType.Mp3 field

Files with .mp3 extension are digitally encoded file formats for audio files that are formally based on the MPEG-1 Audio Layer III or MPEG-2 Audio Layer III. Learn more about this file format [here](https://docs.fileformat.com/audio/mp3/).

```csharp
public static readonly AudioFileType Mp3;
```

### Ogg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/ogg.md

#### AudioFileType.Ogg field

OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension. OGG files are used for storing audio data and can include artist and track information and metadata as well. Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/).

```csharp
public static readonly AudioFileType Ogg;
```

### Wav
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/wav.md

#### AudioFileType.Wav field

WAV, known for WAVE (Waveform Audio File Format), is a subset of Microsoft’s Resource Interchange File Format (RIFF) specification for storing digital audio files. Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/).

```csharp
public static readonly AudioFileType Wav;
```

### Wma
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/audiofiletype/wma.md

#### AudioFileType.Wma field

A file with .wma extension represents an audio file that is saved in the Advanced Systems Format (ASF) format. Learn more about this file format [here](https://docs.fileformat.com/audio/wma/).

```csharp
public static readonly AudioFileType Wma;
```

### CadFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype.md

#### CadFileType class

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. Includes the following types: `Cf2``Dgn`, `Dwf`, `Dwfx``Dwg`, `Dwt`, `Dxf`, `Ifc`, `Igs`, `Plt`, `Stl`. Learn more about CAD formats [here](https://wiki.fileformat.com/cad).

```csharp
public sealed class CadFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| CadFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Cf2 | Common File Format File. CAD file that contains 3D package designs or other model data; can be processed and cut by a CAD/CAM machine, such as a die cutting device. |
| static readonly Dgn | DGN, Design, files are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. Learn more about this file format [here](https://wiki.fileformat.com/cad/dgn). |
| static readonly Dwf | Design Web Format (DWF) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. It contains graphics and text as part of design data and reduce the size of the file due to its compressed format. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwf). |
| static readonly Dwfx | DWFX file is a 2D or 3D drawing created with Autodesk CAD software. It is saved in the DWFx format, which is similar to a . DWF file, but is formatted using Microsoft's XML Paper Specification (XPS). |
| static readonly Dwg | Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Like DXF, which are ASCII files, DWG represent the binary file format for CAD (Computer Aided Design) drawings. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwg). |
| static readonly Dwt | A DWT file is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwt). |
| static readonly Dxf | DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. Learn more about this file format [here](https://wiki.fileformat.com/cad/dxf). |
| static readonly Ifc | Files with IFC extension refer to Industry Foundation Classes (IFC) file format that establishes international standards to import and export building objects and their properties. This file format provides interoperability between different software applications. Learn more about this file format [here](https://wiki.fileformat.com/cad/ifc). |
| static readonly Igs | Igs document format |
| static readonly Plt | The PLT file format is a vector-based plotter file introduced by Autodesk, Inc. and contains information for a certain CAD file. Plotting details require accuracy and precision in production, and usage of PLT file guarantee this as all images are printed using lines instead of dots. Learn more about this file format [here](https://wiki.fileformat.com/cad/plt). |
| static readonly Stl | STL, abbreviation for stereolithrography, is an interchangeable file format that represents 3-dimensional surface geometry. The file format finds its usage in several fields such as rapid prototyping, 3D printing and computer-aided manufacturing. Learn more about this file format [here](https://wiki.fileformat.com/cad/stl). |

### CadFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/cadfiletype.md

#### CadFileType constructor

Serialization constructor

```csharp
public CadFileType()
```

### Cf2
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/cf2.md

#### CadFileType.Cf2 field

Common File Format File. CAD file that contains 3D package designs or other model data; can be processed and cut by a CAD/CAM machine, such as a die cutting device.

```csharp
public static readonly CadFileType Cf2;
```

### Dgn
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/dgn.md

#### CadFileType.Dgn field

DGN, Design, files are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. Learn more about this file format [here](https://wiki.fileformat.com/cad/dgn).

```csharp
public static readonly CadFileType Dgn;
```

### Dwf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/dwf.md

#### CadFileType.Dwf field

Design Web Format (DWF) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. It contains graphics and text as part of design data and reduce the size of the file due to its compressed format. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwf).

```csharp
public static readonly CadFileType Dwf;
```

### Dwfx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/dwfx.md

#### CadFileType.Dwfx field

DWFX file is a 2D or 3D drawing created with Autodesk CAD software. It is saved in the DWFx format, which is similar to a . DWF file, but is formatted using Microsoft's XML Paper Specification (XPS).

```csharp
public static readonly CadFileType Dwfx;
```

### Dwg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/dwg.md

#### CadFileType.Dwg field

Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Like DXF, which are ASCII files, DWG represent the binary file format for CAD (Computer Aided Design) drawings. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwg).

```csharp
public static readonly CadFileType Dwg;
```

### Dwt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/dwt.md

#### CadFileType.Dwt field

A DWT file is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwt).

```csharp
public static readonly CadFileType Dwt;
```

### Dxf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/dxf.md

#### CadFileType.Dxf field

DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. Learn more about this file format [here](https://wiki.fileformat.com/cad/dxf).

```csharp
public static readonly CadFileType Dxf;
```

### Ifc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/ifc.md

#### CadFileType.Ifc field

Files with IFC extension refer to Industry Foundation Classes (IFC) file format that establishes international standards to import and export building objects and their properties. This file format provides interoperability between different software applications. Learn more about this file format [here](https://wiki.fileformat.com/cad/ifc).

```csharp
public static readonly CadFileType Ifc;
```

### Igs
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/igs.md

#### CadFileType.Igs field

Igs document format

```csharp
public static readonly CadFileType Igs;
```

### Plt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/plt.md

#### CadFileType.Plt field

The PLT file format is a vector-based plotter file introduced by Autodesk, Inc. and contains information for a certain CAD file. Plotting details require accuracy and precision in production, and usage of PLT file guarantee this as all images are printed using lines instead of dots. Learn more about this file format [here](https://wiki.fileformat.com/cad/plt).

```csharp
public static readonly CadFileType Plt;
```

### Stl
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/cadfiletype/stl.md

#### CadFileType.Stl field

STL, abbreviation for stereolithrography, is an interchangeable file format that represents 3-dimensional surface geometry. The file format finds its usage in several fields such as rapid prototyping, 3D printing and computer-aided manufacturing. Learn more about this file format [here](https://wiki.fileformat.com/cad/stl).

```csharp
public static readonly CadFileType Stl;
```

### CompressionFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype.md

#### CompressionFileType class

Defines compression formats. Includes the following file types: `Zip`. `Rar`. `SevenZ`. `Tar`. `Gz`. `Gzip`. `Bz2`. `Lz`. `Z`. `Xz`. `Xz`. `Cpio`. `Cab`. `Lzma`. `Zst`. `Uue`. `Lha`. `Lz4`. Learn more about compression formats [here](https://docs.fileformat.com/compression/).

```csharp
public sealed class CompressionFileType : FileType
```

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |
| IsMultiFileArchive { get; } | Defines if the format supports multiple files/folders in a single archive. |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Bz2 | BZ2 are compressed files generated using the BZIP2 open source compression method, mostly on UNIX or Linux system. It is used for compression of a single file and is not meant for archiving of multiple files. Learn more about this file format [here](https://docs.fileformat.com/compression/bz2/). |
| static readonly Cab | A file with a .cab extension belongs to a windows cabinet file that belongs to the category of system files. It is a file that is saved in the archive file format in the versions of Microsoft Windows that support compressed data algorithms, such as the LZX, Quantum, and ZIP. Learn more about this file format [here](https://docs.fileformat.com/system/cab/). |
| static readonly Cpio | Cpio is a general file archiver utility and its associated file format. It is primarily installed on Unix-like computer operating systems. |
| static readonly Gz | A GZ file is a compressed archive that is created using the standard gzip (GNU zip) compression algorithm. It may contain multiple compressed files, directories and file stubs. Learn more about this file format [here](https://docs.fileformat.com/compression/gz/). |
| static readonly Gzip | A Gzip file is a compressed archive that is created using the standard gzip (GNU zip) compression algorithm. It may contain multiple compressed files, directories and file stubs. Learn more about this file format [here](https://docs.fileformat.com/compression/gz/). |
| static readonly Iso | A file with .iso extension is an uncompressed archive disk image file that represents the contents of entire data on an optical disc such as CD or DVD. Based on the ISO-9660 standard, the ISO image file format contains the disc data along with the filesystem information that is stored in it. Learn more about this file format [here](https://docs.fileformat.com/compression/iso/). |
| static readonly Lha | A file with .lzh and .lha extension usually relates to archive compression file format. This file format is the same as other file compression formats like ZIP, RAR, etc. The main purpose of these file formats is to reduce the size of the format for easily sending as well as to keep them together in compressed form. |
| static readonly Lz | A file with .lz extension is a compressed archive file created with Lzip, which is a free command-line tool for compression. It supports concatenation to compress support files. LZ files have media type application/lzip and support higher compression rations than BZ2. Learn more about this file format [here](https://docs.fileformat.com/compression/bz2/). |
| static readonly Lz4 | A file with .lz4 extension is a compressed archive file created with applications/utilities that support LZ4 compression. The LZ4 algorithm focuses on trade-off between speed and compression ratio. Compressed LZ4 archives can be created using the LZ4 command-line utility and can be decompressed using the same. Learn more about this file format [here](https://docs.fileformat.com/compression/lz4/). |
| static readonly Lzma | A file with .lzma extension is a compressed archive file created using the LZMA (Lempel-Ziv-Markov chain Algorithm) compression method. These are mainly found/used on Unix operating system and are similar to other compression algorithms such as ZIP for minimising file size. Learn more about this file format [here](https://docs.fileformat.com/compression/lzma/). |
| static readonly Rar | Files with .rar extension are archive files that are created for storing information in compressed or normal form. RAR, which stands for Roshal ARchive file format. Learn more about this file format [here](https://docs.fileformat.com/compression/rar/). |
| static readonly SevenZ | 7z is an archiving format for compressing files and folders with a high compression ratio. It is based on Open Source architecture which makes it possible to use any compression and encryption algorithms. Learn more about this file format [here](https://docs.fileformat.com/compression/7z/). |
| static readonly Tar | Files with .tar extension are archives created with Unix-based utility for collecting one or more files. Multiple files are stored in an uncompressed format with the support of adding files as well as folders to the archive. Learn more about this file format [here](https://docs.fileformat.com/compression/tar/). |
| static readonly Uue | A uuencoded archive is a file or collection of files that have been encoded using the Unix-to-Unix encoding scheme (uuencode). This encoding method converts binary data into a text format, which makes it easier to send files over channels that only support text, such as email. |
| static readonly Xz | XZ is a compressed file format that utilizes the LZMA2 compression algorithm. It was designed as a replacement for the popular gzip and bzip2 formats, and offers a number of advantages over these older standards. Learn more about this file format [here](https://docs.fileformat.com/compression/xz/). |
| static readonly Z | A Z file is a category of files belonging to the UNIX Compressed data files. Compressed Unix files are the most popular and widely used extension type of the Z file. Learn more about this file format [here](https://docs.fileformat.com/compression/z/). |
| static readonly Zip | A file with .zip extension is an archive that can hold one or more files or directories. The archive can have compression applied to the included files in order to reduce the ZIP file size. Learn more about this file format [here](https://docs.fileformat.com/compression/zip/). |
| static readonly Zst | A ZST file is a compressed file that is generated with the Zstandard (zstd) compression algorithm. It is a compressed file that is created with lossless compression by the algorithm. Learn more about this file format [here](https://docs.fileformat.com/compression/zst/). |

### Bz2
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/bz2.md

#### CompressionFileType.Bz2 field

BZ2 are compressed files generated using the BZIP2 open source compression method, mostly on UNIX or Linux system. It is used for compression of a single file and is not meant for archiving of multiple files. Learn more about this file format [here](https://docs.fileformat.com/compression/bz2/).

```csharp
public static readonly CompressionFileType Bz2;
```

### Cab
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/cab.md

#### CompressionFileType.Cab field

A file with a .cab extension belongs to a windows cabinet file that belongs to the category of system files. It is a file that is saved in the archive file format in the versions of Microsoft Windows that support compressed data algorithms, such as the LZX, Quantum, and ZIP. Learn more about this file format [here](https://docs.fileformat.com/system/cab/).

```csharp
public static readonly CompressionFileType Cab;
```

### Cpio
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/cpio.md

#### CompressionFileType.Cpio field

Cpio is a general file archiver utility and its associated file format. It is primarily installed on Unix-like computer operating systems.

```csharp
public static readonly CompressionFileType Cpio;
```

### Gz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/gz.md

#### CompressionFileType.Gz field

A GZ file is a compressed archive that is created using the standard gzip (GNU zip) compression algorithm. It may contain multiple compressed files, directories and file stubs. Learn more about this file format [here](https://docs.fileformat.com/compression/gz/).

```csharp
public static readonly CompressionFileType Gz;
```

### Gzip
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/gzip.md

#### CompressionFileType.Gzip field

A Gzip file is a compressed archive that is created using the standard gzip (GNU zip) compression algorithm. It may contain multiple compressed files, directories and file stubs. Learn more about this file format [here](https://docs.fileformat.com/compression/gz/).

```csharp
public static readonly CompressionFileType Gzip;
```

### IsMultiFileArchive
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/ismultifilearchive.md

#### CompressionFileType.IsMultiFileArchive property

Defines if the format supports multiple files/folders in a single archive.

```csharp
public bool IsMultiFileArchive { get; }
```

### Iso
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/iso.md

#### CompressionFileType.Iso field

A file with .iso extension is an uncompressed archive disk image file that represents the contents of entire data on an optical disc such as CD or DVD. Based on the ISO-9660 standard, the ISO image file format contains the disc data along with the filesystem information that is stored in it. Learn more about this file format [here](https://docs.fileformat.com/compression/iso/).

```csharp
public static readonly CompressionFileType Iso;
```

### Lha
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/lha.md

#### CompressionFileType.Lha field

A file with .lzh and .lha extension usually relates to archive compression file format. This file format is the same as other file compression formats like ZIP, RAR, etc. The main purpose of these file formats is to reduce the size of the format for easily sending as well as to keep them together in compressed form.

```csharp
public static readonly CompressionFileType Lha;
```

### Lz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/lz.md

#### CompressionFileType.Lz field

A file with .lz extension is a compressed archive file created with Lzip, which is a free command-line tool for compression. It supports concatenation to compress support files. LZ files have media type application/lzip and support higher compression rations than BZ2. Learn more about this file format [here](https://docs.fileformat.com/compression/bz2/).

```csharp
public static readonly CompressionFileType Lz;
```

### Lz4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/lz4.md

#### CompressionFileType.Lz4 field

A file with .lz4 extension is a compressed archive file created with applications/utilities that support LZ4 compression. The LZ4 algorithm focuses on trade-off between speed and compression ratio. Compressed LZ4 archives can be created using the LZ4 command-line utility and can be decompressed using the same. Learn more about this file format [here](https://docs.fileformat.com/compression/lz4/).

```csharp
public static readonly CompressionFileType Lz4;
```

### Lzma
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/lzma.md

#### CompressionFileType.Lzma field

A file with .lzma extension is a compressed archive file created using the LZMA (Lempel-Ziv-Markov chain Algorithm) compression method. These are mainly found/used on Unix operating system and are similar to other compression algorithms such as ZIP for minimising file size. Learn more about this file format [here](https://docs.fileformat.com/compression/lzma/).

```csharp
public static readonly CompressionFileType Lzma;
```

### Rar
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/rar.md

#### CompressionFileType.Rar field

Files with .rar extension are archive files that are created for storing information in compressed or normal form. RAR, which stands for Roshal ARchive file format. Learn more about this file format [here](https://docs.fileformat.com/compression/rar/).

```csharp
public static readonly CompressionFileType Rar;
```

### SevenZ
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/sevenz.md

#### CompressionFileType.SevenZ field

7z is an archiving format for compressing files and folders with a high compression ratio. It is based on Open Source architecture which makes it possible to use any compression and encryption algorithms. Learn more about this file format [here](https://docs.fileformat.com/compression/7z/).

```csharp
public static readonly CompressionFileType SevenZ;
```

### Tar
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/tar.md

#### CompressionFileType.Tar field

Files with .tar extension are archives created with Unix-based utility for collecting one or more files. Multiple files are stored in an uncompressed format with the support of adding files as well as folders to the archive. Learn more about this file format [here](https://docs.fileformat.com/compression/tar/).

```csharp
public static readonly CompressionFileType Tar;
```

### Uue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/uue.md

#### CompressionFileType.Uue field

A uuencoded archive is a file or collection of files that have been encoded using the Unix-to-Unix encoding scheme (uuencode). This encoding method converts binary data into a text format, which makes it easier to send files over channels that only support text, such as email.

```csharp
public static readonly CompressionFileType Uue;
```

### Xz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/xz.md

#### CompressionFileType.Xz field

XZ is a compressed file format that utilizes the LZMA2 compression algorithm. It was designed as a replacement for the popular gzip and bzip2 formats, and offers a number of advantages over these older standards. Learn more about this file format [here](https://docs.fileformat.com/compression/xz/).

```csharp
public static readonly CompressionFileType Xz;
```

### Z
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/z.md

#### CompressionFileType.Z field

A Z file is a category of files belonging to the UNIX Compressed data files. Compressed Unix files are the most popular and widely used extension type of the Z file. Learn more about this file format [here](https://docs.fileformat.com/compression/z/).

```csharp
public static readonly CompressionFileType Z;
```

### Zip
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/zip.md

#### CompressionFileType.Zip field

A file with .zip extension is an archive that can hold one or more files or directories. The archive can have compression applied to the included files in order to reduce the ZIP file size. Learn more about this file format [here](https://docs.fileformat.com/compression/zip/).

```csharp
public static readonly CompressionFileType Zip;
```

### Zst
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/compressionfiletype/zst.md

#### CompressionFileType.Zst field

A ZST file is a compressed file that is generated with the Zstandard (zstd) compression algorithm. It is a compressed file that is created with lossless compression by the algorithm. Learn more about this file format [here](https://docs.fileformat.com/compression/zst/).

```csharp
public static readonly CompressionFileType Zst;
```

### DatabaseFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/databasefiletype.md

#### DatabaseFileType class

Defines database documents. Includes the following file types: `Nsf``Log``Sql`

```csharp
public sealed class DatabaseFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| DatabaseFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Log | A file with .log extension contains the list of plain text with timestamp. Usually, certain activity detail is logged by the softwares or operating systems to help the developers or users to track what was happening at a certain time period. Learn more about this file format [here](https://docs.fileformat.com/database/log). |
| static readonly Nsf | A file with .nsf (Notes Storage Facility) extension is a database file format used by the IBM Notes software, which was previously known as Lotus Notes. It defines the schema to store different kind of objects such like emails, appointments, documents, forms and views. Learn more about this file format [here](https://docs.fileformat.com/database/nsf). |
| static readonly Sql | A file with .sql extension is a Structured Query Language (SQL) file that contains code to work with relational databases. It is used to write SQL statements for CRUD (Create, Read, Update, and Delete) operations on databases. Learn more about this file format [here](https://docs.fileformat.com/database/sql). |

### DatabaseFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/databasefiletype/databasefiletype.md

#### DatabaseFileType constructor

Serialization constructor

```csharp
public DatabaseFileType()
```

### Log
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/databasefiletype/log.md

#### DatabaseFileType.Log field

A file with .log extension contains the list of plain text with timestamp. Usually, certain activity detail is logged by the softwares or operating systems to help the developers or users to track what was happening at a certain time period. Learn more about this file format [here](https://docs.fileformat.com/database/log).

```csharp
public static readonly DatabaseFileType Log;
```

### Nsf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/databasefiletype/nsf.md

#### DatabaseFileType.Nsf field

A file with .nsf (Notes Storage Facility) extension is a database file format used by the IBM Notes software, which was previously known as Lotus Notes. It defines the schema to store different kind of objects such like emails, appointments, documents, forms and views. Learn more about this file format [here](https://docs.fileformat.com/database/nsf).

```csharp
public static readonly DatabaseFileType Nsf;
```

### Sql
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/databasefiletype/sql.md

#### DatabaseFileType.Sql field

A file with .sql extension is a Structured Query Language (SQL) file that contains code to work with relational databases. It is used to write SQL statements for CRUD (Create, Read, Update, and Delete) operations on databases. Learn more about this file format [here](https://docs.fileformat.com/database/sql).

```csharp
public static readonly DatabaseFileType Sql;
```

### DiagramFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype.md

#### DiagramFileType class

Defines Diagram documents. Includes the following types: `Vdw`, `Vdx`, `Vsd`, `Vsdm`, `Vsdx`, `Vss`, `Vssm`, `Vssx`, `Vst`, `Vstm`, `Vstx`, `Vsx`, `Vtx`.

```csharp
public sealed class DiagramFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Vdw | VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing. Learn more about this file format [here](https://wiki.fileformat.com/web/vdw). |
| static readonly Vdx | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. A Visio drawing XML file is created in Visio software, which is developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/image/vdx). |
| static readonly Vsd | VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Learn more about this file format [here](https://wiki.fileformat.com/image/vsd). |
| static readonly Vsdm | Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened. Learn more about this file format [here](https://wiki.fileformat.com/image/vsdm). |
| static readonly Vsdx | Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It was developed to replace the binary file format, .VSD, which is supported by earlier versions of Microsoft Visio. Learn more about this file format [here](https://wiki.fileformat.com/image/vsdx). |
| static readonly Vss | VSS are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format [here](https://wiki.fileformat.com/image/vss). |
| static readonly Vssm | Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. A VSSM file when opened allows to run the macros to achieve desired formatting and placement of shapes in a diagram. Learn more about this file format [here](https://wiki.fileformat.com/image/vssm). |
| static readonly Vssx | Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representation of a variety of drawing elements such as collection of shapes, connectors, flowcharts, network layout, UML diagrams, Learn more about this file format [here](https://wiki.fileformat.com/image/vssx). |
| static readonly Vst | Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. These template files are in binary file format and contain the default layout and settings that are utilized for creation of new Visio drawings. Learn more about this file format [here](https://wiki.fileformat.com/image/vst). |
| static readonly Vstm | Files with VSTM extension are template files created with Microsoft Visio that support macros. Unlike VSDX files, files created from VSTM templates can run macros that are developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here](https://wiki.fileformat.com/image/vstm). |
| static readonly Vstx | Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide starting point for creating Visio drawings, saved as .VSDX files, with default layout and settings. Learn more about this file format [here](https://wiki.fileformat.com/image/vstx). |
| static readonly Vsx | Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and was supported till Visio 2013. Learn more about this file format [here](https://wiki.fileformat.com/image/vsx). |
| static readonly Vtx | A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. The template is aimed to provide a file with basic settings that can be used to create multiple Visio files of the same settings. Learn more about this file format [here](https://wiki.fileformat.com/image/vtx). |

### DiagramFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/diagramfiletype.md

#### DiagramFileType constructor

Serialization constructor

```csharp
public DiagramFileType()
```

### Vdw
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vdw.md

#### DiagramFileType.Vdw field

VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing. Learn more about this file format [here](https://wiki.fileformat.com/web/vdw).

```csharp
public static readonly DiagramFileType Vdw;
```

### Vdx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vdx.md

#### DiagramFileType.Vdx field

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. A Visio drawing XML file is created in Visio software, which is developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/image/vdx).

```csharp
public static readonly DiagramFileType Vdx;
```

### Vsd
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vsd.md

#### DiagramFileType.Vsd field

VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Learn more about this file format [here](https://wiki.fileformat.com/image/vsd).

```csharp
public static readonly DiagramFileType Vsd;
```

### Vsdm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vsdm.md

#### DiagramFileType.Vsdm field

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened. Learn more about this file format [here](https://wiki.fileformat.com/image/vsdm).

```csharp
public static readonly DiagramFileType Vsdm;
```

### Vsdx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vsdx.md

#### DiagramFileType.Vsdx field

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It was developed to replace the binary file format, .VSD, which is supported by earlier versions of Microsoft Visio. Learn more about this file format [here](https://wiki.fileformat.com/image/vsdx).

```csharp
public static readonly DiagramFileType Vsdx;
```

### Vss
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vss.md

#### DiagramFileType.Vss field

VSS are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format [here](https://wiki.fileformat.com/image/vss).

```csharp
public static readonly DiagramFileType Vss;
```

### Vssm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vssm.md

#### DiagramFileType.Vssm field

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. A VSSM file when opened allows to run the macros to achieve desired formatting and placement of shapes in a diagram. Learn more about this file format [here](https://wiki.fileformat.com/image/vssm).

```csharp
public static readonly DiagramFileType Vssm;
```

### Vssx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vssx.md

#### DiagramFileType.Vssx field

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representation of a variety of drawing elements such as collection of shapes, connectors, flowcharts, network layout, UML diagrams, Learn more about this file format [here](https://wiki.fileformat.com/image/vssx).

```csharp
public static readonly DiagramFileType Vssx;
```

### Vst
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vst.md

#### DiagramFileType.Vst field

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. These template files are in binary file format and contain the default layout and settings that are utilized for creation of new Visio drawings. Learn more about this file format [here](https://wiki.fileformat.com/image/vst).

```csharp
public static readonly DiagramFileType Vst;
```

### Vstm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vstm.md

#### DiagramFileType.Vstm field

Files with VSTM extension are template files created with Microsoft Visio that support macros. Unlike VSDX files, files created from VSTM templates can run macros that are developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here](https://wiki.fileformat.com/image/vstm).

```csharp
public static readonly DiagramFileType Vstm;
```

### Vstx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vstx.md

#### DiagramFileType.Vstx field

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide starting point for creating Visio drawings, saved as .VSDX files, with default layout and settings. Learn more about this file format [here](https://wiki.fileformat.com/image/vstx).

```csharp
public static readonly DiagramFileType Vstx;
```

### Vsx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vsx.md

#### DiagramFileType.Vsx field

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and was supported till Visio 2013. Learn more about this file format [here](https://wiki.fileformat.com/image/vsx).

```csharp
public static readonly DiagramFileType Vsx;
```

### Vtx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/diagramfiletype/vtx.md

#### DiagramFileType.Vtx field

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. The template is aimed to provide a file with basic settings that can be used to create multiple Visio files of the same settings. Learn more about this file format [here](https://wiki.fileformat.com/image/vtx).

```csharp
public static readonly DiagramFileType Vtx;
```

### EBookFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/ebookfiletype.md

#### EBookFileType class

Defines EBook documents. Includes the following file types: `Epub``Mobi``Azw3`

```csharp
public sealed class EBookFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| EBookFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Azw3 | AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. The format is an enhancement to older AZW files and is used on Kindle Fire devices only with backward compatibility for the ancestor file format i.e. MOBI and AZW. Learn more about this file format [here](https://docs.fileformat.com/ebook/azw3/). |
| static readonly Epub | EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. The format has been so common by now that it is supported by many e-readers and software applications. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub). |
| static readonly Mobi | The MOBI file format is one of the most widely used ebook file format. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as proprietary format for Mobipocket Reader. Learn more about this file format [here](https://wiki.fileformat.com/ebook/mobi). |

### Azw3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/ebookfiletype/azw3.md

#### EBookFileType.Azw3 field

AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. The format is an enhancement to older AZW files and is used on Kindle Fire devices only with backward compatibility for the ancestor file format i.e. MOBI and AZW. Learn more about this file format [here](https://docs.fileformat.com/ebook/azw3/).

```csharp
public static readonly EBookFileType Azw3;
```

### EBookFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/ebookfiletype/ebookfiletype.md

#### EBookFileType constructor

Serialization constructor

```csharp
public EBookFileType()
```

### Epub
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/ebookfiletype/epub.md

#### EBookFileType.Epub field

EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. The format has been so common by now that it is supported by many e-readers and software applications. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub).

```csharp
public static readonly EBookFileType Epub;
```

### Mobi
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/ebookfiletype/mobi.md

#### EBookFileType.Mobi field

The MOBI file format is one of the most widely used ebook file format. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as proprietary format for Mobipocket Reader. Learn more about this file format [here](https://wiki.fileformat.com/ebook/mobi).

```csharp
public static readonly EBookFileType Mobi;
```

### EmailFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype.md

#### EmailFileType class

Defines Email file formats that are used by email applications to store their various data including email messages, attachments, folders, address books etc. Includes the following file types: `Eml`, `Emlx`, `Msg`, `Vcf`. `Mbox`. `Pst`. `Ost`. `Olm`. Learn more about Email formats [here](https://wiki.fileformat.com/email).

```csharp
public sealed class EmailFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Eml | EML file format represents email messages saved using Outlook and other relevant applications. Almost all emailing clients support this file format for its compliance with RFC-822 Internet Message Format Standard. Learn more about this file format [here](https://wiki.fileformat.com/email/eml). |
| static readonly Emlx | The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails. Learn more about this file format [here](https://wiki.fileformat.com/email/emlx). |
| static readonly Ics | ICS (iCalendar) file format is used to represent and exchange calendaring and scheduling information such as events, to-dos, and free/busy data. Learn more about this file format [here](https://wiki.fileformat.com/email/ics). |
| static readonly Mbox | MBox file format is a generic term that represents a container for collection of electronic mail messages. The messages are stored inside the container along with their attachments. Learn more about this file format [here](https://docs.fileformat.com/email/mbox/). |
| static readonly Msg | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Learn more about this file format [here](https://wiki.fileformat.com/email/msg). |
| static readonly Olm | A file with .olm extension is a Microsoft Outlook file for Mac Operating System. An OLM file stores email messages, journals, calendar data, and other types of application data. These are similar to PST files used by Outlook on Windows Operating System. However, OLM files created by Outlook for Mac can’t be opened in Outlook for Windows. Learn more about this file format [here](https://wiki.fileformat.com/email/olm). |
| static readonly Ost | OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here](https://wiki.fileformat.com/email/ost). |
| static readonly Pst | Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. Learn more about this file format [here](https://wiki.fileformat.com/email/pst). |
| static readonly Vcf | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications. Learn more about this file format [here](https://wiki.fileformat.com/email/vcf). |

### EmailFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/emailfiletype.md

#### EmailFileType constructor

Serialization constructor

```csharp
public EmailFileType()
```

### Eml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/eml.md

#### EmailFileType.Eml field

EML file format represents email messages saved using Outlook and other relevant applications. Almost all emailing clients support this file format for its compliance with RFC-822 Internet Message Format Standard. Learn more about this file format [here](https://wiki.fileformat.com/email/eml).

```csharp
public static readonly EmailFileType Eml;
```

### Emlx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/emlx.md

#### EmailFileType.Emlx field

The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails. Learn more about this file format [here](https://wiki.fileformat.com/email/emlx).

```csharp
public static readonly EmailFileType Emlx;
```

### Ics
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/ics.md

#### EmailFileType.Ics field

ICS (iCalendar) file format is used to represent and exchange calendaring and scheduling information such as events, to-dos, and free/busy data. Learn more about this file format [here](https://wiki.fileformat.com/email/ics).

```csharp
public static readonly EmailFileType Ics;
```

### Mbox
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/mbox.md

#### EmailFileType.Mbox field

MBox file format is a generic term that represents a container for collection of electronic mail messages. The messages are stored inside the container along with their attachments. Learn more about this file format [here](https://docs.fileformat.com/email/mbox/).

```csharp
public static readonly EmailFileType Mbox;
```

### Msg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/msg.md

#### EmailFileType.Msg field

MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Learn more about this file format [here](https://wiki.fileformat.com/email/msg).

```csharp
public static readonly EmailFileType Msg;
```

### Olm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/olm.md

#### EmailFileType.Olm field

A file with .olm extension is a Microsoft Outlook file for Mac Operating System. An OLM file stores email messages, journals, calendar data, and other types of application data. These are similar to PST files used by Outlook on Windows Operating System. However, OLM files created by Outlook for Mac can’t be opened in Outlook for Windows. Learn more about this file format [here](https://wiki.fileformat.com/email/olm).

```csharp
public static readonly EmailFileType Olm;
```

### Ost
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/ost.md

#### EmailFileType.Ost field

OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here](https://wiki.fileformat.com/email/ost).

```csharp
public static readonly EmailFileType Ost;
```

### Pst
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/pst.md

#### EmailFileType.Pst field

Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. Learn more about this file format [here](https://wiki.fileformat.com/email/pst).

```csharp
public static readonly EmailFileType Pst;
```

### Vcf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/emailfiletype/vcf.md

#### EmailFileType.Vcf field

VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications. Learn more about this file format [here](https://wiki.fileformat.com/email/vcf).

```csharp
public static readonly EmailFileType Vcf;
```

### FileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype.md

#### FileType class

File type base class

```csharp
public class FileType : Enumeration
```

#### Constructors

| Name | Description |
| --- | --- |
| FileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Gets FileType for provided fileExtension |
| static FromFilename(string) | Returns FileType for specified fileName |
| static FromStream(Stream) | Returns FileType for provided document stream |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |
| static GetAll&lt;T&gt;() | Returns all enumeration values. |
| implicit operator | Implicit conversion to string |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Unknown | Unknown file type |

### Description
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/description.md

#### FileType.Description property

File type description

```csharp
public string Description { get; }
```

##### Return Value

Description of the file type

### Equals
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/equals.md

#### FileType.Equals method

Implements `Equals`

```csharp
public override bool Equals(Enumeration other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Enumeration | The object with which to compare |

### Extension
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/extension.md

#### FileType.Extension property

The file extension

```csharp
public string Extension { get; }
```

### Family
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/family.md

#### FileType.Family property

The file family

```csharp
public string Family { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/fileformat.md

#### FileType.FileFormat property

The file format

```csharp
public string FileFormat { get; }
```

### FileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/filetype.md

#### FileType constructor

Serialization constructor

```csharp
public FileType()
```

### FromExtension
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/fromextension.md

#### FileType.FromExtension method

Gets FileType for provided fileExtension

```csharp
public static FileType FromExtension(string fileExtension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | String | File extension |

##### Return Value

File type

### FromFilename
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/fromfilename.md

#### FileType.FromFilename method

Returns FileType for specified fileName

```csharp
public static FileType FromFilename(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | The file name |

##### Return Value

The file type of specified file name

### FromStream
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/fromstream.md

#### FileType.FromStream method

Returns FileType for provided document stream

```csharp
public static FileType FromStream(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | Stream which will be probed |

##### Return Value

The file type of provided stream

### GetAll
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/getall.md

#### FileType.GetAll&lt;T&gt; method

Returns all enumeration values.

```csharp
public static IEnumerable<FileType> GetAll<T>()
    where T : FileType
```

| Parameter | Description |
| --- | --- |
| T | Enumerated object type. |

##### Return Value

Enumerable of file types

### op_Implicit
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/op_implicit.md

#### FileType Implicit operator

Implicit conversion to string

```csharp
public static implicit operator string(FileType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| type | FileType | File type |

### ToString
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/tostring.md

#### FileType.ToString method

String representation

```csharp
public override string ToString()
```

##### Return Value

String representation of file type

### Unknown
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/filetype/unknown.md

#### FileType.Unknown field

Unknown file type

```csharp
public static readonly FileType Unknown;
```

### FinanceFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/financefiletype.md

#### FinanceFileType class

Defines Finance documents Includes the following types: `Xbrl``IXbrl``Ofx` Learn more about Finance formats [here](https://docs.fileformat.com/finance/).

```csharp
public sealed class FinanceFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| FinanceFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly IXbrl | Inside the iXBRL, contents of XBRL are wrapped in xHTML file format that uses XML tags. Like XBRL, is the root element of iXBRL files. The XHTML format represents its contents as collection of different document types and modules. All the files in XHTML are based on XML file format and conform to the XML document standards. Learn more about this file format [here](https://docs.fileformat.com/finance/ixbrl/). |
| static readonly Ofx | Open Financial Exchange (OFX) is a data-stream format for exchanging financial information that evolved from Microsoft's Open Financial Connectivity (OFC) and Intuit's Open Exchange file formats. Learn more about this file format [here](https://en.wikipedia.org/wiki/Open_Financial_Exchange). |
| static readonly Xbrl | XBRL is an open international standard for digital business reporting that is widely used globally. It is an XML based language that uses XBRL elements, known as tags, to describe each item of business data to formulate data for report sorting and analysis. Learn more about this file format [here](https://docs.fileformat.com/finance/xbrl/). |

### FinanceFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/financefiletype/financefiletype.md

#### FinanceFileType constructor

Serialization constructor

```csharp
public FinanceFileType()
```

### IXbrl
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/financefiletype/ixbrl.md

#### FinanceFileType.IXbrl field

Inside the iXBRL, contents of XBRL are wrapped in xHTML file format that uses XML tags. Like XBRL, is the root element of iXBRL files. The XHTML format represents its contents as collection of different document types and modules. All the files in XHTML are based on XML file format and conform to the XML document standards. Learn more about this file format [here](https://docs.fileformat.com/finance/ixbrl/).

```csharp
public static readonly FinanceFileType IXbrl;
```

### Ofx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/financefiletype/ofx.md

#### FinanceFileType.Ofx field

Open Financial Exchange (OFX) is a data-stream format for exchanging financial information that evolved from Microsoft's Open Financial Connectivity (OFC) and Intuit's Open Exchange file formats. Learn more about this file format [here](https://en.wikipedia.org/wiki/Open_Financial_Exchange).

```csharp
public static readonly FinanceFileType Ofx;
```

### Xbrl
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/financefiletype/xbrl.md

#### FinanceFileType.Xbrl field

XBRL is an open international standard for digital business reporting that is widely used globally. It is an XML based language that uses XBRL elements, known as tags, to describe each item of business data to formulate data for report sorting and analysis. Learn more about this file format [here](https://docs.fileformat.com/finance/xbrl/).

```csharp
public static readonly FinanceFileType Xbrl;
```

### FontFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype.md

#### FontFileType class

Defines Font documents Includes the following types: `Ttf``Eot``Otf``Cff``Type1``Woff``Woff2` Learn more about Font formats [here](https://docs.fileformat.com/font/).

```csharp
public sealed class FontFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| FontFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Cff | A file with .cff extension is a Compact Font Format and is also known as a PostScript Type 1, or CIDFont. CFF acts as a container to store multiple fonts together in a single unit known as a FontSet. Learn more about this file format [here](https://docs.fileformat.com/font/cff/). |
| static readonly Eot | A file with .eot extension is an OpenType font that is embedded in a document. These are mostly used in web files such as a Web page. It was created by Microsoft and is supported by Microsoft Products including PowerPoint presentation .pps file. Learn more about this file format [here](https://docs.fileformat.com/font/eot/). |
| static readonly Otf | A file with .otf extension refers to OpenType font format. OTF font format is more scalable and extends the existing features of TTF formats for digital typography. Developed by Microsoft and Adobe, OTF combines the features of PostScript and TrueType font formats. Learn more about this file format [here](https://docs.fileformat.com/font/otf/). |
| static readonly Ttf | A file with .ttf extension represents font files based on the TrueType specifications font technology. It was initially designed and launched by Apple Computer, Inc for Mac OS and was later adopted by Microsoft for Windows OS. Learn more about this file format [here](https://docs.fileformat.com/font/ttf/). |
| static readonly Type1 | Type 1 fonts is a deprecated Adobe technology which was widely used in the desktop based publishing software and printers that could use PostScript. Although Type 1 fonts are not supported in many modern platforms, web browsers and mobile operating systems, but these are still supported in some of the operating systems. Learn more about this file format [here](https://docs.fileformat.com/font/type1/). |
| static readonly Woff | A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format [here](https://docs.fileformat.com/font/woff/). |
| static readonly Woff2 | A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format [here](https://docs.fileformat.com/font/woff/). |

### Cff
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/cff.md

#### FontFileType.Cff field

A file with .cff extension is a Compact Font Format and is also known as a PostScript Type 1, or CIDFont. CFF acts as a container to store multiple fonts together in a single unit known as a FontSet. Learn more about this file format [here](https://docs.fileformat.com/font/cff/).

```csharp
public static readonly FontFileType Cff;
```

### Eot
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/eot.md

#### FontFileType.Eot field

A file with .eot extension is an OpenType font that is embedded in a document. These are mostly used in web files such as a Web page. It was created by Microsoft and is supported by Microsoft Products including PowerPoint presentation .pps file. Learn more about this file format [here](https://docs.fileformat.com/font/eot/).

```csharp
public static readonly FontFileType Eot;
```

### FontFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/fontfiletype.md

#### FontFileType constructor

Serialization constructor

```csharp
public FontFileType()
```

### Otf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/otf.md

#### FontFileType.Otf field

A file with .otf extension refers to OpenType font format. OTF font format is more scalable and extends the existing features of TTF formats for digital typography. Developed by Microsoft and Adobe, OTF combines the features of PostScript and TrueType font formats. Learn more about this file format [here](https://docs.fileformat.com/font/otf/).

```csharp
public static readonly FontFileType Otf;
```

### Ttf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/ttf.md

#### FontFileType.Ttf field

A file with .ttf extension represents font files based on the TrueType specifications font technology. It was initially designed and launched by Apple Computer, Inc for Mac OS and was later adopted by Microsoft for Windows OS. Learn more about this file format [here](https://docs.fileformat.com/font/ttf/).

```csharp
public static readonly FontFileType Ttf;
```

### Type1
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/type1.md

#### FontFileType.Type1 field

Type 1 fonts is a deprecated Adobe technology which was widely used in the desktop based publishing software and printers that could use PostScript. Although Type 1 fonts are not supported in many modern platforms, web browsers and mobile operating systems, but these are still supported in some of the operating systems. Learn more about this file format [here](https://docs.fileformat.com/font/type1/).

```csharp
public static readonly FontFileType Type1;
```

### Woff
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/woff.md

#### FontFileType.Woff field

A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format [here](https://docs.fileformat.com/font/woff/).

```csharp
public static readonly FontFileType Woff;
```

### Woff2
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/fontfiletype/woff2.md

#### FontFileType.Woff2 field

A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format [here](https://docs.fileformat.com/font/woff/).

```csharp
public static readonly FontFileType Woff2;
```

### GisFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype.md

#### GisFileType class

Defines GIS documents. Includes the following file types: `Shp`. `GeoJson`. `Gdb`. `Gml`. `Kml`. `Gpx`. `TopoJson`. `Osm`.

```csharp
public sealed class GisFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| GisFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Gdb | ESRI file Geodatabase (FileGDB) is a collection of files in a folder on disc that hold related geospatial data such as feature datasets, feature classes and associated tables. It requires certain other files to be kept alongside the .gdb file in the same directory for it to work. Learn more about this file format [here](https://docs.fileformat.com/database/gdb/). |
| static readonly GeoJson | GeoJSON is a JSON based format designed to represent the geographical features with their non-spatial attributes. This format defines different JSON (JavaScript Object Notation) objects and their joining fashion. JSON format represents a collective information about the Geographical features, their spatial extents, and properties. Learn more about this file format [here](https://docs.fileformat.com/gis/geojson/). |
| static readonly Gml | GML stands for Geography Markup Language that is based on XML specifications developed by the Open Geospatial Consortium (OGC). The format is used to store geographic data features for interchange among different file formats. It serves as a modeling language for geographic systems as well as an open interchange format for geographic transactions on the internet. Learn more about this file format [here](https://docs.fileformat.com/gis/gml/). |
| static readonly Gpx | Files with GPX extension represent GPS Exchange format for interchange of GPS data between applications and web services on the internet. It is a light-weight XML file format that contains GPS data i.e. waypoints, routes and tracks to be imported and red by multiple programs. Learn more about this file format [here](https://docs.fileformat.com/gis/gpx/). |
| static readonly Kml | KML (Keyhole Markup Language) contains geospatial information in XML notation. Files saved as KML can be opened in Geographic Information System (GIS) applications provided they support it. Many applications have started providing support for KML file format after it has been adopted as international standard. KML uses a tag-based structure with nested elements and attributes. Learn more about this file format [here](https://docs.fileformat.com/gis/kml/). |
| static readonly Osm | The OSM file format is a structured data format used to store geographical data in the OpenStreetMap project. OSM files are typically in XML format and contain information such as the location of roads, buildings, points of interest, and other features on the map. Learn more about this file format [here](https://docs.fileformat.com/gis/osm/). |
| static readonly Shp | SHP is the file extension for one of the primary file types used for representation of ESRI Shapefile. It represents Geospatial information in the form of vector data to be used by Geographic Information Systems (GIS) applications. Learn more about this file format [here](https://docs.fileformat.com/gis/shp/). |
| static readonly TopoJson | TopoJSON is an extension of GeoJSON that encodes topology. Rather than representing geometries discretely, geometries in TopoJSON files are stitched together from shared line segments called arcs. |

### Gdb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/gdb.md

#### GisFileType.Gdb field

ESRI file Geodatabase (FileGDB) is a collection of files in a folder on disc that hold related geospatial data such as feature datasets, feature classes and associated tables. It requires certain other files to be kept alongside the .gdb file in the same directory for it to work. Learn more about this file format [here](https://docs.fileformat.com/database/gdb/).

```csharp
public static readonly GisFileType Gdb;
```

### GeoJson
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/geojson.md

#### GisFileType.GeoJson field

GeoJSON is a JSON based format designed to represent the geographical features with their non-spatial attributes. This format defines different JSON (JavaScript Object Notation) objects and their joining fashion. JSON format represents a collective information about the Geographical features, their spatial extents, and properties. Learn more about this file format [here](https://docs.fileformat.com/gis/geojson/).

```csharp
public static readonly GisFileType GeoJson;
```

### GisFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/gisfiletype.md

#### GisFileType constructor

Serialization constructor

```csharp
public GisFileType()
```

### Gml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/gml.md

#### GisFileType.Gml field

GML stands for Geography Markup Language that is based on XML specifications developed by the Open Geospatial Consortium (OGC). The format is used to store geographic data features for interchange among different file formats. It serves as a modeling language for geographic systems as well as an open interchange format for geographic transactions on the internet. Learn more about this file format [here](https://docs.fileformat.com/gis/gml/).

```csharp
public static readonly GisFileType Gml;
```

### Gpx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/gpx.md

#### GisFileType.Gpx field

Files with GPX extension represent GPS Exchange format for interchange of GPS data between applications and web services on the internet. It is a light-weight XML file format that contains GPS data i.e. waypoints, routes and tracks to be imported and red by multiple programs. Learn more about this file format [here](https://docs.fileformat.com/gis/gpx/).

```csharp
public static readonly GisFileType Gpx;
```

### Kml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/kml.md

#### GisFileType.Kml field

KML (Keyhole Markup Language) contains geospatial information in XML notation. Files saved as KML can be opened in Geographic Information System (GIS) applications provided they support it. Many applications have started providing support for KML file format after it has been adopted as international standard. KML uses a tag-based structure with nested elements and attributes. Learn more about this file format [here](https://docs.fileformat.com/gis/kml/).

```csharp
public static readonly GisFileType Kml;
```

### Osm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/osm.md

#### GisFileType.Osm field

The OSM file format is a structured data format used to store geographical data in the OpenStreetMap project. OSM files are typically in XML format and contain information such as the location of roads, buildings, points of interest, and other features on the map. Learn more about this file format [here](https://docs.fileformat.com/gis/osm/).

```csharp
public static readonly GisFileType Osm;
```

### Shp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/shp.md

#### GisFileType.Shp field

SHP is the file extension for one of the primary file types used for representation of ESRI Shapefile. It represents Geospatial information in the form of vector data to be used by Geographic Information Systems (GIS) applications. Learn more about this file format [here](https://docs.fileformat.com/gis/shp/).

```csharp
public static readonly GisFileType Shp;
```

### TopoJson
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/gisfiletype/topojson.md

#### GisFileType.TopoJson field

TopoJSON is an extension of GeoJSON that encodes topology. Rather than representing geometries discretely, geometries in TopoJSON files are stitched together from shared line segments called arcs.

```csharp
public static readonly GisFileType TopoJson;
```

### ImageFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype.md

#### ImageFileType class

Defines image documents. Includes the following file types: `Ai`, `Avif`, `Bmp`, `Cdr`, `Cmx`, `Dcm`, `Dib`, `DjVu`, `Dng`, `Emf`, `Emz`, `Gif`, `Heic``Ico`, `J2c`, `J2k`, `Jls`, `Jp2`, `Jpc`, `Jfif`. `Jpeg`, `Jpf`, `Jpg`, `Jpm`, `Jpx`, `Odg`, `Png`, `Psd`, `Tif`, `Tiff`, `Webp`, `Wmf`. `Wmz`. Learn more about Image formats [here](https://wiki.fileformat.com/image).

```csharp
public sealed class ImageFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |
| IsRaster { get; } | Defines if the image is raster |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Ai | AI, Adobe Illustrator Artwork, represents single-page vector-based drawings in either the EPS or PDF formats. |
| static readonly Avif | AVIF (AV1 Image File Format) is an image file format that stores images compressed with AV1 in HEIF file format. AVIF files are stored with the .avif extension. Version 1 of the AVIF was finalized in February 2019. It has features like High Dynamic Range (HDR), support for 8, 10, and 12 color depth, support for any color space(ISO/IEC CICP and ICC profiles, wide color gamut), etc. Learn more about this file format [here](https://docs.fileformat.com/image/avif/). |
| static readonly Bmp | BMP represent Bitmap Image files that are used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format [here](https://wiki.fileformat.com/image/bmp). |
| static readonly Cdr | A CDR file is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. Such a drawing file contains text, lines, shapes, images, colours and effects for vector representation of image contents. Learn more about this file format [here](https://wiki.fileformat.com/image/cdr). |
| static readonly Cmx | Files with CMX extension are Corel Exchange image file format that is used as presentation by CorelSuite applications. Learn more about this file format [here](https://wiki.fileformat.com/image/cmx). |
| static readonly Dcm | Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here](https://wiki.fileformat.com/image/dcm). |
| static readonly Dib | DIB (Device Independent Bitmap) file is a raster image file that is similar in structure to the standard Bitmap files (BMP) but has a different header. Learn more about this file format [here](https://wiki.fileformat.com/image/dib). |
| static readonly Dicom | Files with .DICOM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here](https://wiki.fileformat.com/image/dicom). |
| static readonly DjVu | DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. Learn more about this file format [here](https://wiki.fileformat.com/image/djvu). |
| static readonly Dng | DNG is a digital camera image format used for the storage of raw files. It has been developed by Adobe in September 2004. It was basically developed for digital photography. Learn more about this file format [here](https://wiki.fileformat.com/image/dng). |
| static readonly Emf | Enhanced metafile format (EMF) stores graphical images device-independently. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here](https://wiki.fileformat.com/image/emf). |
| static readonly Emz | An EMZ file is actually a compressed version of a Microsoft EMF file. This allows for easier distribution of the file online. When an EMF file is compressed using the .GZIP compression algorithm, it is then given the .emz file extension. |
| static readonly Fodg | FODG is a uncompressed XML-format file used for storing OpenDocument text data. FODG extension is associated with open source office productivity suites Libre Office and OpenOffice.org. |
| static readonly Gif | A GIF or Graphical Interchange Format is a type of highly compressed image. For each image GIF typically allow up to 8 bits per pixel and up to 256 colours are allowed across the image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif). |
| static readonly Heic | An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file. The format was adopted by Apple as variant of the HEIF with the launch of iOS 11. Learn more about this file format [here](https://docs.fileformat.com/image/heic/). |
| static readonly Ico | Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows. Learn more about this file format [here](https://wiki.fileformat.com/image/ico). |
| static readonly J2c | J2c document format |
| static readonly J2k | J2K file is an image that is compressed using the wavelet compression instead of DCT compression. Learn more about this file format [here](https://wiki.fileformat.com/image/j2k). |
| static readonly Jfif | JFIF (JPEG File Interchange Format (JFIF)) is an image format file that uses the .jfif extension. JFIF builds over JIF (JPEG Interchange Format) by reducing complexity and solving its limitations. Learn more about this file format [here](https://docs.fileformat.com/image/jfif/). |
| static readonly Jls | Jls document format |
| static readonly Jp2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2). |
| static readonly Jpc | Jpc document format |
| static readonly Jpeg | A JPEG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg). |
| static readonly Jpf | Jpf document format |
| static readonly Jpg | A JPG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg). |
| static readonly Jpm | Jpm document format |
| static readonly Jpx | Jpx document format |
| static readonly Odg | The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here](https://wiki.fileformat.com/image/odg). |
| static readonly Otg | An OTG file is a drawing template that is created using the OpenDocument standard that follows the OASIS Office Applications 1.0 specification. Learn more about this file format [here](https://wiki.fileformat.com/image/otg). |
| static readonly Png | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format [here](https://wiki.fileformat.com/image/png). |
| static readonly Psb | Adobe photoshop saves files in two formats. Files having 30,000 by 30,000 pixels in size are saved with PSD extension and files larger than PSD upto 300,000 by 300,000 pixels are saved with PSB extension known as “Photoshop Big”. Learn more about this file format [here](https://docs.fileformat.com/image/psb). |
| static readonly Psd | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. Learn more about this file format [here](https://wiki.fileformat.com/image/psd). |
| static readonly Tga | A file with .tga extension is a raster graphic format and was created by Truevision Inc. Learn more about this file format [here](https://docs.fileformat.com/image/tga). |
| static readonly Tif | TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff). |
| static readonly Tiff | TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff). |
| static readonly Webp | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size. Learn more about this file format [here](https://wiki.fileformat.com/image/webp). |
| static readonly Wmf | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. Learn more about this file format [here](https://wiki.fileformat.com/image/wmf). |
| static readonly Wmz | An WMZ file is actually a compressed version of a Microsoft WMF file. This allows for easier distribution of the file online. When an EWMFMF file is compressed using the .GZIP compression algorithm, it is then given the .wmz file extension. |

### Ai
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/ai.md

#### ImageFileType.Ai field

AI, Adobe Illustrator Artwork, represents single-page vector-based drawings in either the EPS or PDF formats.

```csharp
public static readonly ImageFileType Ai;
```

### Avif
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/avif.md

#### ImageFileType.Avif field

AVIF (AV1 Image File Format) is an image file format that stores images compressed with AV1 in HEIF file format. AVIF files are stored with the .avif extension. Version 1 of the AVIF was finalized in February 2019. It has features like High Dynamic Range (HDR), support for 8, 10, and 12 color depth, support for any color space(ISO/IEC CICP and ICC profiles, wide color gamut), etc. Learn more about this file format [here](https://docs.fileformat.com/image/avif/).

```csharp
public static readonly ImageFileType Avif;
```

### Bmp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/bmp.md

#### ImageFileType.Bmp field

BMP represent Bitmap Image files that are used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format [here](https://wiki.fileformat.com/image/bmp).

```csharp
public static readonly ImageFileType Bmp;
```

### Cdr
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/cdr.md

#### ImageFileType.Cdr field

A CDR file is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. Such a drawing file contains text, lines, shapes, images, colours and effects for vector representation of image contents. Learn more about this file format [here](https://wiki.fileformat.com/image/cdr).

```csharp
public static readonly ImageFileType Cdr;
```

### Cmx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/cmx.md

#### ImageFileType.Cmx field

Files with CMX extension are Corel Exchange image file format that is used as presentation by CorelSuite applications. Learn more about this file format [here](https://wiki.fileformat.com/image/cmx).

```csharp
public static readonly ImageFileType Cmx;
```

### Dcm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/dcm.md

#### ImageFileType.Dcm field

Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here](https://wiki.fileformat.com/image/dcm).

```csharp
public static readonly ImageFileType Dcm;
```

### Dib
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/dib.md

#### ImageFileType.Dib field

DIB (Device Independent Bitmap) file is a raster image file that is similar in structure to the standard Bitmap files (BMP) but has a different header. Learn more about this file format [here](https://wiki.fileformat.com/image/dib).

```csharp
public static readonly ImageFileType Dib;
```

### Dicom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/dicom.md

#### ImageFileType.Dicom field

Files with .DICOM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here](https://wiki.fileformat.com/image/dicom).

```csharp
public static readonly ImageFileType Dicom;
```

### DjVu
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/djvu.md

#### ImageFileType.DjVu field

DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. Learn more about this file format [here](https://wiki.fileformat.com/image/djvu).

```csharp
public static readonly ImageFileType DjVu;
```

### Dng
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/dng.md

#### ImageFileType.Dng field

DNG is a digital camera image format used for the storage of raw files. It has been developed by Adobe in September 2004. It was basically developed for digital photography. Learn more about this file format [here](https://wiki.fileformat.com/image/dng).

```csharp
public static readonly ImageFileType Dng;
```

### Emf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/emf.md

#### ImageFileType.Emf field

Enhanced metafile format (EMF) stores graphical images device-independently. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here](https://wiki.fileformat.com/image/emf).

```csharp
public static readonly ImageFileType Emf;
```

### Emz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/emz.md

#### ImageFileType.Emz field

An EMZ file is actually a compressed version of a Microsoft EMF file. This allows for easier distribution of the file online. When an EMF file is compressed using the .GZIP compression algorithm, it is then given the .emz file extension.

```csharp
public static readonly ImageFileType Emz;
```

### Fodg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/fodg.md

#### ImageFileType.Fodg field

FODG is a uncompressed XML-format file used for storing OpenDocument text data. FODG extension is associated with open source office productivity suites Libre Office and OpenOffice.org.

```csharp
public static readonly ImageFileType Fodg;
```

### Gif
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/gif.md

#### ImageFileType.Gif field

A GIF or Graphical Interchange Format is a type of highly compressed image. For each image GIF typically allow up to 8 bits per pixel and up to 256 colours are allowed across the image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif).

```csharp
public static readonly ImageFileType Gif;
```

### Heic
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/heic.md

#### ImageFileType.Heic field

An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file. The format was adopted by Apple as variant of the HEIF with the launch of iOS 11. Learn more about this file format [here](https://docs.fileformat.com/image/heic/).

```csharp
public static readonly ImageFileType Heic;
```

### Ico
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/ico.md

#### ImageFileType.Ico field

Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows. Learn more about this file format [here](https://wiki.fileformat.com/image/ico).

```csharp
public static readonly ImageFileType Ico;
```

### ImageFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/imagefiletype.md

#### ImageFileType constructor

Serialization constructor

```csharp
public ImageFileType()
```

### IsRaster
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/israster.md

#### ImageFileType.IsRaster property

Defines if the image is raster

```csharp
public bool IsRaster { get; }
```

### J2c
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/j2c.md

#### ImageFileType.J2c field

J2c document format

```csharp
public static readonly ImageFileType J2c;
```

### J2k
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/j2k.md

#### ImageFileType.J2k field

J2K file is an image that is compressed using the wavelet compression instead of DCT compression. Learn more about this file format [here](https://wiki.fileformat.com/image/j2k).

```csharp
public static readonly ImageFileType J2k;
```

### Jfif
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jfif.md

#### ImageFileType.Jfif field

JFIF (JPEG File Interchange Format (JFIF)) is an image format file that uses the .jfif extension. JFIF builds over JIF (JPEG Interchange Format) by reducing complexity and solving its limitations. Learn more about this file format [here](https://docs.fileformat.com/image/jfif/).

```csharp
public static readonly ImageFileType Jfif;
```

### Jls
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jls.md

#### ImageFileType.Jls field

Jls document format

```csharp
public static readonly ImageFileType Jls;
```

### Jp2
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jp2.md

#### ImageFileType.Jp2 field

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2).

```csharp
public static readonly ImageFileType Jp2;
```

### Jpc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jpc.md

#### ImageFileType.Jpc field

Jpc document format

```csharp
public static readonly ImageFileType Jpc;
```

### Jpeg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jpeg.md

#### ImageFileType.Jpeg field

A JPEG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg).

```csharp
public static readonly ImageFileType Jpeg;
```

### Jpf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jpf.md

#### ImageFileType.Jpf field

Jpf document format

```csharp
public static readonly ImageFileType Jpf;
```

### Jpg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jpg.md

#### ImageFileType.Jpg field

A JPG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg).

```csharp
public static readonly ImageFileType Jpg;
```

### Jpm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jpm.md

#### ImageFileType.Jpm field

Jpm document format

```csharp
public static readonly ImageFileType Jpm;
```

### Jpx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/jpx.md

#### ImageFileType.Jpx field

Jpx document format

```csharp
public static readonly ImageFileType Jpx;
```

### Odg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/odg.md

#### ImageFileType.Odg field

The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here](https://wiki.fileformat.com/image/odg).

```csharp
public static readonly ImageFileType Odg;
```

### Otg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/otg.md

#### ImageFileType.Otg field

An OTG file is a drawing template that is created using the OpenDocument standard that follows the OASIS Office Applications 1.0 specification. Learn more about this file format [here](https://wiki.fileformat.com/image/otg).

```csharp
public static readonly ImageFileType Otg;
```

### Png
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/png.md

#### ImageFileType.Png field

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format [here](https://wiki.fileformat.com/image/png).

```csharp
public static readonly ImageFileType Png;
```

### Psb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/psb.md

#### ImageFileType.Psb field

Adobe photoshop saves files in two formats. Files having 30,000 by 30,000 pixels in size are saved with PSD extension and files larger than PSD upto 300,000 by 300,000 pixels are saved with PSB extension known as “Photoshop Big”. Learn more about this file format [here](https://docs.fileformat.com/image/psb).

```csharp
public static readonly ImageFileType Psb;
```

### Psd
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/psd.md

#### ImageFileType.Psd field

PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. Learn more about this file format [here](https://wiki.fileformat.com/image/psd).

```csharp
public static readonly ImageFileType Psd;
```

### Tga
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/tga.md

#### ImageFileType.Tga field

A file with .tga extension is a raster graphic format and was created by Truevision Inc. Learn more about this file format [here](https://docs.fileformat.com/image/tga).

```csharp
public static readonly ImageFileType Tga;
```

### Tif
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/tif.md

#### ImageFileType.Tif field

TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff).

```csharp
public static readonly ImageFileType Tif;
```

### Tiff
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/tiff.md

#### ImageFileType.Tiff field

TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff).

```csharp
public static readonly ImageFileType Tiff;
```

### Webp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/webp.md

#### ImageFileType.Webp field

WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size. Learn more about this file format [here](https://wiki.fileformat.com/image/webp).

```csharp
public static readonly ImageFileType Webp;
```

### Wmf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/wmf.md

#### ImageFileType.Wmf field

Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. Learn more about this file format [here](https://wiki.fileformat.com/image/wmf).

```csharp
public static readonly ImageFileType Wmf;
```

### Wmz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/imagefiletype/wmz.md

#### ImageFileType.Wmz field

An WMZ file is actually a compressed version of a Microsoft WMF file. This allows for easier distribution of the file online. When an EWMFMF file is compressed using the .GZIP compression algorithm, it is then given the .wmz file extension.

```csharp
public static readonly ImageFileType Wmz;
```

### NoteFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/notefiletype.md

#### NoteFileType class

Defines Note-taking formats. Includes the following file types: `One`. Learn more about Note-taking formats [here](https://wiki.fileformat.com/note-taking).

```csharp
public sealed class NoteFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| NoteFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly One | File represented by .ONE extension are created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one). |

### NoteFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/notefiletype/notefiletype.md

#### NoteFileType constructor

Serialization constructor

```csharp
public NoteFileType()
```

### One
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/notefiletype/one.md

#### NoteFileType.One field

File represented by .ONE extension are created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one).

```csharp
public static readonly NoteFileType One;
```

### PageDescriptionLanguageFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype.md

#### PageDescriptionLanguageFileType class

Defines Page description documents. Includes the following file types: `Svg``Svgz``Eps``Cgm``Xps``Tex``Ps``Pcl``Oxps`

```csharp
public sealed class PageDescriptionLanguageFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| PageDescriptionLanguageFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Cgm | Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. CGM uses object-oriented approach and many function provisions for image production. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/cgm). |
| static readonly Eps | Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/eps). |
| static readonly Oxps | The file format OXPS is known as Open XML Paper Specification. It’s a page description language and document format. Microsoft is the developer of this format. OXPS file format is very much familiar to these PDF files. Learn more about this file format [here](https://docs.fileformat.com/page-description-language/oxps). |
| static readonly Pcl | PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP). Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/pcl). |
| static readonly Ps | PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. The main focus of PostScript (PS) is to facilitate the two-dimensional graphic design. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/ps). |
| static readonly Svg | An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/svg). |
| static readonly Svgz | An SVGZ file is actually a compressed version of a SVG file. This allows for easier distribution of the file online. When an SVG file is compressed using the .GZIP compression algorithm, it is then given the .svgz file extension. |
| static readonly Tex | TeX is a language that comprises of programming as well as mark-up features, used to typeset documents. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/tex). |
| static readonly Xps | An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement of EMF file format and is similar to PDF file format, but uses XML in layout, appearance, and printing information of a document. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/xps). |

### Cgm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/cgm.md

#### PageDescriptionLanguageFileType.Cgm field

Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. CGM uses object-oriented approach and many function provisions for image production. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/cgm).

```csharp
public static readonly PageDescriptionLanguageFileType Cgm;
```

### Eps
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/eps.md

#### PageDescriptionLanguageFileType.Eps field

Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/eps).

```csharp
public static readonly PageDescriptionLanguageFileType Eps;
```

### Oxps
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/oxps.md

#### PageDescriptionLanguageFileType.Oxps field

The file format OXPS is known as Open XML Paper Specification. It’s a page description language and document format. Microsoft is the developer of this format. OXPS file format is very much familiar to these PDF files. Learn more about this file format [here](https://docs.fileformat.com/page-description-language/oxps).

```csharp
public static readonly PageDescriptionLanguageFileType Oxps;
```

### PageDescriptionLanguageFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/pagedescriptionlanguagefiletype.md

#### PageDescriptionLanguageFileType constructor

Serialization constructor

```csharp
public PageDescriptionLanguageFileType()
```

### Pcl
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/pcl.md

#### PageDescriptionLanguageFileType.Pcl field

PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP). Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/pcl).

```csharp
public static readonly PageDescriptionLanguageFileType Pcl;
```

### Ps
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/ps.md

#### PageDescriptionLanguageFileType.Ps field

PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. The main focus of PostScript (PS) is to facilitate the two-dimensional graphic design. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/ps).

```csharp
public static readonly PageDescriptionLanguageFileType Ps;
```

### Svg
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/svg.md

#### PageDescriptionLanguageFileType.Svg field

An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/svg).

```csharp
public static readonly PageDescriptionLanguageFileType Svg;
```

### Svgz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/svgz.md

#### PageDescriptionLanguageFileType.Svgz field

An SVGZ file is actually a compressed version of a SVG file. This allows for easier distribution of the file online. When an SVG file is compressed using the .GZIP compression algorithm, it is then given the .svgz file extension.

```csharp
public static readonly PageDescriptionLanguageFileType Svgz;
```

### Tex
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/tex.md

#### PageDescriptionLanguageFileType.Tex field

TeX is a language that comprises of programming as well as mark-up features, used to typeset documents. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/tex).

```csharp
public static readonly PageDescriptionLanguageFileType Tex;
```

### Xps
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/xps.md

#### PageDescriptionLanguageFileType.Xps field

An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement of EMF file format and is similar to PDF file format, but uses XML in layout, appearance, and printing information of a document. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/xps).

```csharp
public static readonly PageDescriptionLanguageFileType Xps;
```

### PdfFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pdffiletype.md

#### PdfFileType class

Defines Pdf documents. Includes the following file types: `Pdf`,

```csharp
public sealed class PdfFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Pdf | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format [here](https://wiki.fileformat.com/view/pdf). |

### Pdf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pdffiletype/pdf.md

#### PdfFileType.Pdf field

Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format [here](https://wiki.fileformat.com/view/pdf).

```csharp
public static readonly PdfFileType Pdf;
```

### PdfFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/pdffiletype/pdffiletype.md

#### PdfFileType constructor

Serialization constructor

```csharp
public PdfFileType()
```

### PresentationFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype.md

#### PresentationFileType class

Defines Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. Includes the following file types: `Odp`, `Otp`, `Pot`, `Potm`, `Potx`, `Pps`, `Ppsm`, `Ppsx`, `Ppt`, `Pptm`, `Pptx`. Learn more about Presentation formats [here](https://wiki.fileformat.com/presentation).

```csharp
public sealed class PresentationFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Fodp | Files with FODP extension represent OpenDocument Flat XML Presentation. Presentation file saved in the OpenDocument format, but saved using a flat XML format instead of the .ZIP container used by standard .ODP files |
| static readonly Odp | Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp). |
| static readonly Otp | Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here](https://wiki.fileformat.com/presentation/otp). |
| static readonly Pot | Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot). |
| static readonly Potm | Files with POTM extension are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files. Learn more about this file format [here](https://wiki.fileformat.com/presentation/potm). |
| static readonly Potx | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx). |
| static readonly Pps | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pps). |
| static readonly Ppsm | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm). |
| static readonly Ppsx | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx). |
| static readonly Ppt | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt). |
| static readonly Pptm | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm). |
| static readonly Pptx | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptx). |

### Fodp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/fodp.md

#### PresentationFileType.Fodp field

Files with FODP extension represent OpenDocument Flat XML Presentation. Presentation file saved in the OpenDocument format, but saved using a flat XML format instead of the .ZIP container used by standard .ODP files

```csharp
public static readonly PresentationFileType Fodp;
```

### Odp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/odp.md

#### PresentationFileType.Odp field

Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp).

```csharp
public static readonly PresentationFileType Odp;
```

### Otp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/otp.md

#### PresentationFileType.Otp field

Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here](https://wiki.fileformat.com/presentation/otp).

```csharp
public static readonly PresentationFileType Otp;
```

### Pot
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/pot.md

#### PresentationFileType.Pot field

Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot).

```csharp
public static readonly PresentationFileType Pot;
```

### Potm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/potm.md

#### PresentationFileType.Potm field

Files with POTM extension are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files. Learn more about this file format [here](https://wiki.fileformat.com/presentation/potm).

```csharp
public static readonly PresentationFileType Potm;
```

### Potx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/potx.md

#### PresentationFileType.Potx field

Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx).

```csharp
public static readonly PresentationFileType Potx;
```

### Pps
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/pps.md

#### PresentationFileType.Pps field

PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pps).

```csharp
public static readonly PresentationFileType Pps;
```

### Ppsm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/ppsm.md

#### PresentationFileType.Ppsm field

Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm).

```csharp
public static readonly PresentationFileType Ppsm;
```

### Ppsx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/ppsx.md

#### PresentationFileType.Ppsx field

PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx).

```csharp
public static readonly PresentationFileType Ppsx;
```

### Ppt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/ppt.md

#### PresentationFileType.Ppt field

A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt).

```csharp
public static readonly PresentationFileType Ppt;
```

### Pptm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/pptm.md

#### PresentationFileType.Pptm field

Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm).

```csharp
public static readonly PresentationFileType Pptm;
```

### Pptx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/pptx.md

#### PresentationFileType.Pptx field

Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptx).

```csharp
public static readonly PresentationFileType Pptx;
```

### PresentationFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/presentationfiletype/presentationfiletype.md

#### PresentationFileType constructor

Serialization constructor

```csharp
public PresentationFileType()
```

### ProjectManagementFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/projectmanagementfiletype.md

#### ProjectManagementFileType class

Defines Project file formats that are created by Project Management software such as Microsoft Project, Primavera P6 etc. A project file is a collection of tasks, resources, and their scheduling to get a measurable output in the form or a product or a service. Project management documents. Includes the following file types: `Mpp`, `Mpt`, `Mpx`. Learn more about Project Management formats [here](https://wiki.fileformat.com/project-management).

```csharp
public sealed class ProjectManagementFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| ProjectManagementFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Mpp | MPP is Microsoft Project data file that stores information related to project management in an integrated manner. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpp). |
| static readonly Mpt | Microsoft Project template files, contain basic information and structure along with document settings for creating .MPP files. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpt). |
| static readonly Mpx | Microsoft Exchange File Format, is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpx). |
| static readonly Xer | The XER file format is a proprietary project file format used by Primavera P6 project planning and management application. Learn more about this file format [here](https://docs.fileformat.com/project-management/xer). |

### Mpp
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/projectmanagementfiletype/mpp.md

#### ProjectManagementFileType.Mpp field

MPP is Microsoft Project data file that stores information related to project management in an integrated manner. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpp).

```csharp
public static readonly ProjectManagementFileType Mpp;
```

### Mpt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/projectmanagementfiletype/mpt.md

#### ProjectManagementFileType.Mpt field

Microsoft Project template files, contain basic information and structure along with document settings for creating .MPP files. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpt).

```csharp
public static readonly ProjectManagementFileType Mpt;
```

### Mpx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/projectmanagementfiletype/mpx.md

#### ProjectManagementFileType.Mpx field

Microsoft Exchange File Format, is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpx).

```csharp
public static readonly ProjectManagementFileType Mpx;
```

### ProjectManagementFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/projectmanagementfiletype/projectmanagementfiletype.md

#### ProjectManagementFileType constructor

Serialization constructor

```csharp
public ProjectManagementFileType()
```

### Xer
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/projectmanagementfiletype/xer.md

#### ProjectManagementFileType.Xer field

The XER file format is a proprietary project file format used by Primavera P6 project planning and management application. Learn more about this file format [here](https://docs.fileformat.com/project-management/xer).

```csharp
public static readonly ProjectManagementFileType Xer;
```

### PublisherFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/publisherfiletype.md

#### PublisherFileType class

Defines Publisher documents Includes the following types: `Pub` Learn more about Publisher formats [here](https://docs.fileformat.com/publisher/).

```csharp
public sealed class PublisherFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| PublisherFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Pub | A PUB file is a Microsoft Publisher document file format. It is used to create several types of design layout documents such as newsletters, flyers, brochures, postcards, etc. PUB files can contain text, raster and vector images. Learn more about this file format [here](https://docs.fileformat.com/publisher/pub/). |

### Pub
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/publisherfiletype/pub.md

#### PublisherFileType.Pub field

A PUB file is a Microsoft Publisher document file format. It is used to create several types of design layout documents such as newsletters, flyers, brochures, postcards, etc. PUB files can contain text, raster and vector images. Learn more about this file format [here](https://docs.fileformat.com/publisher/pub/).

```csharp
public static readonly PublisherFileType Pub;
```

### PublisherFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/publisherfiletype/publisherfiletype.md

#### PublisherFileType constructor

Serialization constructor

```csharp
public PublisherFileType()
```

### SpreadsheetFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype.md

#### SpreadsheetFileType class

Defines Spreadsheet documents. Includes the following file types: `Csv`, `Fods`, `Ods`, `Ots`, `Tsv`, `Xlam`, `Xls`, `Xlsb`, `Xlsm`, `Xlsx`, `Xlt`, `Xltm`, `Xltx`. Learn more about Spreadsheet formats [here](https://wiki.fileformat.com/spreadsheet).

```csharp
public sealed class SpreadsheetFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Csv | Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/csv). |
| static readonly Dif | DIF stands for Data Interchange Format that is used to import/export spreadsheets data between different applications. These include Microsoft Excel, OpenOffice Calc, StarCalc and many others. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/dif). |
| static readonly FlatOpc | Flat OPC Excel is Office Open XML SpreadsheetML stored in a flat XML file instead of a ZIP package. |
| static readonly Fods | A file with .fods extension is a type of OpenDocument Spreadsheet document format that stores data in rows and columns. The format is specified as part of ODF 1.2 specifications published and maintained by OASIS. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/fods). |
| static readonly Numbers | The files with .numbers extension are classified as spreadsheet file type, that's why they are similar to the .xlsx files; but the Numbers files are created by using Apple iWork Numbers spreadsheet software. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/numbers). |
| static readonly Ods | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods). |
| static readonly Ots | A file with .ots extension is an OpenDocument Spreadsheet Template file that is created with the Calc application software included in Apache OpenOffice. Calc application software is the similar to Excel available in Microsoft Office. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ots). |
| static readonly Sxc | The file format SXC(Sun XML Calc) belongs to an office suite called OpenOffice.org. This format generally deals with the spreadsheet needs of users as it is an XML based spreadsheet file format. SXC format supports formulas, functions, macros and charts along with DataPilot. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/sxc). |
| static readonly Tsv | A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/tsv). |
| static readonly Xlam | XLAM is an Macro-Enabled Add-In file that is used to add new functions to spreadsheets. An Add-In is a supplemental program that runs additional code and provides additional functionality for spreadsheets. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/xlam/). |
| static readonly Xls | XLS represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls). |
| static readonly Xlsb | XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb). |
| static readonly Xlsm | XLSM is a type of Spreadsheet files that support macros. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm). |
| static readonly Xlsx | XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx). |
| static readonly Xlt | Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening these. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt). |
| static readonly Xltm | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure other than that the later doesn't support creating template files with macros. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm). |
| static readonly Xltx | XLTX file represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files that exhibit the same settings as specified in the XLTX file. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltx). |

### Csv
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/csv.md

#### SpreadsheetFileType.Csv field

Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/csv).

```csharp
public static readonly SpreadsheetFileType Csv;
```

### Dif
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/dif.md

#### SpreadsheetFileType.Dif field

DIF stands for Data Interchange Format that is used to import/export spreadsheets data between different applications. These include Microsoft Excel, OpenOffice Calc, StarCalc and many others. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/dif).

```csharp
public static readonly SpreadsheetFileType Dif;
```

### FlatOpc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/flatopc.md

#### SpreadsheetFileType.FlatOpc field

Flat OPC Excel is Office Open XML SpreadsheetML stored in a flat XML file instead of a ZIP package.

```csharp
public static readonly SpreadsheetFileType FlatOpc;
```

### Fods
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/fods.md

#### SpreadsheetFileType.Fods field

A file with .fods extension is a type of OpenDocument Spreadsheet document format that stores data in rows and columns. The format is specified as part of ODF 1.2 specifications published and maintained by OASIS. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/fods).

```csharp
public static readonly SpreadsheetFileType Fods;
```

### Numbers
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/numbers.md

#### SpreadsheetFileType.Numbers field

The files with .numbers extension are classified as spreadsheet file type, that's why they are similar to the .xlsx files; but the Numbers files are created by using Apple iWork Numbers spreadsheet software. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/numbers).

```csharp
public static readonly SpreadsheetFileType Numbers;
```

### Ods
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/ods.md

#### SpreadsheetFileType.Ods field

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods).

```csharp
public static readonly SpreadsheetFileType Ods;
```

### Ots
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/ots.md

#### SpreadsheetFileType.Ots field

A file with .ots extension is an OpenDocument Spreadsheet Template file that is created with the Calc application software included in Apache OpenOffice. Calc application software is the similar to Excel available in Microsoft Office. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ots).

```csharp
public static readonly SpreadsheetFileType Ots;
```

### SpreadsheetFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/spreadsheetfiletype.md

#### SpreadsheetFileType constructor

Serialization constructor

```csharp
public SpreadsheetFileType()
```

### Sxc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/sxc.md

#### SpreadsheetFileType.Sxc field

The file format SXC(Sun XML Calc) belongs to an office suite called OpenOffice.org. This format generally deals with the spreadsheet needs of users as it is an XML based spreadsheet file format. SXC format supports formulas, functions, macros and charts along with DataPilot. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/sxc).

```csharp
public static readonly SpreadsheetFileType Sxc;
```

### Tsv
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/tsv.md

#### SpreadsheetFileType.Tsv field

A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/tsv).

```csharp
public static readonly SpreadsheetFileType Tsv;
```

### Xlam
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlam.md

#### SpreadsheetFileType.Xlam field

XLAM is an Macro-Enabled Add-In file that is used to add new functions to spreadsheets. An Add-In is a supplemental program that runs additional code and provides additional functionality for spreadsheets. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/xlam/).

```csharp
public static readonly SpreadsheetFileType Xlam;
```

### Xls
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xls.md

#### SpreadsheetFileType.Xls field

XLS represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls).

```csharp
public static readonly SpreadsheetFileType Xls;
```

### Xlsb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlsb.md

#### SpreadsheetFileType.Xlsb field

XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb).

```csharp
public static readonly SpreadsheetFileType Xlsb;
```

### Xlsm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlsm.md

#### SpreadsheetFileType.Xlsm field

XLSM is a type of Spreadsheet files that support macros. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm).

```csharp
public static readonly SpreadsheetFileType Xlsm;
```

### Xlsx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlsx.md

#### SpreadsheetFileType.Xlsx field

XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx).

```csharp
public static readonly SpreadsheetFileType Xlsx;
```

### Xlt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlt.md

#### SpreadsheetFileType.Xlt field

Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening these. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt).

```csharp
public static readonly SpreadsheetFileType Xlt;
```

### Xltm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xltm.md

#### SpreadsheetFileType.Xltm field

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure other than that the later doesn't support creating template files with macros. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm).

```csharp
public static readonly SpreadsheetFileType Xltm;
```

### Xltx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/spreadsheetfiletype/xltx.md

#### SpreadsheetFileType.Xltx field

XLTX file represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files that exhibit the same settings as specified in the XLTX file. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltx).

```csharp
public static readonly SpreadsheetFileType Xltx;
```

### ThreeDFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype.md

#### ThreeDFileType class

Defines 3D documents Includes the following types: `Fbx``ThreeDS``ThreeMF``Amf``Ase``Rvm``Dae``Drc``Gltf``Obj``Ply``Jt``U3d``Usd``Usdz``Vrml``X``Glb``Ma``Mb` Learn more about 3D formats [here](https://wiki.fileformat.com/3d).

```csharp
public sealed class ThreeDFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| ThreeDFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Amf | An AMF file consists of guidelines for objects description in order to be used by Additive Manufacturing processes. It contains an opening XML tag and ends with a element. This is preceded by an XML declaration line specifying the XML version and encoding of the file. Learn more about this file format [here](https://docs.fileformat.com/3d/amf). |
| static readonly Ase | A file with a .ase extension is an Autodesk ASCII Scene Export file format that is an ASCII representation of a scene, containing 2D or 3D information while exporting scene data using Autodesk. Learn more about this file format [here](https://docs.fileformat.com/3d/ase). |
| static readonly Dae | A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. This file format is based on the COLLADA (COLLAborative Design Activity) XML schema which is an open standard XML schema for the exchange of digital assets among graphics software applications. Learn more about this file format [here](https://docs.fileformat.com/3d/dae). |
| static readonly Drc | A file with .drc extension is a compressed 3D file format created with Google Draco library. Google offers Draco as open source library for compressing and decompressing 3D geometric meshes and point clouds, and improves storage and transmission of 3D graphics. Learn more about this file format [here](https://docs.fileformat.com/3d/drc). |
| static readonly Fbx | FBX, FilmBox, is a popular 3D file format that was originally developed by Kaydara for MotionBuilder. It was acquired by Autodesk Inc in 2006 and is now one of the main 3D exchange formats as used by many 3D tools. FBX is available in both binary and ASCII file format. Learn more about this file format [here](https://docs.fileformat.com/3d/fbx). |
| static readonly Glb | GLB is the binary file format representation of 3D models saved in the GL Transmission Format (glTF). This binary format stores the glTF asset (JSON, .bin and images) in a binary blob. Learn more about this file format [here](https://docs.fileformat.com/3d/glb). |
| static readonly Gltf | glTF (GL Transmission Format) is a 3D file format that stores 3D model information in JSON format. The use of JSON minimizes both the size of 3D assets and the runtime processing needed to unpack and use those assets. Learn more about this file format [here](https://docs.fileformat.com/3d/gltf). |
| static readonly Jt | JT (Jupiter Tessellation) is an efficient, industry-focused and flexible ISO-standardized 3D data format developed by Siemens PLM Software. Mechanical CAD domains of Aerospace, automotive industry, and Heavy Equipment use JT as their most leading 3D visualization format. Learn more about this file format [here](https://docs.fileformat.com/3d/jt). |
| static readonly Ma | A file with .ma extension is a 3D project file created with Autodesk Maya application. It contains large list of textual commands to specify information about the file. Learn more about this file format [here](https://docs.fileformat.com/3d/ma). |
| static readonly Mb | A file with .mb extension is a binary project file created with Autodesk Maya application. Unlike the MA file format, which is in ASCII file format, MB files are stored in binary file format. Learn more about this file format [here](https://docs.fileformat.com/3d/mb). |
| static readonly Obj | OBJ files are used by Wavefront’s Advanced Visualizer application to define and store the geometric objects. Backward and forward transmission of geometric data is made possible through OBJ files. Learn more about this file format [here](https://docs.fileformat.com/3d/obj). |
| static readonly Ply | PLY, Polygon File Format, represents 3D file format that stores graphical objects described as a collection of polygons. The purpose of this file format was to establish a simple and easy file type that is general enough to be useful for a wide range of models. Learn more about this file format [here](https://docs.fileformat.com/3d/ply). |
| static readonly Rvm | RVM data files are related to AVEVA PDMS. RVM file is an AVEVA Plant Design Management System Model project file. AVEVA’s Plant Design Management System (PDMS) is the most popular 3D design system using data-centric technology for managing projects. Learn more about this file format [here](https://docs.fileformat.com/3d/rvm). |
| static readonly ThreeDS | A file with .3ds extension represents 3D Sudio (DOS) mesh file format used by Autodesk 3D Studio. Autodesk 3D Studio has been in 3D file format market since 1990s and has now evolved to 3D Studio MAX for working with 3D modeling, animation and rendering. Learn more about this file format [here](https://docs.fileformat.com/3d/3ds). |
| static readonly ThreeMF | 3MF, 3D Manufacturing Format, is used by applications to render 3D object models to a variety of other applications, platforms, services and printers. It was built to avoid the limitations and issues in other 3D file formats, like STL, for working with the latest versions of 3D printers. Learn more about this file format [here](https://docs.fileformat.com/3d/3mf). |
| static readonly U3d | U3D (Universal 3D) is a compressed file format and data structure for 3D computer graphics. It contains 3D model information such as triangle meshes, lighting, shading, motion data, lines and points with color and structure. Learn more about this file format [here](https://docs.fileformat.com/3d/u3d). |
| static readonly Usd | A file with .usd extension is a Universal Scene Description file format that encodes data for the purpose of data interchanging and augmenting between digital content creation applications. Developed by Pixar, USD provides the ability to interchange elemental assets (such as models) or animation. Learn more about this file format [here](https://docs.fileformat.com/3d/usd). |
| static readonly Usdz | A file with .usdz is an uncompressed and unencrypted ZIP archive for the USD (Universal Scene Description) file format that contains and proxies for files of other formats (such as textures, and animations) embedded within the archive and runs them directly with the USD run-time without any need of unpacking. Learn more about this file format [here](https://docs.fileformat.com/3d/usdz). |
| static readonly Vrml | The Virtual Reality Modeling Language (VRML) is a file format for representation of interactive 3D world objects over the World Wide Web (www). It finds its usage in creating three-dimensional representations of complex scenes such as illustrations, definition and virtual reality presentations. Learn more about this file format [here](https://docs.fileformat.com/3d/vrml). |
| static readonly X | A file with .x extension refers to DirectX 3D Graphics legacy file format that was introduced with Microsoft DirectX 2.0. It was used for 3D graphics rendering in games and specifies the structures for meshes, textures, animations, and user-defined objects. It has been deprecated since 2014 as the Autodesk FBX file format serves better as a more modern format. Learn more about this file format [here](https://docs.fileformat.com/3d/x). |

### Amf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/amf.md

#### ThreeDFileType.Amf field

An AMF file consists of guidelines for objects description in order to be used by Additive Manufacturing processes. It contains an opening XML tag and ends with a element. This is preceded by an XML declaration line specifying the XML version and encoding of the file. Learn more about this file format [here](https://docs.fileformat.com/3d/amf).

```csharp
public static readonly ThreeDFileType Amf;
```

### Ase
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/ase.md

#### ThreeDFileType.Ase field

A file with a .ase extension is an Autodesk ASCII Scene Export file format that is an ASCII representation of a scene, containing 2D or 3D information while exporting scene data using Autodesk. Learn more about this file format [here](https://docs.fileformat.com/3d/ase).

```csharp
public static readonly ThreeDFileType Ase;
```

### Dae
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/dae.md

#### ThreeDFileType.Dae field

A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. This file format is based on the COLLADA (COLLAborative Design Activity) XML schema which is an open standard XML schema for the exchange of digital assets among graphics software applications. Learn more about this file format [here](https://docs.fileformat.com/3d/dae).

```csharp
public static readonly ThreeDFileType Dae;
```

### Drc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/drc.md

#### ThreeDFileType.Drc field

A file with .drc extension is a compressed 3D file format created with Google Draco library. Google offers Draco as open source library for compressing and decompressing 3D geometric meshes and point clouds, and improves storage and transmission of 3D graphics. Learn more about this file format [here](https://docs.fileformat.com/3d/drc).

```csharp
public static readonly ThreeDFileType Drc;
```

### Fbx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/fbx.md

#### ThreeDFileType.Fbx field

FBX, FilmBox, is a popular 3D file format that was originally developed by Kaydara for MotionBuilder. It was acquired by Autodesk Inc in 2006 and is now one of the main 3D exchange formats as used by many 3D tools. FBX is available in both binary and ASCII file format. Learn more about this file format [here](https://docs.fileformat.com/3d/fbx).

```csharp
public static readonly ThreeDFileType Fbx;
```

### Glb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/glb.md

#### ThreeDFileType.Glb field

GLB is the binary file format representation of 3D models saved in the GL Transmission Format (glTF). This binary format stores the glTF asset (JSON, .bin and images) in a binary blob. Learn more about this file format [here](https://docs.fileformat.com/3d/glb).

```csharp
public static readonly ThreeDFileType Glb;
```

### Gltf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/gltf.md

#### ThreeDFileType.Gltf field

glTF (GL Transmission Format) is a 3D file format that stores 3D model information in JSON format. The use of JSON minimizes both the size of 3D assets and the runtime processing needed to unpack and use those assets. Learn more about this file format [here](https://docs.fileformat.com/3d/gltf).

```csharp
public static readonly ThreeDFileType Gltf;
```

### Jt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/jt.md

#### ThreeDFileType.Jt field

JT (Jupiter Tessellation) is an efficient, industry-focused and flexible ISO-standardized 3D data format developed by Siemens PLM Software. Mechanical CAD domains of Aerospace, automotive industry, and Heavy Equipment use JT as their most leading 3D visualization format. Learn more about this file format [here](https://docs.fileformat.com/3d/jt).

```csharp
public static readonly ThreeDFileType Jt;
```

### Ma
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/ma.md

#### ThreeDFileType.Ma field

A file with .ma extension is a 3D project file created with Autodesk Maya application. It contains large list of textual commands to specify information about the file. Learn more about this file format [here](https://docs.fileformat.com/3d/ma).

```csharp
public static readonly ThreeDFileType Ma;
```

### Mb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/mb.md

#### ThreeDFileType.Mb field

A file with .mb extension is a binary project file created with Autodesk Maya application. Unlike the MA file format, which is in ASCII file format, MB files are stored in binary file format. Learn more about this file format [here](https://docs.fileformat.com/3d/mb).

```csharp
public static readonly ThreeDFileType Mb;
```

### Obj
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/obj.md

#### ThreeDFileType.Obj field

OBJ files are used by Wavefront’s Advanced Visualizer application to define and store the geometric objects. Backward and forward transmission of geometric data is made possible through OBJ files. Learn more about this file format [here](https://docs.fileformat.com/3d/obj).

```csharp
public static readonly ThreeDFileType Obj;
```

### Ply
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/ply.md

#### ThreeDFileType.Ply field

PLY, Polygon File Format, represents 3D file format that stores graphical objects described as a collection of polygons. The purpose of this file format was to establish a simple and easy file type that is general enough to be useful for a wide range of models. Learn more about this file format [here](https://docs.fileformat.com/3d/ply).

```csharp
public static readonly ThreeDFileType Ply;
```

### Rvm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/rvm.md

#### ThreeDFileType.Rvm field

RVM data files are related to AVEVA PDMS. RVM file is an AVEVA Plant Design Management System Model project file. AVEVA’s Plant Design Management System (PDMS) is the most popular 3D design system using data-centric technology for managing projects. Learn more about this file format [here](https://docs.fileformat.com/3d/rvm).

```csharp
public static readonly ThreeDFileType Rvm;
```

### ThreeDFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/threedfiletype.md

#### ThreeDFileType constructor

Serialization constructor

```csharp
public ThreeDFileType()
```

### ThreeDS
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/threeds.md

#### ThreeDFileType.ThreeDS field

A file with .3ds extension represents 3D Sudio (DOS) mesh file format used by Autodesk 3D Studio. Autodesk 3D Studio has been in 3D file format market since 1990s and has now evolved to 3D Studio MAX for working with 3D modeling, animation and rendering. Learn more about this file format [here](https://docs.fileformat.com/3d/3ds).

```csharp
public static readonly ThreeDFileType ThreeDS;
```

### ThreeMF
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/threemf.md

#### ThreeDFileType.ThreeMF field

3MF, 3D Manufacturing Format, is used by applications to render 3D object models to a variety of other applications, platforms, services and printers. It was built to avoid the limitations and issues in other 3D file formats, like STL, for working with the latest versions of 3D printers. Learn more about this file format [here](https://docs.fileformat.com/3d/3mf).

```csharp
public static readonly ThreeDFileType ThreeMF;
```

### U3d
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/u3d.md

#### ThreeDFileType.U3d field

U3D (Universal 3D) is a compressed file format and data structure for 3D computer graphics. It contains 3D model information such as triangle meshes, lighting, shading, motion data, lines and points with color and structure. Learn more about this file format [here](https://docs.fileformat.com/3d/u3d).

```csharp
public static readonly ThreeDFileType U3d;
```

### Usd
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/usd.md

#### ThreeDFileType.Usd field

A file with .usd extension is a Universal Scene Description file format that encodes data for the purpose of data interchanging and augmenting between digital content creation applications. Developed by Pixar, USD provides the ability to interchange elemental assets (such as models) or animation. Learn more about this file format [here](https://docs.fileformat.com/3d/usd).

```csharp
public static readonly ThreeDFileType Usd;
```

### Usdz
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/usdz.md

#### ThreeDFileType.Usdz field

A file with .usdz is an uncompressed and unencrypted ZIP archive for the USD (Universal Scene Description) file format that contains and proxies for files of other formats (such as textures, and animations) embedded within the archive and runs them directly with the USD run-time without any need of unpacking. Learn more about this file format [here](https://docs.fileformat.com/3d/usdz).

```csharp
public static readonly ThreeDFileType Usdz;
```

### Vrml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/vrml.md

#### ThreeDFileType.Vrml field

The Virtual Reality Modeling Language (VRML) is a file format for representation of interactive 3D world objects over the World Wide Web (www). It finds its usage in creating three-dimensional representations of complex scenes such as illustrations, definition and virtual reality presentations. Learn more about this file format [here](https://docs.fileformat.com/3d/vrml).

```csharp
public static readonly ThreeDFileType Vrml;
```

### X
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/threedfiletype/x.md

#### ThreeDFileType.X field

A file with .x extension refers to DirectX 3D Graphics legacy file format that was introduced with Microsoft DirectX 2.0. It was used for 3D graphics rendering in games and specifies the structures for meshes, textures, animations, and user-defined objects. It has been deprecated since 2014 as the Autodesk FBX file format serves better as a more modern format. Learn more about this file format [here](https://docs.fileformat.com/3d/x).

```csharp
public static readonly ThreeDFileType X;
```

### VideoFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype.md

#### VideoFileType class

Defines Video documents Includes the following types: `Mp4`, `Avi`, `Flv`, `Mkv`, `Mov`, `Webm`, `Wmv`, Learn more about video formats [here](https://docs.fileformat.com/video/).

```csharp
public sealed class VideoFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| VideoFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Avi | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. It holds the audio and video data created and compressed using several codecs (Coders/Decoders) such as XVid and DivX. Learn more about this file format [here](https://docs.fileformat.com/video/avi/). |
| static readonly Flv | FLV (Flash Video) is a container file format with the .flv extension. FLV is used to deliver audio/video content over the internet by using the Adobe Flash Player or Adobe Air. Learn more about this file format [here](https://docs.fileformat.com/video/flv/). |
| static readonly Mkv | MKV (Matroska Video) is a multimedia container similar to MOV and AVI format but it supports more than one audio and subtitle track in the same file. An MKV file is the Matroska multimedia container format used for video. Learn more about this file format [here](https://docs.fileformat.com/video/mkv/). |
| static readonly Mov | MOV or QuickTime file format is a multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. Video, Audio, text, etc. Learn more about this file format [here](https://docs.fileformat.com/video/mov/). |
| static readonly Mp4 | MP4(short for MPEG-4 Part 14) is a file format based on ISO/IEC 14496-12:2004 that is based on QuickTime File Format but formally specifies support for Initial Object Descriptors (IOD) and other MPEG features. Learn more about this file format [here](https://docs.fileformat.com/video/mp4/). |
| static readonly Webm | A file with a .webm extension is a video file based on the open, royalty-free WebM file format. It has been designed for sharing video on the web and defines the file container structure including video and audio formats. Learn more about this file format [here](https://docs.fileformat.com/video/webm//). |
| static readonly Wmv | Windows Media Video is the compressed video format developed by Microsoft. After the standardization by the Society of Motion Picture and Television Engineers (SMPTE), WMV is now considered to be an open standard format. Learn more about this file format [here](https://docs.fileformat.com/video/wmv/). |

### Avi
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/avi.md

#### VideoFileType.Avi field

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. It holds the audio and video data created and compressed using several codecs (Coders/Decoders) such as XVid and DivX. Learn more about this file format [here](https://docs.fileformat.com/video/avi/).

```csharp
public static readonly VideoFileType Avi;
```

### Flv
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/flv.md

#### VideoFileType.Flv field

FLV (Flash Video) is a container file format with the .flv extension. FLV is used to deliver audio/video content over the internet by using the Adobe Flash Player or Adobe Air. Learn more about this file format [here](https://docs.fileformat.com/video/flv/).

```csharp
public static readonly VideoFileType Flv;
```

### Mkv
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/mkv.md

#### VideoFileType.Mkv field

MKV (Matroska Video) is a multimedia container similar to MOV and AVI format but it supports more than one audio and subtitle track in the same file. An MKV file is the Matroska multimedia container format used for video. Learn more about this file format [here](https://docs.fileformat.com/video/mkv/).

```csharp
public static readonly VideoFileType Mkv;
```

### Mov
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/mov.md

#### VideoFileType.Mov field

MOV or QuickTime file format is a multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. Video, Audio, text, etc. Learn more about this file format [here](https://docs.fileformat.com/video/mov/).

```csharp
public static readonly VideoFileType Mov;
```

### Mp4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/mp4.md

#### VideoFileType.Mp4 field

MP4(short for MPEG-4 Part 14) is a file format based on ISO/IEC 14496-12:2004 that is based on QuickTime File Format but formally specifies support for Initial Object Descriptors (IOD) and other MPEG features. Learn more about this file format [here](https://docs.fileformat.com/video/mp4/).

```csharp
public static readonly VideoFileType Mp4;
```

### VideoFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/videofiletype.md

#### VideoFileType constructor

Serialization constructor

```csharp
public VideoFileType()
```

### Webm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/webm.md

#### VideoFileType.Webm field

A file with a .webm extension is a video file based on the open, royalty-free WebM file format. It has been designed for sharing video on the web and defines the file container structure including video and audio formats. Learn more about this file format [here](https://docs.fileformat.com/video/webm//).

```csharp
public static readonly VideoFileType Webm;
```

### Wmv
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/videofiletype/wmv.md

#### VideoFileType.Wmv field

Windows Media Video is the compressed video format developed by Microsoft. After the standardization by the Society of Motion Picture and Television Engineers (SMPTE), WMV is now considered to be an open standard format. Learn more about this file format [here](https://docs.fileformat.com/video/wmv/).

```csharp
public static readonly VideoFileType Wmv;
```

### WebFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype.md

#### WebFileType class

Defines Web documents. Includes the following file types: `Xml``Json``Html``Htm``Mht``Mhtml``Chm`

```csharp
public sealed class WebFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| WebFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Chm | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. It provides an index for quick accessing the topics and navigation to different parts of the help document. Learn more about this file format [here](https://docs.fileformat.com/web/chm). |
| static readonly Htm | HTM (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/html). |
| static readonly Html | HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/html). |
| static readonly Json | JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. Learn more about this file format [here](https://docs.fileformat.com/web/json). |
| static readonly Mht | Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml). |
| static readonly Mhtml | Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml). |
| static readonly Xml | XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects. Learn more about this file format [here](https://wiki.fileformat.com/web/xml). |

### Chm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/chm.md

#### WebFileType.Chm field

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. It provides an index for quick accessing the topics and navigation to different parts of the help document. Learn more about this file format [here](https://docs.fileformat.com/web/chm).

```csharp
public static readonly WebFileType Chm;
```

### Htm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/htm.md

#### WebFileType.Htm field

HTM (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/html).

```csharp
public static readonly WebFileType Htm;
```

### Html
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/html.md

#### WebFileType.Html field

HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/html).

```csharp
public static readonly WebFileType Html;
```

### Json
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/json.md

#### WebFileType.Json field

JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. Learn more about this file format [here](https://docs.fileformat.com/web/json).

```csharp
public static readonly WebFileType Json;
```

### Mht
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/mht.md

#### WebFileType.Mht field

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml).

```csharp
public static readonly WebFileType Mht;
```

### Mhtml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/mhtml.md

#### WebFileType.Mhtml field

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml).

```csharp
public static readonly WebFileType Mhtml;
```

### WebFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/webfiletype.md

#### WebFileType constructor

Serialization constructor

```csharp
public WebFileType()
```

### Xml
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/webfiletype/xml.md

#### WebFileType.Xml field

XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects. Learn more about this file format [here](https://wiki.fileformat.com/web/xml).

```csharp
public static readonly WebFileType Xml;
```

### WordProcessingFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype.md

#### WordProcessingFileType class

Defines Word Processing files that contain user information in plain text or rich text format. A plain text file format contains unformatted text and no font or page settings etc. can be applied. In contrast, a rich text file format allows formatting options such as setting fonts type, styles (bold, italic, underline, etc.), page margins, headings, bullets and numbers, and several other formatting features. Includes the following file types: `Doc`, `Docm`, `Docx`, `Dot`, `Dotm`, `Dotx`, `Odt`, `Ott`, `Rtf`, `Txt`. `Md`. Learn more about Word Processing formats [here](https://wiki.fileformat.com/word-processing).

```csharp
public sealed class WordProcessingFileType : FileType
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingFileType() | Serialization constructor |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | File type description |
| Extension { get; } | The file extension |
| Family { get; } | The file family |
| FileFormat { get; } | The file format |

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| override Equals(Enumeration) | Implements `Equals` |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | String representation |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Doc | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/doc). |
| static readonly Docm | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docm). |
| static readonly Docx | DOCX is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docx). |
| static readonly Dot | Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dot). |
| static readonly Dotm | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm). |
| static readonly Dotx | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx). |
| static readonly FlatOpc | Flat OPC Word is Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package. |
| static readonly Md | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. MD files are saved in plain text format that uses Markdown language which also includes inline text symbols, defining how a text can be formatted such as indentations, table formatting, fonts, and headers. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/md). |
| static readonly Odt | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt). |
| static readonly Ott | Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/ott). |
| static readonly Rtf | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf). |
| static readonly Txt | A file with .TXT extension represents a text document that contains plain text in the form of lines. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/txt). |

### Doc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/doc.md

#### WordProcessingFileType.Doc field

Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/doc).

```csharp
public static readonly WordProcessingFileType Doc;
```

### Docm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/docm.md

#### WordProcessingFileType.Docm field

DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docm).

```csharp
public static readonly WordProcessingFileType Docm;
```

### Docx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/docx.md

#### WordProcessingFileType.Docx field

DOCX is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docx).

```csharp
public static readonly WordProcessingFileType Docx;
```

### Dot
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/dot.md

#### WordProcessingFileType.Dot field

Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dot).

```csharp
public static readonly WordProcessingFileType Dot;
```

### Dotm
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/dotm.md

#### WordProcessingFileType.Dotm field

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm).

```csharp
public static readonly WordProcessingFileType Dotm;
```

### Dotx
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/dotx.md

#### WordProcessingFileType.Dotx field

Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx).

```csharp
public static readonly WordProcessingFileType Dotx;
```

### FlatOpc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/flatopc.md

#### WordProcessingFileType.FlatOpc field

Flat OPC Word is Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.

```csharp
public static readonly WordProcessingFileType FlatOpc;
```

### Md
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/md.md

#### WordProcessingFileType.Md field

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. MD files are saved in plain text format that uses Markdown language which also includes inline text symbols, defining how a text can be formatted such as indentations, table formatting, fonts, and headers. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/md).

```csharp
public static readonly WordProcessingFileType Md;
```

### Odt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/odt.md

#### WordProcessingFileType.Odt field

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt).

```csharp
public static readonly WordProcessingFileType Odt;
```

### Ott
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/ott.md

#### WordProcessingFileType.Ott field

Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/ott).

```csharp
public static readonly WordProcessingFileType Ott;
```

### Rtf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/rtf.md

#### WordProcessingFileType.Rtf field

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf).

```csharp
public static readonly WordProcessingFileType Rtf;
```

### Txt
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/txt.md

#### WordProcessingFileType.Txt field

A file with .TXT extension represents a text document that contains plain text in the form of lines. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/txt).

```csharp
public static readonly WordProcessingFileType Txt;
```

### WordProcessingFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.filetypes/wordprocessingfiletype/wordprocessingfiletype.md

#### WordProcessingFileType constructor

Serialization constructor

```csharp
public WordProcessingFileType()
```

### GroupDocs.Conversion.Fluent
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent.md

The namespace provides interfaces for fluent conversion.

#### Interfaces

| Interface | Description |
| --- | --- |
| IConversionByPageCompleted | Handle conversion page completed |
| IConversionByPageCompletedOrConvert | Handle conversion completed or execute conversion |
| IConversionByPageHandlerOnly | Fluent interface for setting only by-page conversion handlers. Inherits `IConversionByPageHandlersStage` for `Convert`/`Compress`; the staged `OnConversion*` overloads are kept via the `new` keyword to preserve back-compat. |
| IConversionByPageHandlersStage | Flattened by-page conversion handlers stage. Per-page mirror of `IConversionHandlersStage`. |
| IConversionByPageOptionsOrHandlerSetup | Fluent interface for setting by-page conversion options or handler setup. Allows setting options or handlers in any order, but only once each, or skipping both. |
| IConversionCompleted | Handle conversion completed |
| IConversionCompletedOrConvert | Handle conversion completed or execute conversion |
| IConversionCompressResult | Can compress all conversion results in single archive |
| IConversionCompressResultCompletedOrConvert | Continuation after `Compress(...)`. Proceed directly with `Convert`; the inherited Stream}) is obsolete — register the handler at the entry stage via `WithEvents` instead. |
| IConversionConvert | Execute conversion |
| IConversionConvertByPageOptions | Conversion convert options |
| IConversionConvertOptionOrCompletedOrConvert | Conversion convert options or conversion completed or execute |
| IConversionConvertOptionOrPageCompletedOrConvert | Conversion convert options or conversion completed or execute |
| IConversionConvertOptions | Conversion convert options |
| IConversionConvertOrCompress | Compress or convert |
| IConversionFrom | Setup source for conversion |
| IConversionGetDocumentInfo | Gets source document info - pages count and other document properties specific to the file type. |
| IConversionGetPossibleConversions | Gets possible conversions for the source document. |
| IConversionHandlerOnly | Fluent interface for setting only conversion handlers. Inherits `IConversionHandlersStage` for `Convert`/`Compress`; the staged `OnConversion*` overloads are kept via the `new` keyword to preserve the existing return types and back-compat. |
| IConversionHandlersStage | Flattened conversion handlers stage. Allows setting `OnConversionCompleted` or `OnConversionFailed` in any order and any number of times, before proceeding to `Convert` / `Compress`. Events should be registered at the early stage via `WithEvents` instead of in this stage. |
| IConversionIsPasswordProtected | Checks if source document is password protected |
| IConversionLoadOptions | Conversion load options |
| IConversionLoadOptionsOrSourceDocumentLoaded | Conversion load options or actions with loaded document |
| IConversionOptionsOnly | Fluent interface for setting only conversion options. |
| IConversionOptionsOrHandlerSetup | Conversion options or conversion handler setup. Exposes both the obsolete staged chain (`IConversionHandlerOnly`) and the new flat `IConversionHandlersStage`. |
| IConversionSettings | Setup conversion settings or events at the entry stage (before `Load`). |
| IConversionSettingsOrConversionFrom | Conversion settings or conversion source |
| IConversionSourceDocumentLoaded | Provides possible actions with loaded document |
| IConversionTo | Set how converted document to be stored |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### IConversionByPageCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagecompleted.md

#### IConversionByPageCompleted interface

Handle conversion page completed

```csharp
public interface IConversionByPageCompleted
```

#### Methods

| Name | Description |
| --- | --- |
| OnConversionCompleted(Action&lt;ConvertedPageContext&gt;) | Receive converted page stream. Will be fired only if "ConvertTo(convertedStreamProvider)" is set. |

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagecompleted/onconversioncompleted.md

#### IConversionByPageCompleted.OnConversionCompleted method

Receive converted page stream. Will be fired only if "ConvertTo(convertedStreamProvider)" is set.

```csharp
public IConversionConvertOrCompress OnConversionCompleted(
    Action<ConvertedPageContext> convertedPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertedPageStream | Action`1 | Converted page stream provider The `ConvertedPageContext` |

##### Return Value

Interface to continue conversion building

### IConversionByPageCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagecompletedorconvert.md

#### IConversionByPageCompletedOrConvert interface

Handle conversion completed or execute conversion

```csharp
public interface IConversionByPageCompletedOrConvert : IConversionByPageCompleted, 
    IConversionCompressResult, IConversionConvert
```

### IConversionByPageHandlerOnly
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagehandleronly.md

#### IConversionByPageHandlerOnly interface

Fluent interface for setting only by-page conversion handlers. Inherits `IConversionByPageHandlersStage` for `Convert`/`Compress`; the staged `OnConversion*` overloads are kept via the `new` keyword to preserve back-compat.

```csharp
public interface IConversionByPageHandlerOnly : IConversionByPageHandlersStage
```

#### Methods

| Name | Description |
| --- | --- |
| OnConversionCompleted(Action&lt;ConvertedPageContext&gt;) | Registers a callback to be invoked when a page conversion completes successfully. |
| OnConversionFailed(Action&lt;ConvertedPageContext, Exception&gt;) | Registers a callback to be invoked when a page conversion fails. |

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagehandleronly/onconversioncompleted.md

#### IConversionByPageHandlerOnly.OnConversionCompleted method

Registers a callback to be invoked when a page conversion completes successfully.

```csharp
public IConversionByPageHandlerFailed OnConversionCompleted(
    Action<ConvertedPageContext> onCompleted)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onCompleted | Action`1 | An action to handle the completion, receiving the converted page context. |

##### Return Value

Interface to continue conversion building, allowing only OnConversionFailed or Convert/Compress.

### OnConversionFailed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagehandleronly/onconversionfailed.md

#### IConversionByPageHandlerOnly.OnConversionFailed method

Registers a callback to be invoked when a page conversion fails.

```csharp
public IConversionByPageHandlerCompleted OnConversionFailed(
    Action<ConvertedPageContext, Exception> onFailed)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onFailed | Action`2 | An action to handle the failure, receiving the converted page context and the exception that caused the failure. |

##### Return Value

Interface to continue conversion building, allowing only OnConversionCompleted or Convert/Compress.

### IConversionByPageHandlersStage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagehandlersstage.md

#### IConversionByPageHandlersStage interface

Flattened by-page conversion handlers stage. Per-page mirror of `IConversionHandlersStage`.

```csharp
public interface IConversionByPageHandlersStage : IConversionConvertOrCompress
```

#### Methods

| Name | Description |
| --- | --- |
| OnConversionCompleted(Action&lt;ConvertedPageContext&gt;) | Registers a callback to be invoked when a page conversion completes successfully. Re-invoking replaces any previously set handler. |
| OnConversionFailed(Action&lt;ConvertedPageContext, Exception&gt;) | Registers a callback to be invoked when a page conversion fails. Re-invoking replaces any previously set handler. |

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversioncompleted.md

#### IConversionByPageHandlersStage.OnConversionCompleted method

Registers a callback to be invoked when a page conversion completes successfully. Re-invoking replaces any previously set handler.

```csharp
public IConversionByPageHandlersStage OnConversionCompleted(
    Action<ConvertedPageContext> onCompleted)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onCompleted | Action`1 | An action to handle the completion, receiving the converted page context. |

##### Return Value

This stage, so additional handlers or `Convert` / `Compress` may be chained.

### OnConversionFailed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversionfailed.md

#### IConversionByPageHandlersStage.OnConversionFailed method

Registers a callback to be invoked when a page conversion fails. Re-invoking replaces any previously set handler.

```csharp
public IConversionByPageHandlersStage OnConversionFailed(
    Action<ConvertedPageContext, Exception> onFailed)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onFailed | Action`2 | An action to handle the failure, receiving the converted page context and the exception that caused the failure. |

##### Return Value

This stage, so additional handlers or `Convert` / `Compress` may be chained.

### IConversionByPageOptionsOrHandlerSetup
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionbypageoptionsorhandlersetup.md

#### IConversionByPageOptionsOrHandlerSetup interface

Fluent interface for setting by-page conversion options or handler setup. Allows setting options or handlers in any order, but only once each, or skipping both.

```csharp
public interface IConversionByPageOptionsOrHandlerSetup : IConversionByPageHandlerOnly, 
    IConversionConvertByPageOptions
```

### IConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversioncompleted.md

#### IConversionCompleted interface

Handle conversion completed

```csharp
public interface IConversionCompleted
```

#### Methods

| Name | Description |
| --- | --- |
| OnConversionCompleted(Action&lt;ConvertedContext&gt;) | Receive converted document stream. Will be fired only if "ConvertTo(string fileName)" or ConvertTo(convertedStreamProvider)" is set. |

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversioncompleted/onconversioncompleted.md

#### IConversionCompleted.OnConversionCompleted method

Receive converted document stream. Will be fired only if "ConvertTo(string fileName)" or ConvertTo(convertedStreamProvider)" is set.

```csharp
public IConversionConvertOrCompress OnConversionCompleted(
    Action<ConvertedContext> convertedFileStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertedFileStream | Action`1 | Converted document stream provider The `ConvertedContext` |

##### Return Value

Interface to continue conversion building

### IConversionCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversioncompletedorconvert.md

#### IConversionCompletedOrConvert interface

Handle conversion completed or execute conversion

```csharp
public interface IConversionCompletedOrConvert : IConversionCompleted, IConversionCompressResult, 
    IConversionConvert
```

### IConversionCompressResult
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversioncompressresult.md

#### IConversionCompressResult interface

Can compress all conversion results in single archive

```csharp
public interface IConversionCompressResult
```

#### Methods

| Name | Description |
| --- | --- |
| Compress(CompressionConvertOptions) | Call this method to compress results of conversion. Register a compressed-stream handler at the entry stage via `WithEvents` (setting `OnCompressionCompleted`) rather than via the obsolete fluent chain method on the returned interface. |

### Compress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversioncompressresult/compress.md

#### IConversionCompressResult.Compress method

Call this method to compress results of conversion. Register a compressed-stream handler at the entry stage via `WithEvents` (setting `OnCompressionCompleted`) rather than via the obsolete fluent chain method on the returned interface.

```csharp
public IConversionCompressResultCompletedOrConvert Compress(CompressionConvertOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | CompressionConvertOptions | Compression convert options |

##### Return Value

Continuation that proceeds to `Convert`.

### IConversionCompressResultCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversioncompressresultcompletedorconvert.md

#### IConversionCompressResultCompletedOrConvert interface

Continuation after `Compress(...)`. Proceed directly with `Convert`; the inherited Stream}) is obsolete — register the handler at the entry stage via `WithEvents` instead.

```csharp
public interface IConversionCompressResultCompletedOrConvert : IConversionCompressResultCompleted, 
    IConversionConvert
```

### IConversionConvert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvert.md

#### IConversionConvert interface

Execute conversion

```csharp
public interface IConversionConvert
```

#### Methods

| Name | Description |
| --- | --- |
| Convert(CancellationToken) | Execute conversion chain |

### Convert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvert/convert.md

#### IConversionConvert.Convert method

Execute conversion chain

```csharp
public void Convert(CancellationToken cancellationToken = default)
```

### IConversionConvertByPageOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertbypageoptions.md

#### IConversionConvertByPageOptions interface

Conversion convert options

```csharp
public interface IConversionConvertByPageOptions
```

#### Methods

| Name | Description |
| --- | --- |
| WithOptions(ConvertOptions) | Set convert options |
| WithOptions(Func&lt;ConvertContext, ConvertOptions&gt;) | Set convert options |

### WithOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertbypageoptions/withoptions.md

#### WithOptions(ConvertOptions)

Set convert options

```csharp
public IConversionByPageHandlerSetup WithOptions(ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptions | ConvertOptions | Convert options |

##### Return Value

Interface to continue conversion building

#### WithOptions(Func&lt;ConvertContext, ConvertOptions&gt;)

Set convert options

```csharp
public IConversionByPageHandlerSetup WithOptions(
    Func<ConvertContext, ConvertOptions> convertOptionsProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptionsProvider | Func`2 | Convert options The `ConvertContext` |

##### Return Value

Interface to continue conversion building

### IConversionConvertOptionOrCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertoptionorcompletedorconvert.md

#### IConversionConvertOptionOrCompletedOrConvert interface

Conversion convert options or conversion completed or execute

```csharp
public interface IConversionConvertOptionOrCompletedOrConvert : IConversionCompleted, 
    IConversionCompressResult, IConversionConvert, IConversionConvertOptions
```

### IConversionConvertOptionOrPageCompletedOrConvert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertoptionorpagecompletedorconvert.md

#### IConversionConvertOptionOrPageCompletedOrConvert interface

Conversion convert options or conversion completed or execute

```csharp
public interface IConversionConvertOptionOrPageCompletedOrConvert : IConversionByPageCompleted, 
    IConversionCompressResult, IConversionConvert, IConversionConvertByPageOptions
```

### IConversionConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertoptions.md

#### IConversionConvertOptions interface

Conversion convert options

```csharp
public interface IConversionConvertOptions
```

#### Methods

| Name | Description |
| --- | --- |
| WithOptions(ConvertOptions) | Set convert options |
| WithOptions(Func&lt;ConvertContext, ConvertOptions&gt;) | Set convert options |

### WithOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertoptions/withoptions.md

#### WithOptions(ConvertOptions)

Set convert options

```csharp
public IConversionHandlerSetup WithOptions(ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptions | ConvertOptions | Convert options |

##### Return Value

Interface to continue conversion building

#### WithOptions(Func&lt;ConvertContext, ConvertOptions&gt;)

Set convert options

```csharp
public IConversionHandlerSetup WithOptions(
    Func<ConvertContext, ConvertOptions> convertOptionsProvider)
```

| Parameter | Description |
| --- | --- |
| convertOptionsProvider | Convert options provider |
| convertOptionsProvider arg1arg1 | The `ConvertContext` |

##### Return Value

Interface to continue conversion building

### IConversionConvertOrCompress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionconvertorcompress.md

#### IConversionConvertOrCompress interface

Compress or convert

```csharp
public interface IConversionConvertOrCompress : IConversionCompressResult, IConversionConvert
```

### IConversionFrom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionfrom.md

#### IConversionFrom interface

Setup source for conversion

```csharp
public interface IConversionFrom
```

#### Methods

| Name | Description |
| --- | --- |
| Load(Func&lt;Stream&gt;) | Set source document stream |
| Load(Func&lt;Stream[]&gt;) | Set source documents streams array |
| Load(string) | Set source document fileName |
| Load(string[]) | Set source documents array |
| WithEvents(Action&lt;ConversionEvents&gt;) | Register conversion lifecycle event handlers on a `ConversionEvents` bag that lives for the converter's lifetime and fires on every conversion run. May be called before or after `WithSettings`. Multiple calls accumulate: the same internal bag is passed to each *configure* action, so handlers set in earlier calls survive unless overwritten by a later one. |

### Load
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionfrom/load.md

#### Load(string)

Set source document fileName

```csharp
public IConversionLoadOptionsOrSourceDocumentLoaded Load(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Source document |

#### Load(string[])

Set source documents array

```csharp
public IConversionLoadOptionsOrSourceDocumentLoaded Load(string[] fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String[] | Set of source documents |

#### Load(Func&lt;Stream&gt;)

Set source document stream

```csharp
public IConversionLoadOptionsOrSourceDocumentLoaded Load(Func<Stream> documentStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | Func`1 | Source document stream provider |

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidConverterSettingsException | If validation of converter settings fails this exception will be thrown |

#### Load(Func&lt;Stream[]&gt;)

Set source documents streams array

```csharp
public IConversionLoadOptionsOrSourceDocumentLoaded Load(Func<Stream[]> documentStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | Func`1 | Source document streams provider |

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidConverterSettingsException | If validation of converter settings fails this exception will be thrown |

### WithEvents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionfrom/withevents.md

#### IConversionFrom.WithEvents method

Register conversion lifecycle event handlers on a `ConversionEvents` bag that lives for the converter's lifetime and fires on every conversion run. May be called before or after `WithSettings`. Multiple calls accumulate: the same internal bag is passed to each *configure* action, so handlers set in earlier calls survive unless overwritten by a later one.

```csharp
public IConversionFrom WithEvents(Action<ConversionEvents> configure)
```

| Parameter | Type | Description |
| --- | --- | --- |
| configure | Action`1 | Action that mutates the events bag. |

##### Return Value

This stage so that further entry-stage calls or `Load` may be chained.

### IConversionGetDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversiongetdocumentinfo.md

#### IConversionGetDocumentInfo interface

Gets source document info - pages count and other document properties specific to the file type.

```csharp
public interface IConversionGetDocumentInfo
```

#### Methods

| Name | Description |
| --- | --- |
| GetDocumentInfo() | Gets source document info - pages count and other document properties specific to the file type. |

### GetDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversiongetdocumentinfo/getdocumentinfo.md

#### IConversionGetDocumentInfo.GetDocumentInfo method

Gets source document info - pages count and other document properties specific to the file type.

```csharp
public IDocumentInfo GetDocumentInfo()
```

### IConversionGetPossibleConversions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversiongetpossibleconversions.md

#### IConversionGetPossibleConversions interface

Gets possible conversions for the source document.

```csharp
public interface IConversionGetPossibleConversions
```

#### Methods

| Name | Description |
| --- | --- |
| GetPossibleConversions() | Gets possible conversions for the source document. |

### GetPossibleConversions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversiongetpossibleconversions/getpossibleconversions.md

#### IConversionGetPossibleConversions.GetPossibleConversions method

Gets possible conversions for the source document.

```csharp
public PossibleConversions GetPossibleConversions()
```

### IConversionHandlerOnly
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionhandleronly.md

#### IConversionHandlerOnly interface

Fluent interface for setting only conversion handlers. Inherits `IConversionHandlersStage` for `Convert`/`Compress`; the staged `OnConversion*` overloads are kept via the `new` keyword to preserve the existing return types and back-compat.

```csharp
public interface IConversionHandlerOnly : IConversionHandlersStage
```

#### Methods

| Name | Description |
| --- | --- |
| OnConversionCompleted(Action&lt;ConvertedContext&gt;) | Registers a callback to be invoked when a document conversion completes successfully. |
| OnConversionFailed(Action&lt;ConvertedContext, Exception&gt;) | Registers a callback to be invoked when a document conversion fails. |

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionhandleronly/onconversioncompleted.md

#### IConversionHandlerOnly.OnConversionCompleted method

Registers a callback to be invoked when a document conversion completes successfully.

```csharp
public IConversionHandlerFailed OnConversionCompleted(Action<ConvertedContext> onCompleted)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onCompleted | Action`1 | An action to handle the completion, receiving the conversion context. |

##### Return Value

Interface to continue conversion building, allowing only OnConversionFailed or Convert/Compress.

### OnConversionFailed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionhandleronly/onconversionfailed.md

#### IConversionHandlerOnly.OnConversionFailed method

Registers a callback to be invoked when a document conversion fails.

```csharp
public IConversionHandlerCompleted OnConversionFailed(Action<ConvertedContext, Exception> onFailed)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onFailed | Action`2 | An action to handle the failure, receiving the conversion context and the exception that caused the failure. |

##### Return Value

Interface to continue conversion building, allowing only OnConversionCompleted or Convert/Compress.

### IConversionHandlersStage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionhandlersstage.md

#### IConversionHandlersStage interface

Flattened conversion handlers stage. Allows setting `OnConversionCompleted` or `OnConversionFailed` in any order and any number of times, before proceeding to `Convert` / `Compress`. Events should be registered at the early stage via `WithEvents` instead of in this stage.

```csharp
public interface IConversionHandlersStage : IConversionConvertOrCompress
```

#### Methods

| Name | Description |
| --- | --- |
| OnConversionCompleted(Action&lt;ConvertedContext&gt;) | Registers a callback to be invoked when a document conversion completes successfully. Re-invoking replaces any previously set handler. |
| OnConversionFailed(Action&lt;ConvertedContext, Exception&gt;) | Registers a callback to be invoked when a document conversion fails. Re-invoking replaces any previously set handler. |

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionhandlersstage/onconversioncompleted.md

#### IConversionHandlersStage.OnConversionCompleted method

Registers a callback to be invoked when a document conversion completes successfully. Re-invoking replaces any previously set handler.

```csharp
public IConversionHandlersStage OnConversionCompleted(Action<ConvertedContext> onCompleted)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onCompleted | Action`1 | An action to handle the completion, receiving the conversion context. |

##### Return Value

This stage, so additional handlers or `Convert` / `Compress` may be chained.

### OnConversionFailed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionhandlersstage/onconversionfailed.md

#### IConversionHandlersStage.OnConversionFailed method

Registers a callback to be invoked when a document conversion fails. Re-invoking replaces any previously set handler.

```csharp
public IConversionHandlersStage OnConversionFailed(Action<ConvertedContext, Exception> onFailed)
```

| Parameter | Type | Description |
| --- | --- | --- |
| onFailed | Action`2 | An action to handle the failure, receiving the conversion context and the exception that caused the failure. |

##### Return Value

This stage, so additional handlers or `Convert` / `Compress` may be chained.

### IConversionIsPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionispasswordprotected.md

#### IConversionIsPasswordProtected interface

Checks if source document is password protected

```csharp
public interface IConversionIsPasswordProtected
```

#### Methods

| Name | Description |
| --- | --- |
| IsDocumentPasswordProtected() | Checks if source document is password protected |

### IsDocumentPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionispasswordprotected/isdocumentpasswordprotected.md

#### IConversionIsPasswordProtected.IsDocumentPasswordProtected method

Checks if source document is password protected

```csharp
public bool IsDocumentPasswordProtected()
```

### IConversionLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionloadoptions.md

#### IConversionLoadOptions interface

Conversion load options

```csharp
public interface IConversionLoadOptions
```

#### Methods

| Name | Description |
| --- | --- |
| WithOptions(Func&lt;LoadContext, LoadOptions&gt;) | Provide load options for the document currently being loading |
| WithOptions(LoadOptions) | Set load options |

### WithOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionloadoptions/withoptions.md

#### WithOptions(LoadOptions)

Set load options

```csharp
public IConversionSourceDocumentLoaded WithOptions(LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | Load options |

#### WithOptions(Func&lt;LoadContext, LoadOptions&gt;)

Provide load options for the document currently being loading

```csharp
public IConversionSourceDocumentLoaded WithOptions(
    Func<LoadContext, LoadOptions> loadOptionsProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| loadOptionsProvider | Func`2 | Load options provider The load options context |

### IConversionLoadOptionsOrSourceDocumentLoaded
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionloadoptionsorsourcedocumentloaded.md

#### IConversionLoadOptionsOrSourceDocumentLoaded interface

Conversion load options or actions with loaded document

```csharp
public interface IConversionLoadOptionsOrSourceDocumentLoaded : IConversionLoadOptions, 
    IConversionSourceDocumentLoaded
```

### IConversionOptionsOnly
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionoptionsonly.md

#### IConversionOptionsOnly interface

Fluent interface for setting only conversion options.

```csharp
public interface IConversionOptionsOnly
```

#### Methods

| Name | Description |
| --- | --- |
| WithOptions(ConvertOptions) | Sets conversion options for the conversion process. |
| WithOptions(Func&lt;ConvertContext, ConvertOptions&gt;) | Sets conversion options using a provider function. |

### WithOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionoptionsonly/withoptions.md

#### WithOptions(ConvertOptions)

Sets conversion options for the conversion process.

```csharp
public IConversionHandlerSetup WithOptions(ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptions | ConvertOptions | Conversion options. |

##### Return Value

Handler setup interface to continue conversion building.

#### WithOptions(Func&lt;ConvertContext, ConvertOptions&gt;)

Sets conversion options using a provider function.

```csharp
public IConversionHandlerSetup WithOptions(Func<ConvertContext, ConvertOptions> optionsProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| optionsProvider | Func`2 | A function that provides conversion options based on the conversion context. |

##### Return Value

Handler setup interface to continue conversion building.

### IConversionOptionsOrHandlerSetup
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionoptionsorhandlersetup.md

#### IConversionOptionsOrHandlerSetup interface

Conversion options or conversion handler setup. Exposes both the obsolete staged chain (`IConversionHandlerOnly`) and the new flat `IConversionHandlersStage`.

```csharp
public interface IConversionOptionsOrHandlerSetup : IConversionHandlerOnly, IConversionOptionsOnly
```

### IConversionSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionsettings.md

#### IConversionSettings interface

Setup conversion settings or events at the entry stage (before `Load`).

```csharp
public interface IConversionSettings
```

#### Methods

| Name | Description |
| --- | --- |
| WithEvents(Action&lt;ConversionEvents&gt;) | Register conversion lifecycle event handlers on a `ConversionEvents` bag that lives for the converter's lifetime and fires on every conversion run. Sits at the same entry stage as `WithSettings`. Multiple calls accumulate: the same internal bag is passed to each *configure* action, so handlers set in earlier calls survive unless overwritten by a later one. |
| WithSettings(Func&lt;ConverterSettings&gt;) | Set converter settings |

### WithEvents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionsettings/withevents.md

#### IConversionSettings.WithEvents method

Register conversion lifecycle event handlers on a `ConversionEvents` bag that lives for the converter's lifetime and fires on every conversion run. Sits at the same entry stage as `WithSettings`. Multiple calls accumulate: the same internal bag is passed to each *configure* action, so handlers set in earlier calls survive unless overwritten by a later one.

```csharp
public IConversionFrom WithEvents(Action<ConversionEvents> configure)
```

| Parameter | Type | Description |
| --- | --- | --- |
| configure | Action`1 | Action that mutates the events bag. |

##### Return Value

The source-selection stage so that `Load` may be chained.

### WithSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionsettings/withsettings.md

#### IConversionSettings.WithSettings method

Set converter settings

```csharp
public IConversionFrom WithSettings(Func<ConverterSettings> settingsProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| settingsProvider | Func`1 | Settings provider |

### IConversionSettingsOrConversionFrom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionsettingsorconversionfrom.md

#### IConversionSettingsOrConversionFrom interface

Conversion settings or conversion source

```csharp
public interface IConversionSettingsOrConversionFrom : IConversionFrom, IConversionSettings
```

### IConversionSourceDocumentLoaded
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionsourcedocumentloaded.md

#### IConversionSourceDocumentLoaded interface

Provides possible actions with loaded document

```csharp
public interface IConversionSourceDocumentLoaded : IConversionGetDocumentInfo, 
    IConversionGetPossibleConversions, IConversionIsPasswordProtected, IConversionTo
```

### IConversionTo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionto.md

#### IConversionTo interface

Set how converted document to be stored

```csharp
public interface IConversionTo
```

#### Methods

| Name | Description |
| --- | --- |
| ConvertByPageTo(Func&lt;SavePageContext, Stream&gt;) | Save converted page as stream |
| ConvertTo(Func&lt;SaveContext, Stream&gt;) | Save converted document as stream |
| ConvertTo(string) | Save converted document as file |

### ConvertByPageTo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionto/convertbypageto.md

#### IConversionTo.ConvertByPageTo method

Save converted page as stream

```csharp
public IConversionByPageOptionsOrHandlerSetup ConvertByPageTo(
    Func<SavePageContext, Stream> convertedStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertedStreamProvider | Func`2 | Converted document page stream provider The save context |

##### Return Value

Page options or handler setup interface to continue conversion building

### ConvertTo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.fluent/iconversionto/convertto.md

#### ConvertTo(string)

Save converted document as file

```csharp
public IConversionOptionsOrHandlerSetup ConvertTo(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Converted document |

##### Return Value

Options or handler setup interface to continue conversion building

#### ConvertTo(Func&lt;SaveContext, Stream&gt;)

Save converted document as stream

```csharp
public IConversionOptionsOrHandlerSetup ConvertTo(Func<SaveContext, Stream> convertedStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertedStreamProvider | Func`2 | Converted document stream provider The save context |

##### Return Value

Options or handler setup interface to continue conversion building

### GroupDocs.Conversion.Integration.Audio
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.audio.md

The namespace provides interfaces and classes, required for audio conversion support.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAudioConnector | Defines methods that are required to convert audio to audio documents. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### IAudioConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.audio/iaudioconnector.md

#### IAudioConnector interface

Defines methods that are required to convert audio to audio documents.

```csharp
public interface IAudioConnector
```

#### Methods

| Name | Description |
| --- | --- |
| ConvertAudio(Stream, AudioConvertOptions) | Does the Audio conversion provided as a stream. |

### ConvertAudio
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.audio/iaudioconnector/convertaudio.md

#### IAudioConnector.ConvertAudio method

Does the Audio conversion provided as a stream.

```csharp
public Stream ConvertAudio(Stream sourceStream, AudioConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | Stream | Stream, containing an audio to process |
| convertOptions | AudioConvertOptions | Audio convert options |

##### Return Value

Converted audio

### GroupDocs.Conversion.Integration.Heic
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.heic.md

The namespace provides interfaces and classes, required for heic conversion support.

#### Interfaces

| Interface | Description |
| --- | --- |
| IHeicConnector | Defines methods that are required to convert from Heic image. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### IHeicConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.heic/iheicconnector.md

#### IHeicConnector interface

Defines methods that are required to convert from Heic image.

```csharp
public interface IHeicConnector
```

#### Methods

| Name | Description |
| --- | --- |
| GetBitmapInfo(Stream) | Convert Heic image to raster image |

### GetBitmapInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.heic/iheicconnector/getbitmapinfo.md

#### IHeicConnector.GetBitmapInfo method

Convert Heic image to raster image

```csharp
public BitmapInfo GetBitmapInfo(Stream heicStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| heicStream | Stream | Stream, containing an image to process |

##### Return Value

Object containing array of pixels and bitmap information.

### GroupDocs.Conversion.Integration.Ocr
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr.md

The namespace provides interfaces and classes, required for Optical Character Recognition (OCR) support.

#### Classes

| Class | Description |
| --- | --- |
| RecognizedImage | Represents text, extracted from an image as a result of its recognition process. |
| TextFragment | Represents a part of recognized text (word, symbol, etc), extracted by OCR engine. |
| TextLine | Represents text, extracted from an image as a result of its recognition process. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IOcrConnector | Defines methods that are required to apply OCR to image documents and embedded images. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### IOcrConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/iocrconnector.md

#### IOcrConnector interface

Defines methods that are required to apply OCR to image documents and embedded images.

```csharp
public interface IOcrConnector
```

#### Methods

| Name | Description |
| --- | --- |
| Recognize(Stream) | Does the OCR processing of an image, provided as a stream. |

### Recognize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/iocrconnector/recognize.md

#### IOcrConnector.Recognize method

Does the OCR processing of an image, provided as a stream.

```csharp
public RecognizedImage Recognize(Stream imageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | Stream, containing an image to process |

##### Return Value

Structured recognized text, containing lines, words and their bounding rectangles

### RecognizedImage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/recognizedimage.md

#### RecognizedImage class

Represents text, extracted from an image as a result of its recognition process.

```csharp
public class RecognizedImage
```

#### Constructors

| Name | Description |
| --- | --- |
| RecognizedImage(IEnumerable&lt;TextLine&gt;) | Initializes a new instance of the class, using a set of recognized lines. |

#### Properties

| Name | Description |
| --- | --- |
| Lines { get; } | Gets lines of text, with their fragments, recognized within the document. |
| Text { get; } | Gets textual equivalent of the structured text |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Empty | Empty recognized image |

### Empty
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/recognizedimage/empty.md

#### RecognizedImage.Empty field

Empty recognized image

```csharp
public static readonly RecognizedImage Empty;
```

### Lines
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/recognizedimage/lines.md

#### RecognizedImage.Lines property

Gets lines of text, with their fragments, recognized within the document.

```csharp
public TextLine[] Lines { get; }
```

### RecognizedImage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/recognizedimage/recognizedimage.md

#### RecognizedImage constructor

Initializes a new instance of the class, using a set of recognized lines.

```csharp
public RecognizedImage(IEnumerable<TextLine> lines)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lines | IEnumerable`1 | an IEnumerable (e.g. a list or an array) of recognized lines |

### Text
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/recognizedimage/text.md

#### RecognizedImage.Text property

Gets textual equivalent of the structured text

```csharp
public string Text { get; }
```

### TextFragment
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textfragment.md

#### TextFragment class

Represents a part of recognized text (word, symbol, etc), extracted by OCR engine.

```csharp
public class TextFragment
```

#### Constructors

| Name | Description |
| --- | --- |
| TextFragment(string, Rectangle) | Initializes a new instance of the recognized text fragment. |

#### Properties

| Name | Description |
| --- | --- |
| Rectangle { get; } | Gets a bounding rectangle of the recognized text fragment. |
| Text { get; } | Gets a textual content of the recognized text fragment. |

### Rectangle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textfragment/rectangle.md

#### TextFragment.Rectangle property

Gets a bounding rectangle of the recognized text fragment.

```csharp
public Rectangle Rectangle { get; }
```

### Text
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textfragment/text.md

#### TextFragment.Text property

Gets a textual content of the recognized text fragment.

```csharp
public string Text { get; }
```

### TextFragment
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textfragment/textfragment.md

#### TextFragment constructor

Initializes a new instance of the recognized text fragment.

```csharp
public TextFragment(string text, Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | textual content of the recognized text fragment |
| rectangle | Rectangle | bounding rectangle of the recognized text fragment |

### TextLine
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textline.md

#### TextLine class

Represents text, extracted from an image as a result of its recognition process.

```csharp
public class TextLine
```

#### Constructors

| Name | Description |
| --- | --- |
| TextLine(IEnumerable&lt;TextFragment&gt;) | Initializes a new instance of a line of text, extracted by OCR engine from an image. |

#### Properties

| Name | Description |
| --- | --- |
| Fragments { get; } | Gets an array of text fragments, such as symbols and words, recognized in the line. |

### Fragments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textline/fragments.md

#### TextLine.Fragments property

Gets an array of text fragments, such as symbols and words, recognized in the line.

```csharp
public TextFragment[] Fragments { get; }
```

### TextLine
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.ocr/textline/textline.md

#### TextLine constructor

Initializes a new instance of a line of text, extracted by OCR engine from an image.

```csharp
public TextLine(IEnumerable<TextFragment> fragments)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fragments | IEnumerable`1 | initial set of text fragments |

### GroupDocs.Conversion.Integration.Video
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.video.md

The namespace provides interfaces and classes, required for video conversion support.

#### Interfaces

| Interface | Description |
| --- | --- |
| IPresentationVideoConnector | Defines methods that are required to convert presentation documents to video. |
| IVideoConnector | Defines methods that are required to convert video documents. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### IPresentationVideoConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.video/ipresentationvideoconnector.md

#### IPresentationVideoConnector interface

Defines methods that are required to convert presentation documents to video.

```csharp
public interface IPresentationVideoConnector
```

#### Methods

| Name | Description |
| --- | --- |
| CreateVideoFromPngFrames(List&lt;Stream&gt;, VideoConvertOptions) | Combines a list of PNG frames into a video. |

### CreateVideoFromPngFrames
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.video/ipresentationvideoconnector/createvideofrompngframes.md

#### IPresentationVideoConnector.CreateVideoFromPngFrames method

Combines a list of PNG frames into a video.

```csharp
public Stream CreateVideoFromPngFrames(List<Stream> pngFrames, VideoConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pngFrames | List`1 | List of PNG frames |
| convertOptions | VideoConvertOptions | Video convert options |

##### Return Value

Converted video

### IVideoConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.video/ivideoconnector.md

#### IVideoConnector interface

Defines methods that are required to convert video documents.

```csharp
public interface IVideoConnector
```

#### Methods

| Name | Description |
| --- | --- |
| ConvertVideo(Stream, VideoConvertOptions) | Does the Video conversion provided as a stream. |

### ConvertVideo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.integration.video/ivideoconnector/convertvideo.md

#### IVideoConnector.ConvertVideo method

Does the Video conversion provided as a stream.

```csharp
public Stream ConvertVideo(Stream sourceStream, VideoConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | Stream | Stream, containing an video to process |
| convertOptions | VideoConvertOptions | Video convert options |

##### Return Value

Converted video

### GroupDocs.Conversion.Logging
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging.md

The namespace provides classes for customizing logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Console logger implementation. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### ConsoleLogger
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/consolelogger.md

#### ConsoleLogger class

Console logger implementation.

```csharp
public sealed class ConsoleLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| ConsoleLogger() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes error log message; Error log messages provides information about unrecoverable events in application flow. |
| Trace(string) | Writes trace log message; Trace log messages provides generally useful information about application flow. |
| Warning(string) | Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow. |

### ConsoleLogger
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

The default constructor.

```csharp
public ConsoleLogger()
```

### Error
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/consolelogger/error.md

#### ConsoleLogger.Error method

Writes error log message; Error log messages provides information about unrecoverable events in application flow.

```csharp
public void Error(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| exception | Exception | The exception. |

### Trace
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/consolelogger/trace.md

#### ConsoleLogger.Trace method

Writes trace log message; Trace log messages provides generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

### Warning
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/consolelogger/warning.md

#### ConsoleLogger.Warning method

Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

### ILogger
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/ilogger.md

#### ILogger interface

Defines the methods that are used to perform logging.

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes error log message; Error log messages provides information about unrecoverable events in application flow. |
| Trace(string) | Writes trace log message; Trace log messages provides generally useful information about application flow. |
| Warning(string) | Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow. |

### Error
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/ilogger/error.md

#### ILogger.Error method

Writes error log message; Error log messages provides information about unrecoverable events in application flow.

```csharp
public void Error(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| exception | Exception | The exception. |

### Trace
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/ilogger/trace.md

#### ILogger.Trace method

Writes trace log message; Trace log messages provides generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

### Warning
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.logging/ilogger/warning.md

#### ILogger.Warning method

Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

### GroupDocs.Conversion.Options.Convert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert.md

The namespace provides classes to specify additional options for document conversion process.

#### Classes

| Class | Description |
| --- | --- |
| AudioConvertOptions | Options for conversion to Audio type. |
| CadConvertOptions | Options for conversion to Cad type. |
| CommonConvertOptions&lt;TFileType&gt; | Abstract generic common conversion options class. |
| CompressionConvertOptions | Options for conversion to Compression file type. |
| ConvertOptions | The general conversion options class. |
| ConvertOptions&lt;TFileType&gt; | Abstract generic conversion options class. |
| DiagramConvertOptions | Options for conversion to Diagram file type. |
| EBookConvertOptions | Options for conversion to EBook file type. |
| EmailConvertOptions | Options for conversion to Email file type. |
| FinanceConvertOptions | Options for conversion to finance type. |
| Font | Font settings |
| FontConvertOptions | Options for conversion to Font type. |
| GisConvertOptions | Options for conversion to GIS type. |
| ImageConvertOptions | Options for conversion to Image file type. |
| ImageFlipModes | Describes image flip modes. |
| JpegOptions | Options for conversion to Jpeg file type. |
| JpgColorModes | Describes Jpg color modes enumeration. |
| JpgCompressionMethods | Describes Jpg compression modes |
| MarkdownImageSavingArgs | Arguments passed to `ImageSaving`. |
| MarkdownOptions | Options for conversion to markdown file type. |
| NoConvertOptions | Special convert option class, which instructs converter to copy source document without any processing |
| PageDescriptionLanguageConvertOptions | Options for conversion to page descriptions language file type. |
| PageOrientation | Specifies page orientation |
| PageResizeMode | Specifies how content should be scaled when page size is changed |
| PdfConvertOptions | Options for conversion to Pdf file type. |
| PdfDirection | Describes Pdf text direction. |
| PdfDocumentInfo | Represents meta information of PDF document. |
| PdfFontSubsetStrategy | Specifies font subsetting strategy |
| PdfFormats | Describes Pdf formats enumeration. |
| PdfFormattingOptions | Defines Pdf formatting options. |
| PdfOptimizationOptions | Defines Pdf optimization options. |
| PdfOptions | Options for conversion to Pdf file type. |
| PdfPageLayout | Describes Pdf page layout. |
| PdfPageMode | Describes Pdf page mode |
| PdfRecognitionMode | Allows to control how a PDF document is converted into a word processing document. |
| PresentationConvertOptions | Describes options for conversion to Presentation file type. |
| ProjectManagementConvertOptions | Options for conversion to Project management file type. |
| PsdColorModes | Defines Psd color modes enumeration. |
| PsdCompressionMethods | Describes Psd compression methods. |
| PsdOptions | Options for converting to Psd file type. |
| Rotation | Describes page rotation enumeration |
| RtfOptions | Options for conversion to RTF file type. |
| SpreadsheetConvertOptions | Options for conversion to Spreadsheet file type. |
| ThreeDConvertOptions | Options for conversion to 3D type. |
| TiffCompressionMethods | Describes Tiff compression methods enumeration. |
| TiffOptions | Options for conversion to TIFF file type. |
| VideoConvertOptions | Options for conversion to Video type. |
| WatermarkImageOptions | Options for settings watermark to the converted document |
| WatermarkOptions | Options for settings watermark to the converted document |
| WatermarkTextOptions | Options for settings text watermark to the converted document |
| WebConvertOptions | Options for conversion to Web file type. |
| WebpOptions | Options for conversion to Webp file type. |
| WordProcessingConvertOptions | Options for conversion to WordProcessing file type. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IConvertOptions | Represents convert options |
| IDpiConvertOptions | Represents convert options that support DPI (Dots Per Inch) settings. |
| IMarkdownImageSavingCallback | Handles custom processing of images while saving to Markdown. Invoked once per image; mutate `MarkdownImageSavingArgs` to control the URI embedded in the Markdown output and/or redirect where the image bytes are written. |
| IPagedConvertOptions | Represents convert options that allows conversion to perform page limitation by specifying start page and pages count |
| IPageRangedConvertOptions | Represents convert options that support conversion of specific list of pages |
| IPasswordConvertOptions | Represents convert options that support password protection for converted documents. |
| IPdfRecognitionModeOptions | Represents convert options that control recognition mode when converting from PDF |
| IUsePdfConvertOptions | Represents options that support converting to PDF if required |
| IWatermarkedConvertOptions | Represents convert options that allow output of conversion to be watermarked |
| IZoomConvertOptions | Represents convert options that allows conversion to be performed with zoom options |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### AudioConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/audioconvertoptions.md

#### AudioConvertOptions class

Options for conversion to Audio type.

```csharp
public class AudioConvertOptions : ConvertOptions<AudioFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| AudioConvertOptions() | Initializes new instance of `AudioConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AudioConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/audioconvertoptions/audioconvertoptions.md

#### AudioConvertOptions constructor

Initializes new instance of `AudioConvertOptions` class.

```csharp
public AudioConvertOptions()
```

### CadConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/cadconvertoptions.md

#### CadConvertOptions class

Options for conversion to Cad type.

```csharp
public class CadConvertOptions : ConvertOptions<CadFileType>, IPagedConvertOptions, IPageSizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CadConvertOptions() | Initializes new instance of `CadConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| PagesCount { get; set; } | Implements `PagesCount` |
| SizeSettings { get; set; } | Page size settings |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### CadConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/cadconvertoptions/cadconvertoptions.md

#### CadConvertOptions constructor

Initializes new instance of `CadConvertOptions` class.

```csharp
public CadConvertOptions()
```

### PageNumber
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/cadconvertoptions/pagenumber.md

#### CadConvertOptions.PageNumber property

Implements `PageNumber`

```csharp
public int PageNumber { get; set; }
```

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/cadconvertoptions/pagescount.md

#### CadConvertOptions.PagesCount property

Implements `PagesCount`

```csharp
public int PagesCount { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/cadconvertoptions/sizesettings.md

#### CadConvertOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### CommonConvertOptionsTFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/commonconvertoptions-1.md

#### CommonConvertOptions&lt;TFileType&gt; class

Abstract generic common conversion options class.

```csharp
public abstract class CommonConvertOptions<TFileType> : ConvertOptions<TFileType>, 
    IPagedConvertOptions, IPageRangedConvertOptions, IWatermarkedConvertOptions
    where TFileType : FileType
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Watermark { get; set; } | Implements `Watermark` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### PageNumber
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/commonconvertoptions-1/pagenumber.md

#### CommonConvertOptions&lt;TFileType&gt;.PageNumber property

Implements `PageNumber`

```csharp
public int PageNumber { get; set; }
```

### Pages
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/commonconvertoptions-1/pages.md

#### CommonConvertOptions&lt;TFileType&gt;.Pages property

Implements `Pages`

```csharp
public List<int> Pages { get; set; }
```

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/commonconvertoptions-1/pagescount.md

#### CommonConvertOptions&lt;TFileType&gt;.PagesCount property

Implements `PagesCount`

```csharp
public int PagesCount { get; set; }
```

### Watermark
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/commonconvertoptions-1/watermark.md

#### CommonConvertOptions&lt;TFileType&gt;.Watermark property

Implements `Watermark`

```csharp
public WatermarkOptions Watermark { get; set; }
```

### CompressionConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/compressionconvertoptions.md

#### CompressionConvertOptions class

Options for conversion to Compression file type.

```csharp
public class CompressionConvertOptions : ConvertOptions<CompressionFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| CompressionConvertOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| Password { get; set; } | Set this property if you want to protect the converted document with a password. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### CompressionConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/compressionconvertoptions/compressionconvertoptions.md

#### CompressionConvertOptions constructor

The default constructor.

```csharp
public CompressionConvertOptions()
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/compressionconvertoptions/password.md

#### CompressionConvertOptions.Password property

Set this property if you want to protect the converted document with a password.

```csharp
public string Password { get; set; }
```

### ConvertOptionsTFileType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/convertoptions-1.md

#### ConvertOptions&lt;TFileType&gt; class

Abstract generic conversion options class.

```csharp
public abstract class ConvertOptions<TFileType> : ConvertOptions
    where TFileType : FileType
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/convertoptions-1/format.md

#### ConvertOptions&lt;TFileType&gt;.Format property

The desired file type the input document should be converted to.

```csharp
public TFileType Format { get; set; }
```

### ConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/convertoptions.md

#### ConvertOptions class

The general conversion options class.

```csharp
public abstract class ConvertOptions : ValueObject, ICloneable, IConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/convertoptions/clone.md

#### ConvertOptions.Clone method

Clones current options instance.

```csharp
public object Clone()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/convertoptions/format.md

#### ConvertOptions.Format property

Implements `Format`

```csharp
public virtual FileType Format { get; set; }
```

### DiagramConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/diagramconvertoptions.md

#### DiagramConvertOptions class

Options for conversion to Diagram file type.

```csharp
public sealed class DiagramConvertOptions : CommonConvertOptions<DiagramFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramConvertOptions() | Initializes new instance of `DiagramConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoFitPageToDrawingContent { get; set; } | Defines whether need enlarge page to fit drawing content or not |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Watermark { get; set; } | Implements `Watermark` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AutoFitPageToDrawingContent
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/diagramconvertoptions/autofitpagetodrawingcontent.md

#### DiagramConvertOptions.AutoFitPageToDrawingContent property

Defines whether need enlarge page to fit drawing content or not

```csharp
public bool AutoFitPageToDrawingContent { get; set; }
```

### DiagramConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/diagramconvertoptions/diagramconvertoptions.md

#### DiagramConvertOptions constructor

Initializes new instance of `DiagramConvertOptions` class.

```csharp
public DiagramConvertOptions()
```

### EBookConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ebookconvertoptions.md

#### EBookConvertOptions class

Options for conversion to EBook file type.

```csharp
public class EBookConvertOptions : CommonConvertOptions<EBookFileType>, IPageOrientationOptions, 
    IPageSizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EBookConvertOptions() | Initializes new instance of `EBookConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| FallbackPageSize { get; set; } | Fallback page size |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| OrientationSettings { get; set; } | Page orientation settings |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| SizeSettings { get; set; } | Page size settings |
| Watermark { get; set; } | Implements `Watermark` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### EBookConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ebookconvertoptions/ebookconvertoptions.md

#### EBookConvertOptions constructor

Initializes new instance of `EBookConvertOptions` class.

```csharp
public EBookConvertOptions()
```

### FallbackPageSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ebookconvertoptions/fallbackpagesize.md

#### EBookConvertOptions.FallbackPageSize property

Fallback page size

```csharp
public PageSize FallbackPageSize { get; set; }
```

### OrientationSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ebookconvertoptions/orientationsettings.md

#### EBookConvertOptions.OrientationSettings property

Page orientation settings

```csharp
public PageOrientation OrientationSettings { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ebookconvertoptions/sizesettings.md

#### EBookConvertOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### EmailConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/emailconvertoptions.md

#### EmailConvertOptions class

Options for conversion to Email file type.

```csharp
public class EmailConvertOptions : ConvertOptions<EmailFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailConvertOptions() | Initializes new instance of `EmailConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AttachmentContentHandler { get; set; } | A delegate to handle custom processing of email attachments. The delegate takes the attachment name, content type and original attachment stream as parameters and returns the modified attachment stream. |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AttachmentContentHandler
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/emailconvertoptions/attachmentcontenthandler.md

#### EmailConvertOptions.AttachmentContentHandler property

A delegate to handle custom processing of email attachments. The delegate takes the attachment name, content type and original attachment stream as parameters and returns the modified attachment stream.

```csharp
public Func<string, string, Stream, Stream> AttachmentContentHandler { get; set; }
```

### EmailConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/emailconvertoptions/emailconvertoptions.md

#### EmailConvertOptions constructor

Initializes new instance of `EmailConvertOptions` class.

```csharp
public EmailConvertOptions()
```

### FinanceConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/financeconvertoptions.md

#### FinanceConvertOptions class

Options for conversion to finance type.

```csharp
public class FinanceConvertOptions : ConvertOptions<FinanceFileType>, IPagedConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| FinanceConvertOptions() | Initializes new instance of `FinanceConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| PagesCount { get; set; } | Implements `PagesCount` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### FinanceConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/financeconvertoptions/financeconvertoptions.md

#### FinanceConvertOptions constructor

Initializes new instance of `FinanceConvertOptions` class.

```csharp
public FinanceConvertOptions()
```

### PageNumber
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/financeconvertoptions/pagenumber.md

#### FinanceConvertOptions.PageNumber property

Implements `PageNumber`

```csharp
public int PageNumber { get; set; }
```

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/financeconvertoptions/pagescount.md

#### FinanceConvertOptions.PagesCount property

Implements `PagesCount`

```csharp
public int PagesCount { get; set; }
```

### Font
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font.md

#### Font class

Font settings

```csharp
public class Font : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| Font(string) | creates new Font instance with default size 12 |
| Font(string, float) | creates new Font instance |

#### Properties

| Name | Description |
| --- | --- |
| Bold { get; set; } | Font bold |
| FamilyName { get; } | Font family name |
| Italic { get; set; } | Font italic |
| Size { get; } | Font size |
| Underline { get; set; } | Font underline |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Bold
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font/bold.md

#### Font.Bold property

Font bold

```csharp
public bool Bold { get; set; }
```

### FamilyName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font/familyname.md

#### Font.FamilyName property

Font family name

```csharp
public string FamilyName { get; }
```

### Font
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font/font.md

#### Font(string)

creates new Font instance with default size 12

```csharp
public Font(string fontFamilyName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | String | Font name |

#### Font(string, float)

creates new Font instance

```csharp
public Font(string fontFamilyName, float size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | String | Font name |
| size | Single | Font size |

### Italic
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font/italic.md

#### Font.Italic property

Font italic

```csharp
public bool Italic { get; set; }
```

### Size
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font/size.md

#### Font.Size property

Font size

```csharp
public float Size { get; }
```

### Underline
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/font/underline.md

#### Font.Underline property

Font underline

```csharp
public bool Underline { get; set; }
```

### FontConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/fontconvertoptions.md

#### FontConvertOptions class

Options for conversion to Font type.

```csharp
public class FontConvertOptions : ConvertOptions<FontFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| FontConvertOptions() | Initializes a new instance of the `FontConvertOptions` class with default output format. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### FontConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/fontconvertoptions/fontconvertoptions.md

#### FontConvertOptions constructor

Initializes a new instance of the `FontConvertOptions` class with default output format.

```csharp
public FontConvertOptions()
```

### GisConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/gisconvertoptions.md

#### GisConvertOptions class

Options for conversion to GIS type.

```csharp
public class GisConvertOptions : ConvertOptions<GisFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| GisConvertOptions() | Initializes new instance of `GisConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### GisConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/gisconvertoptions/gisconvertoptions.md

#### GisConvertOptions constructor

Initializes new instance of `GisConvertOptions` class.

```csharp
public GisConvertOptions()
```

### IConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/iconvertoptions.md

#### IConvertOptions interface

Represents convert options

```csharp
public interface IConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/iconvertoptions/format.md

#### IConvertOptions.Format property

The desired file type the input document should be converted to.

```csharp
public FileType Format { get; set; }
```

### IDpiConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/idpiconvertoptions.md

#### IDpiConvertOptions interface

Represents convert options that support DPI (Dots Per Inch) settings.

```csharp
public interface IDpiConvertOptions : IConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Dpi { get; set; } | Desired page DPI after conversion. |

### Dpi
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/idpiconvertoptions/dpi.md

#### IDpiConvertOptions.Dpi property

Desired page DPI after conversion.

```csharp
public int Dpi { get; set; }
```

### ImageConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions.md

#### ImageConvertOptions class

Options for conversion to Image file type.

```csharp
public sealed class ImageConvertOptions : CommonConvertOptions<ImageFileType>, IUsePdfConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageConvertOptions() | Initializes new instance of `ImageConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Sets background color where supported by the source format |
| Brightness { get; set; } | Adjusts image brightness. |
| Contrast { get; set; } | Adjusts image contrast. |
| CropArea { get; set; } | Crop raster image area after conversion |
| FlipMode { get; set; } | Image flip mode. |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| Gamma { get; set; } | Adjusts image gamma. |
| Grayscale { get; set; } | Indicates whether to convert into grayscale image. |
| Height { get; set; } | Desired image height after conversion. |
| HorizontalResolution { get; set; } | Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi. |
| JpegOptions { get; set; } | Jpeg specific convert options. |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| PsdOptions { get; set; } | Psd specific convert options. |
| RotateAngle { get; set; } | Image rotation angle. |
| TiffOptions { get; set; } | Tiff specific convert options. |
| UsePdf { get; set; } | If `true`, the input firstly is converted to PDF and after that to desired format |
| VerticalResolution { get; set; } | Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi. |
| Watermark { get; set; } | Implements `Watermark` |
| WebpOptions { get; set; } | Webp specific convert options. |
| Width { get; set; } | Desired image width after conversion. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### BackgroundColor
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/backgroundcolor.md

#### ImageConvertOptions.BackgroundColor property

Sets background color where supported by the source format

```csharp
public Color? BackgroundColor { get; set; }
```

### Brightness
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/brightness.md

#### ImageConvertOptions.Brightness property

Adjusts image brightness.

```csharp
public int Brightness { get; set; }
```

### Contrast
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/contrast.md

#### ImageConvertOptions.Contrast property

Adjusts image contrast.

```csharp
public int Contrast { get; set; }
```

### CropArea
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/croparea.md

#### ImageConvertOptions.CropArea property

Crop raster image area after conversion

```csharp
public Rectangle CropArea { get; set; }
```

### FlipMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/flipmode.md

#### ImageConvertOptions.FlipMode property

Image flip mode.

```csharp
public ImageFlipModes FlipMode { get; set; }
```

### Gamma
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/gamma.md

#### ImageConvertOptions.Gamma property

Adjusts image gamma.

```csharp
public float Gamma { get; set; }
```

### Grayscale
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/grayscale.md

#### ImageConvertOptions.Grayscale property

Indicates whether to convert into grayscale image.

```csharp
public bool Grayscale { get; set; }
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/height.md

#### ImageConvertOptions.Height property

Desired image height after conversion.

```csharp
public int Height { get; set; }
```

### HorizontalResolution
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/horizontalresolution.md

#### ImageConvertOptions.HorizontalResolution property

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

```csharp
public int HorizontalResolution { get; set; }
```

### ImageConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/imageconvertoptions.md

#### ImageConvertOptions constructor

Initializes new instance of `ImageConvertOptions` class.

```csharp
public ImageConvertOptions()
```

### JpegOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/jpegoptions.md

#### ImageConvertOptions.JpegOptions property

Jpeg specific convert options.

```csharp
public JpegOptions JpegOptions { get; set; }
```

### PsdOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/psdoptions.md

#### ImageConvertOptions.PsdOptions property

Psd specific convert options.

```csharp
public PsdOptions PsdOptions { get; set; }
```

### RotateAngle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/rotateangle.md

#### ImageConvertOptions.RotateAngle property

Image rotation angle.

```csharp
public int RotateAngle { get; set; }
```

### TiffOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/tiffoptions.md

#### ImageConvertOptions.TiffOptions property

Tiff specific convert options.

```csharp
public TiffOptions TiffOptions { get; set; }
```

### UsePdf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/usepdf.md

#### ImageConvertOptions.UsePdf property

If `true`, the input firstly is converted to PDF and after that to desired format

```csharp
public bool UsePdf { get; set; }
```

### VerticalResolution
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/verticalresolution.md

#### ImageConvertOptions.VerticalResolution property

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

```csharp
public int VerticalResolution { get; set; }
```

### WebpOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/webpoptions.md

#### ImageConvertOptions.WebpOptions property

Webp specific convert options.

```csharp
public WebpOptions WebpOptions { get; set; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageconvertoptions/width.md

#### ImageConvertOptions.Width property

Desired image width after conversion.

```csharp
public int Width { get; set; }
```

### ImageFlipModes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageflipmodes.md

#### ImageFlipModes class

Describes image flip modes.

```csharp
public class ImageFlipModes : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly FlipX | Horizontal flip. |
| static readonly FlipXY | Flip horizontal and vertical. |
| static readonly FlipY | Flip vertical. |
| static readonly None | No flipping. |

### FlipX
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageflipmodes/flipx.md

#### ImageFlipModes.FlipX field

Horizontal flip.

```csharp
public static readonly ImageFlipModes FlipX;
```

### FlipXY
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageflipmodes/flipxy.md

#### ImageFlipModes.FlipXY field

Flip horizontal and vertical.

```csharp
public static readonly ImageFlipModes FlipXY;
```

### FlipY
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageflipmodes/flipy.md

#### ImageFlipModes.FlipY field

Flip vertical.

```csharp
public static readonly ImageFlipModes FlipY;
```

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imageflipmodes/none.md

#### ImageFlipModes.None field

No flipping.

```csharp
public static readonly ImageFlipModes None;
```

### IMarkdownImageSavingCallback
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imarkdownimagesavingcallback.md

#### IMarkdownImageSavingCallback interface

Handles custom processing of images while saving to Markdown. Invoked once per image; mutate `MarkdownImageSavingArgs` to control the URI embedded in the Markdown output and/or redirect where the image bytes are written.

```csharp
public interface IMarkdownImageSavingCallback
```

#### Methods

| Name | Description |
| --- | --- |
| ImageSaving(MarkdownImageSavingArgs) | Called for each image being written to the Markdown document. |

##### Examples

Scenario 1 — capture image bytes in memory and embed placeholder ids (useful when the caller wants to store images elsewhere or post-process them):

```csharp
class CaptureImagesCallback : IMarkdownImageSavingCallback
{
    private int _index;
    private readonly Dictionary<string, MemoryStream> _images;

    public CaptureImagesCallback(Dictionary<string, MemoryStream> images) => _images = images;

    public void ImageSaving(MarkdownImageSavingArgs args)
    {
        var id = $"image{_index++}";
        var buffer = new MemoryStream();
        _images[id] = buffer;
        args.ImageStream = buffer;            // redirect image bytes into our buffer
        args.ImageFileName = id;              // placeholder URI written into the .md
        args.KeepImageStreamOpen = true;      // keep buffer readable after Convert() returns
    }
}

var captured = new Dictionary<string, MemoryStream>();
try
{
    var options = new WordProcessingConvertOptions { Format = WordProcessingFileType.Md };
    options.MarkdownOptions.ImageSavingCallback = new CaptureImagesCallback(captured);

    using var converter = new Converter("source.pdf");
    converter.Convert("output.md", options);
    // captured["image0"], captured["image1"], ... now hold the image bytes
}
finally
{
    foreach (var s in captured.Values) s.Dispose();  // caller owns the streams
}
```

Scenario 2 — persist images to disk alongside the .md and reference them by file name:

```csharp
class FileImagesCallback : IMarkdownImageSavingCallback
{
    private readonly string _outputFolder;
    private int _index;

    public FileImagesCallback(string outputFolder) => _outputFolder = outputFolder;

    public void ImageSaving(MarkdownImageSavingArgs args)
    {
        var fileName = $"image{_index++}.png";
        args.ImageStream = new FileStream(Path.Combine(_outputFolder, fileName), FileMode.Create);
        args.ImageFileName = fileName;        // written into the .md as ![](image0.png)
        // KeepImageStreamOpen left at default (false) → the converter flushes and closes the file.
    }
}

var options = new WordProcessingConvertOptions { Format = WordProcessingFileType.Md };
options.MarkdownOptions.ImageSavingCallback = new FileImagesCallback("./out");

using var converter = new Converter("source.pdf");
converter.Convert("./out/output.md", options);
// ./out/image0.png, ./out/image1.png, ... are written and closed by the converter.
```

### ImageSaving
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/imarkdownimagesavingcallback/imagesaving.md

#### IMarkdownImageSavingCallback.ImageSaving method

Called for each image being written to the Markdown document.

```csharp
public void ImageSaving(MarkdownImageSavingArgs args)
```

| Parameter | Type | Description |
| --- | --- | --- |
| args | MarkdownImageSavingArgs | Mutable arguments describing the current image. |

### IPagedConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipagedconvertoptions.md

#### IPagedConvertOptions interface

Represents convert options that allows conversion to perform page limitation by specifying start page and pages count

```csharp
public interface IPagedConvertOptions : IConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| PageNumber { get; set; } | The page number to start conversion from. |
| PagesCount { get; set; } | Number of pages to convert starting from `PageNumber`. |

### PageNumber
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipagedconvertoptions/pagenumber.md

#### IPagedConvertOptions.PageNumber property

The page number to start conversion from.

```csharp
public int PageNumber { get; set; }
```

##### Remarks

default is 1

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipagedconvertoptions/pagescount.md

#### IPagedConvertOptions.PagesCount property

Number of pages to convert starting from `PageNumber`.

```csharp
public int PagesCount { get; set; }
```

### IPageRangedConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipagerangedconvertoptions.md

#### IPageRangedConvertOptions interface

Represents convert options that support conversion of specific list of pages

```csharp
public interface IPageRangedConvertOptions : IConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; set; } | The list of page indexes to be converted. Should be specified to convert specific pages. |

### Pages
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipagerangedconvertoptions/pages.md

#### IPageRangedConvertOptions.Pages property

The list of page indexes to be converted. Should be specified to convert specific pages.

```csharp
public List<int> Pages { get; set; }
```

### IPasswordConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipasswordconvertoptions.md

#### IPasswordConvertOptions interface

Represents convert options that support password protection for converted documents.

```csharp
public interface IPasswordConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | Set this property if you want to protect the converted document with a password. |

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipasswordconvertoptions/password.md

#### IPasswordConvertOptions.Password property

Set this property if you want to protect the converted document with a password.

```csharp
public string Password { get; set; }
```

### IPdfRecognitionModeOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipdfrecognitionmodeoptions.md

#### IPdfRecognitionModeOptions interface

Represents convert options that control recognition mode when converting from PDF

```csharp
public interface IPdfRecognitionModeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| PdfRecognitionMode { get; set; } | Recognition mode when converting from pdf |

### PdfRecognitionMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/ipdfrecognitionmodeoptions/pdfrecognitionmode.md

#### IPdfRecognitionModeOptions.PdfRecognitionMode property

Recognition mode when converting from pdf

```csharp
public PdfRecognitionMode PdfRecognitionMode { get; set; }
```

### IUsePdfConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/iusepdfconvertoptions.md

#### IUsePdfConvertOptions interface

Represents options that support converting to PDF if required

```csharp
public interface IUsePdfConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| UsePdf { get; set; } | If `true`, the input firstly is converted to PDF and after that to desired format |

### UsePdf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/iusepdfconvertoptions/usepdf.md

#### IUsePdfConvertOptions.UsePdf property

If `true`, the input firstly is converted to PDF and after that to desired format

```csharp
public bool UsePdf { get; set; }
```

### IWatermarkedConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/iwatermarkedconvertoptions.md

#### IWatermarkedConvertOptions interface

Represents convert options that allow output of conversion to be watermarked

```csharp
public interface IWatermarkedConvertOptions : IConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Watermark { get; set; } | Watermark specific options |

### Watermark
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/iwatermarkedconvertoptions/watermark.md

#### IWatermarkedConvertOptions.Watermark property

Watermark specific options

```csharp
public WatermarkOptions Watermark { get; set; }
```

### IZoomConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/izoomconvertoptions.md

#### IZoomConvertOptions interface

Represents convert options that allows conversion to be performed with zoom options

```csharp
public interface IZoomConvertOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Zoom { get; set; } | Specifies the zoom level in percentage. Default is 100. |

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/izoomconvertoptions/zoom.md

#### IZoomConvertOptions.Zoom property

Specifies the zoom level in percentage. Default is 100.

```csharp
public int Zoom { get; set; }
```

### JpegOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpegoptions.md

#### JpegOptions class

Options for conversion to Jpeg file type.

```csharp
public sealed class JpegOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| JpegOptions() | Initializes new instance of `JpegOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColorMode { get; set; } | Jpg color mode. |
| Compression { get; set; } | Jpg compression method. |
| Quality { get; set; } | Desired image quality. The value must be between 0 and 100. The default value is 100. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ColorMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpegoptions/colormode.md

#### JpegOptions.ColorMode property

Jpg color mode.

```csharp
public JpgColorModes ColorMode { get; set; }
```

### Compression
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpegoptions/compression.md

#### JpegOptions.Compression property

Jpg compression method.

```csharp
public JpgCompressionMethods Compression { get; set; }
```

### JpegOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpegoptions/jpegoptions.md

#### JpegOptions constructor

Initializes new instance of `JpegOptions` class.

```csharp
public JpegOptions()
```

### Quality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpegoptions/quality.md

#### JpegOptions.Quality property

Desired image quality. The value must be between 0 and 100. The default value is 100.

```csharp
public int Quality { get; set; }
```

### JpgColorModes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcolormodes.md

#### JpgColorModes class

Describes Jpg color modes enumeration.

```csharp
public class JpgColorModes : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Cmyk | CMYK. |
| static readonly Grayscale | Grayscale. |
| static readonly Rgb | RGB. |
| static readonly YCbCr | YCbCr image. Standard option for jpeg images. |
| static readonly Ycck | Ycck. |

### Cmyk
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcolormodes/cmyk.md

#### JpgColorModes.Cmyk field

CMYK.

```csharp
public static readonly JpgColorModes Cmyk;
```

### Grayscale
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcolormodes/grayscale.md

#### JpgColorModes.Grayscale field

Grayscale.

```csharp
public static readonly JpgColorModes Grayscale;
```

### Rgb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcolormodes/rgb.md

#### JpgColorModes.Rgb field

RGB.

```csharp
public static readonly JpgColorModes Rgb;
```

### YCbCr
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcolormodes/ycbcr.md

#### JpgColorModes.YCbCr field

YCbCr image. Standard option for jpeg images.

```csharp
public static readonly JpgColorModes YCbCr;
```

### Ycck
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcolormodes/ycck.md

#### JpgColorModes.Ycck field

Ycck.

```csharp
public static readonly JpgColorModes Ycck;
```

### JpgCompressionMethods
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcompressionmethods.md

#### JpgCompressionMethods class

Describes Jpg compression modes

```csharp
public class JpgCompressionMethods : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Baseline | The baseline compression. |
| static readonly JpegLs | JpegLs compression. |
| static readonly Lossless | Lossless compression. |
| static readonly Progressive | Progressive compression. |

### Baseline
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcompressionmethods/baseline.md

#### JpgCompressionMethods.Baseline field

The baseline compression.

```csharp
public static readonly JpgCompressionMethods Baseline;
```

### JpegLs
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcompressionmethods/jpegls.md

#### JpgCompressionMethods.JpegLs field

JpegLs compression.

```csharp
public static readonly JpgCompressionMethods JpegLs;
```

### Lossless
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcompressionmethods/lossless.md

#### JpgCompressionMethods.Lossless field

Lossless compression.

```csharp
public static readonly JpgCompressionMethods Lossless;
```

### Progressive
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/jpgcompressionmethods/progressive.md

#### JpgCompressionMethods.Progressive field

Progressive compression.

```csharp
public static readonly JpgCompressionMethods Progressive;
```

### MarkdownImageSavingArgs
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownimagesavingargs.md

#### MarkdownImageSavingArgs class

Arguments passed to `ImageSaving`.

```csharp
public sealed class MarkdownImageSavingArgs
```

#### Properties

| Name | Description |
| --- | --- |
| ImageFileName { get; set; } | File name (or placeholder id) embedded as the image URI in the Markdown output. Assign to rewrite the URI. |
| ImageStream { get; set; } | Destination stream the converter will write the image bytes into after this callback returns. Replace it with your own writable stream (e.g. a FileStream for disk persistence or a MemoryStream you intend to read afterwards). |
| KeepImageStreamOpen { get; set; } | When false (default), the converter closes `ImageStream` after writing — idiomatic for FileStream replacements that should be flushed to disk. Set to true to keep the stream open after conversion completes (typical for a MemoryStream you intend to read yourself); the caller then owns disposal. |

### ImageFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownimagesavingargs/imagefilename.md

#### MarkdownImageSavingArgs.ImageFileName property

File name (or placeholder id) embedded as the image URI in the Markdown output. Assign to rewrite the URI.

```csharp
public string ImageFileName { get; set; }
```

### ImageStream
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownimagesavingargs/imagestream.md

#### MarkdownImageSavingArgs.ImageStream property

Destination stream the converter will write the image bytes into after this callback returns. Replace it with your own writable stream (e.g. a FileStream for disk persistence or a MemoryStream you intend to read afterwards).

```csharp
public Stream ImageStream { get; set; }
```

### KeepImageStreamOpen
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownimagesavingargs/keepimagestreamopen.md

#### MarkdownImageSavingArgs.KeepImageStreamOpen property

When false (default), the converter closes `ImageStream` after writing — idiomatic for FileStream replacements that should be flushed to disk. Set to true to keep the stream open after conversion completes (typical for a MemoryStream you intend to read yourself); the caller then owns disposal.

```csharp
public bool KeepImageStreamOpen { get; set; }
```

### MarkdownOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownoptions.md

#### MarkdownOptions class

Options for conversion to markdown file type.

```csharp
public sealed class MarkdownOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| MarkdownOptions() | Initializes new instance of `MarkdownOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ExportImagesAsBase64 { get; set; } | Export images as base64. Default is true. Ignored when `ImageSavingCallback` is set. |
| ImageSavingCallback { get; set; } | Callback invoked once per image while saving Markdown. Lets the caller persist images externally and substitute the URI embedded in the document. Takes precedence over `ExportImagesAsBase64` when not null. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ExportImagesAsBase64
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownoptions/exportimagesasbase64.md

#### MarkdownOptions.ExportImagesAsBase64 property

Export images as base64. Default is true. Ignored when `ImageSavingCallback` is set.

```csharp
public bool ExportImagesAsBase64 { get; set; }
```

### ImageSavingCallback
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownoptions/imagesavingcallback.md

#### MarkdownOptions.ImageSavingCallback property

Callback invoked once per image while saving Markdown. Lets the caller persist images externally and substitute the URI embedded in the document. Takes precedence over `ExportImagesAsBase64` when not null.

```csharp
public IMarkdownImageSavingCallback ImageSavingCallback { get; set; }
```

### MarkdownOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/markdownoptions/markdownoptions.md

#### MarkdownOptions constructor

Initializes new instance of `MarkdownOptions` class.

```csharp
public MarkdownOptions()
```

### NoConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/noconvertoptions.md

#### NoConvertOptions class

Special convert option class, which instructs converter to copy source document without any processing

```csharp
public sealed class NoConvertOptions : ConvertOptions<FileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| NoConvertOptions() | Initializes a new instance of the `NoConvertOptions` class with the default format. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### NoConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/noconvertoptions/noconvertoptions.md

#### NoConvertOptions constructor

Initializes a new instance of the `NoConvertOptions` class with the default format.

```csharp
public NoConvertOptions()
```

### PageDescriptionLanguageConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions.md

#### PageDescriptionLanguageConvertOptions class

Options for conversion to page descriptions language file type.

```csharp
public class PageDescriptionLanguageConvertOptions : 
    CommonConvertOptions<PageDescriptionLanguageFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| PageDescriptionLanguageConvertOptions() | Initializes a new instance of the `PageDescriptionLanguageConvertOptions`. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| Height { get; set; } | Desired page height after conversion. |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Watermark { get; set; } | Implements `Watermark` |
| Width { get; set; } | Desired page width after conversion. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/height.md

#### PageDescriptionLanguageConvertOptions.Height property

Desired page height after conversion.

```csharp
public int Height { get; set; }
```

### PageDescriptionLanguageConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/pagedescriptionlanguageconvertoptions.md

#### PageDescriptionLanguageConvertOptions constructor

Initializes a new instance of the `PageDescriptionLanguageConvertOptions`.

```csharp
public PageDescriptionLanguageConvertOptions()
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/width.md

#### PageDescriptionLanguageConvertOptions.Width property

Desired page width after conversion.

```csharp
public int Width { get; set; }
```

### PageOrientation
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageorientation.md

#### PageOrientation class

Specifies page orientation

```csharp
public sealed class PageOrientation : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static Default | Default page orientation e.g. as is in source document |
| static Landscape | Landscape page orientation (wide and short). |
| static Portrait | Portrait page orientation (narrow and tall). |

### Default
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageorientation/default.md

#### PageOrientation.Default field

Default page orientation e.g. as is in source document

```csharp
public static PageOrientation Default;
```

### Landscape
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageorientation/landscape.md

#### PageOrientation.Landscape field

Landscape page orientation (wide and short).

```csharp
public static PageOrientation Landscape;
```

### Portrait
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageorientation/portrait.md

#### PageOrientation.Portrait field

Portrait page orientation (narrow and tall).

```csharp
public static PageOrientation Portrait;
```

### PageResizeMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageresizemode.md

#### PageResizeMode class

Specifies how content should be scaled when page size is changed

```csharp
public sealed class PageResizeMode : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static AlignTopLeft | No scaling applied. Content is aligned to top-left corner. |
| static ScaleToFill | Stretch content to fill entire page. May distort aspect ratio. |
| static ScaleToFit | Scale content proportionally to fit entire page without overflow. May result in white space. |
| static ScaleToHeight | Scale content proportionally to match page height. Width may overflow and be cropped. |
| static ScaleToWidth | Scale content proportionally to match page width. Height may overflow and be cropped. |

### AlignTopLeft
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageresizemode/aligntopleft.md

#### PageResizeMode.AlignTopLeft field

No scaling applied. Content is aligned to top-left corner.

```csharp
public static PageResizeMode AlignTopLeft;
```

### ScaleToFill
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageresizemode/scaletofill.md

#### PageResizeMode.ScaleToFill field

Stretch content to fill entire page. May distort aspect ratio.

```csharp
public static PageResizeMode ScaleToFill;
```

### ScaleToFit
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageresizemode/scaletofit.md

#### PageResizeMode.ScaleToFit field

Scale content proportionally to fit entire page without overflow. May result in white space.

```csharp
public static PageResizeMode ScaleToFit;
```

### ScaleToHeight
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageresizemode/scaletoheight.md

#### PageResizeMode.ScaleToHeight field

Scale content proportionally to match page height. Width may overflow and be cropped.

```csharp
public static PageResizeMode ScaleToHeight;
```

### ScaleToWidth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pageresizemode/scaletowidth.md

#### PageResizeMode.ScaleToWidth field

Scale content proportionally to match page width. Height may overflow and be cropped.

```csharp
public static PageResizeMode ScaleToWidth;
```

### PdfConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions.md

#### PdfConvertOptions class

Options for conversion to Pdf file type.

```csharp
public class PdfConvertOptions : CommonConvertOptions<PdfFileType>, IDpiConvertOptions, 
    IPageMarginOptions, IPageOrientationOptions, IPageSizeOptions, IPasswordConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfConvertOptions() | Initializes new instance of `PdfConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Dpi { get; set; } | Desired page DPI after conversion. The default resolution is: 96 dpi. |
| EmbedFullFonts { get; set; } | When set to true, the full font file is embedded into the PDF instead of a subset. This increases the output file size but ensures better compatibility when editing the resulting PDF. Applies only when converting from WordProcessing documents. |
| FallbackPageSize { get; set; } | Fallback page size |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| MarginSettings { get; set; } | Page margin settings |
| OrientationSettings { get; set; } | Page orientation settings |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Password { get; set; } | Set this property if you want to protect the converted document with a password. |
| PdfOptions { get; set; } | Pdf specific convert options |
| ResizeMode { get; set; } | Specifies how content should be scaled when page size is changed. Default is AlignTopLeft (no scaling). |
| Rotate { get; set; } | Page rotation |
| SizeSettings { get; set; } | Page size settings |
| Watermark { get; set; } | Implements `Watermark` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Dpi
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/dpi.md

#### PdfConvertOptions.Dpi property

Desired page DPI after conversion. The default resolution is: 96 dpi.

```csharp
public int Dpi { get; set; }
```

### EmbedFullFonts
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/embedfullfonts.md

#### PdfConvertOptions.EmbedFullFonts property

When set to true, the full font file is embedded into the PDF instead of a subset. This increases the output file size but ensures better compatibility when editing the resulting PDF. Applies only when converting from WordProcessing documents.

```csharp
public bool EmbedFullFonts { get; set; }
```

### FallbackPageSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/fallbackpagesize.md

#### PdfConvertOptions.FallbackPageSize property

Fallback page size

```csharp
public PageSize FallbackPageSize { get; set; }
```

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/marginsettings.md

#### PdfConvertOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### OrientationSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/orientationsettings.md

#### PdfConvertOptions.OrientationSettings property

Page orientation settings

```csharp
public PageOrientation OrientationSettings { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/password.md

#### PdfConvertOptions.Password property

Set this property if you want to protect the converted document with a password.

```csharp
public string Password { get; set; }
```

### PdfConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/pdfconvertoptions.md

#### PdfConvertOptions constructor

Initializes new instance of `PdfConvertOptions` class.

```csharp
public PdfConvertOptions()
```

### PdfOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/pdfoptions.md

#### PdfConvertOptions.PdfOptions property

Pdf specific convert options

```csharp
public PdfOptions PdfOptions { get; set; }
```

### ResizeMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/resizemode.md

#### PdfConvertOptions.ResizeMode property

Specifies how content should be scaled when page size is changed. Default is AlignTopLeft (no scaling).

```csharp
public PageResizeMode ResizeMode { get; set; }
```

### Rotate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/rotate.md

#### PdfConvertOptions.Rotate property

Page rotation

```csharp
public Rotation Rotate { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfconvertoptions/sizesettings.md

#### PdfConvertOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### PdfDirection
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdirection.md

#### PdfDirection class

Describes Pdf text direction.

```csharp
public class PdfDirection : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly L2R | Left to right. |
| static readonly R2L | Right to left. |

### L2R
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdirection/l2r.md

#### PdfDirection.L2R field

Left to right.

```csharp
public static readonly PdfDirection L2R;
```

### R2L
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdirection/r2l.md

#### PdfDirection.R2L field

Right to left.

```csharp
public static readonly PdfDirection R2L;
```

### PdfDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo.md

#### PdfDocumentInfo class

Represents meta information of PDF document.

```csharp
public sealed class PdfDocumentInfo : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfDocumentInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets document author. |
| CreationDate { get; set; } | Gets or sets the date of document creation. |
| CreationTimeZone { get; set; } | Time zone of creation date |
| Creator { get; set; } | Gets or sets document creator. |
| Keywords { get; set; } | Gets or set the keywords of the document. |
| ModDate { get; set; } | Gets or sets the date of document modification. |
| ModTimeZone { get; set; } | Time zone of modification date. |
| Producer { get; set; } | Gets or sets the document producer. |
| Subject { get; set; } | Gets or sets the subject of the document. |
| Title { get; set; } | Gets or sets document title. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Author
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/author.md

#### PdfDocumentInfo.Author property

Gets or sets document author.

```csharp
public string Author { get; set; }
```

### CreationDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/creationdate.md

#### PdfDocumentInfo.CreationDate property

Gets or sets the date of document creation.

```csharp
public DateTime? CreationDate { get; set; }
```

### CreationTimeZone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/creationtimezone.md

#### PdfDocumentInfo.CreationTimeZone property

Time zone of creation date

```csharp
public TimeSpan? CreationTimeZone { get; set; }
```

### Creator
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/creator.md

#### PdfDocumentInfo.Creator property

Gets or sets document creator.

```csharp
public string Creator { get; set; }
```

### Keywords
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/keywords.md

#### PdfDocumentInfo.Keywords property

Gets or set the keywords of the document.

```csharp
public string Keywords { get; set; }
```

### ModDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/moddate.md

#### PdfDocumentInfo.ModDate property

Gets or sets the date of document modification.

```csharp
public DateTime? ModDate { get; set; }
```

### ModTimeZone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/modtimezone.md

#### PdfDocumentInfo.ModTimeZone property

Time zone of modification date.

```csharp
public TimeSpan? ModTimeZone { get; set; }
```

### PdfDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/pdfdocumentinfo.md

#### PdfDocumentInfo constructor

The default constructor.

```csharp
public PdfDocumentInfo()
```

### Producer
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/producer.md

#### PdfDocumentInfo.Producer property

Gets or sets the document producer.

```csharp
public string Producer { get; set; }
```

### Subject
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/subject.md

#### PdfDocumentInfo.Subject property

Gets or sets the subject of the document.

```csharp
public string Subject { get; set; }
```

### Title
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfdocumentinfo/title.md

#### PdfDocumentInfo.Title property

Gets or sets document title.

```csharp
public string Title { get; set; }
```

### PdfFontSubsetStrategy
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdffontsubsetstrategy.md

#### PdfFontSubsetStrategy class

Specifies font subsetting strategy

```csharp
public sealed class PdfFontSubsetStrategy : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly None | Do not subset fonts |
| static readonly SubsetAllFonts | Subset all fonts, used in a document. |
| static readonly SubsetEmbeddedFontsOnly | Portrait page orientation (narrow and tall). |

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/none.md

#### PdfFontSubsetStrategy.None field

Do not subset fonts

```csharp
public static readonly PdfFontSubsetStrategy None;
```

### SubsetAllFonts
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/subsetallfonts.md

#### PdfFontSubsetStrategy.SubsetAllFonts field

Subset all fonts, used in a document.

```csharp
public static readonly PdfFontSubsetStrategy SubsetAllFonts;
```

### SubsetEmbeddedFontsOnly
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/subsetembeddedfontsonly.md

#### PdfFontSubsetStrategy.SubsetEmbeddedFontsOnly field

Portrait page orientation (narrow and tall).

```csharp
public static readonly PdfFontSubsetStrategy SubsetEmbeddedFontsOnly;
```

### PdfFormats
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats.md

#### PdfFormats class

Describes Pdf formats enumeration.

```csharp
public sealed class PdfFormats : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Default | Default pdf format |
| static readonly PdfA_1A | PDF/A-1a – Level A (accessible) conformance. |
| static readonly PdfA_1B | PDF/A-1b – Level B (basic) conformance. |
| static readonly PdfA_2A | PDF/A-2a conformance. |
| static readonly PdfA_2B | PDF/A-2b conformance. |
| static readonly PdfA_2U | PDF/A-2u conformance. |
| static readonly PdfA_3A | PDF/A-3a conformance. |
| static readonly PdfA_3B | PDF/A-3b conformance. |
| static readonly PdfA_3U | PDF/A-3u conformance. |
| static readonly PdfA_4 | PDF/A-4 conformance. |
| static readonly PdfA_4E | PDF/A-4E conformance. |
| static readonly PdfA_4F | PDF/A-4F conformance. |
| static readonly PdfUA_1 | PDF/UA-1 conformance. |
| static readonly PdfX_1A | PDF/X-1a conformance. |
| static readonly PdfX_3 | PDF/X-3 conformance. |
| static readonly v1_3 | PDF version 1.3. |
| static readonly v1_4 | PDF version 1.4. |
| static readonly v1_5 | PDF version 1.5. |
| static readonly v1_6 | PDF version 1.6. |
| static readonly v1_7 | PDF version 1.7. |

### Default
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/default.md

#### PdfFormats.Default field

Default pdf format

```csharp
public static readonly PdfFormats Default;
```

### PdfA_1A
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_1a.md

#### PdfFormats.PdfA_1A field

PDF/A-1a – Level A (accessible) conformance.

```csharp
public static readonly PdfFormats PdfA_1A;
```

### PdfA_1B
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_1b.md

#### PdfFormats.PdfA_1B field

PDF/A-1b – Level B (basic) conformance.

```csharp
public static readonly PdfFormats PdfA_1B;
```

### PdfA_2A
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_2a.md

#### PdfFormats.PdfA_2A field

PDF/A-2a conformance.

```csharp
public static readonly PdfFormats PdfA_2A;
```

### PdfA_2B
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_2b.md

#### PdfFormats.PdfA_2B field

PDF/A-2b conformance.

```csharp
public static readonly PdfFormats PdfA_2B;
```

### PdfA_2U
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_2u.md

#### PdfFormats.PdfA_2U field

PDF/A-2u conformance.

```csharp
public static readonly PdfFormats PdfA_2U;
```

### PdfA_3A
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_3a.md

#### PdfFormats.PdfA_3A field

PDF/A-3a conformance.

```csharp
public static readonly PdfFormats PdfA_3A;
```

### PdfA_3B
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_3b.md

#### PdfFormats.PdfA_3B field

PDF/A-3b conformance.

```csharp
public static readonly PdfFormats PdfA_3B;
```

### PdfA_3U
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_3u.md

#### PdfFormats.PdfA_3U field

PDF/A-3u conformance.

```csharp
public static readonly PdfFormats PdfA_3U;
```

### PdfA_4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_4.md

#### PdfFormats.PdfA_4 field

PDF/A-4 conformance.

```csharp
public static readonly PdfFormats PdfA_4;
```

### PdfA_4E
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_4e.md

#### PdfFormats.PdfA_4E field

PDF/A-4E conformance.

```csharp
public static readonly PdfFormats PdfA_4E;
```

### PdfA_4F
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfa_4f.md

#### PdfFormats.PdfA_4F field

PDF/A-4F conformance.

```csharp
public static readonly PdfFormats PdfA_4F;
```

### PdfUA_1
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfua_1.md

#### PdfFormats.PdfUA_1 field

PDF/UA-1 conformance.

```csharp
public static readonly PdfFormats PdfUA_1;
```

### PdfX_1A
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfx_1a.md

#### PdfFormats.PdfX_1A field

PDF/X-1a conformance.

```csharp
public static readonly PdfFormats PdfX_1A;
```

### PdfX_3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/pdfx_3.md

#### PdfFormats.PdfX_3 field

PDF/X-3 conformance.

```csharp
public static readonly PdfFormats PdfX_3;
```

### v1_3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/v1_3.md

#### PdfFormats.v1_3 field

PDF version 1.3.

```csharp
public static readonly PdfFormats v1_3;
```

### v1_4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/v1_4.md

#### PdfFormats.v1_4 field

PDF version 1.4.

```csharp
public static readonly PdfFormats v1_4;
```

### v1_5
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/v1_5.md

#### PdfFormats.v1_5 field

PDF version 1.5.

```csharp
public static readonly PdfFormats v1_5;
```

### v1_6
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/v1_6.md

#### PdfFormats.v1_6 field

PDF version 1.6.

```csharp
public static readonly PdfFormats v1_6;
```

### v1_7
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformats/v1_7.md

#### PdfFormats.v1_7 field

PDF version 1.7.

```csharp
public static readonly PdfFormats v1_7;
```

### PdfFormattingOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions.md

#### PdfFormattingOptions class

Defines Pdf formatting options.

```csharp
public sealed class PdfFormattingOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfFormattingOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| CenterWindow { get; set; } | Specifies whether position of the document's window will be centered on the screen. Default: false. |
| Direction { get; set; } | Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R. |
| DisplayDocTitle { get; set; } | Specifies whether document's window title bar should display document title. Default: false. |
| FitWindow { get; set; } | Specifies whether document window must be resized to fit the first displayed page. Default: false. |
| HideMenuBar { get; set; } | Specifies whether menu bar should be hidden when document is active. Default: false. |
| HideToolBar { get; set; } | Specifies whether toolbar should be hidden when document is active. Default: false. |
| HideWindowUI { get; set; } | Specifies whether user interface elements should be hidden when document is active. Default: false. |
| NonFullScreenPageMode { get; set; } | Sets page mode, specifying how to display the document on exiting full-screen mode. |
| PageLayout { get; set; } | Sets page layout which shall be used when the document is opened. |
| PageMode { get; set; } | Sets page mode, specifying how document should be displayed when opened. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### CenterWindow
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/centerwindow.md

#### PdfFormattingOptions.CenterWindow property

Specifies whether position of the document's window will be centered on the screen. Default: false.

```csharp
public bool CenterWindow { get; set; }
```

### Direction
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/direction.md

#### PdfFormattingOptions.Direction property

Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.

```csharp
public PdfDirection Direction { get; set; }
```

### DisplayDocTitle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/displaydoctitle.md

#### PdfFormattingOptions.DisplayDocTitle property

Specifies whether document's window title bar should display document title. Default: false.

```csharp
public bool DisplayDocTitle { get; set; }
```

### FitWindow
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/fitwindow.md

#### PdfFormattingOptions.FitWindow property

Specifies whether document window must be resized to fit the first displayed page. Default: false.

```csharp
public bool FitWindow { get; set; }
```

### HideMenuBar
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/hidemenubar.md

#### PdfFormattingOptions.HideMenuBar property

Specifies whether menu bar should be hidden when document is active. Default: false.

```csharp
public bool HideMenuBar { get; set; }
```

### HideToolBar
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/hidetoolbar.md

#### PdfFormattingOptions.HideToolBar property

Specifies whether toolbar should be hidden when document is active. Default: false.

```csharp
public bool HideToolBar { get; set; }
```

### HideWindowUI
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/hidewindowui.md

#### PdfFormattingOptions.HideWindowUI property

Specifies whether user interface elements should be hidden when document is active. Default: false.

```csharp
public bool HideWindowUI { get; set; }
```

### NonFullScreenPageMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/nonfullscreenpagemode.md

#### PdfFormattingOptions.NonFullScreenPageMode property

Sets page mode, specifying how to display the document on exiting full-screen mode.

```csharp
public PdfPageMode NonFullScreenPageMode { get; set; }
```

### PageLayout
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/pagelayout.md

#### PdfFormattingOptions.PageLayout property

Sets page layout which shall be used when the document is opened.

```csharp
public PdfPageLayout PageLayout { get; set; }
```

### PageMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/pagemode.md

#### PdfFormattingOptions.PageMode property

Sets page mode, specifying how document should be displayed when opened.

```csharp
public PdfPageMode PageMode { get; set; }
```

### PdfFormattingOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfformattingoptions/pdfformattingoptions.md

#### PdfFormattingOptions constructor

The default constructor.

```csharp
public PdfFormattingOptions()
```

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions.md

#### PdfOptimizationOptions class

Defines Pdf optimization options.

```csharp
public sealed class PdfOptimizationOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfOptimizationOptions() | Initializes new instance of `PdfOptimizationOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CompressImages { get; set; } | If CompressImages set to `true`, all images in the document are re-compressed. The compression is defined by the ImageQuality property. |
| FontSubsetStrategy { get; set; } | Set font subset strategy |
| ImageQuality { get; set; } | Value in percent where 100% is unchanged quality and image size. To decrease the image size set this property to less than 100 |
| LinkDuplicateStreams { get; set; } | Link duplicate streams |
| RemoveUnusedObjects { get; set; } | Remove unused objects |
| RemoveUnusedStreams { get; set; } | Remove unused streams |
| UnembedFonts { get; set; } | Make fonts not embedded if set to true |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### CompressImages
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/compressimages.md

#### PdfOptimizationOptions.CompressImages property

If CompressImages set to `true`, all images in the document are re-compressed. The compression is defined by the ImageQuality property.

```csharp
public bool CompressImages { get; set; }
```

### FontSubsetStrategy
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/fontsubsetstrategy.md

#### PdfOptimizationOptions.FontSubsetStrategy property

Set font subset strategy

```csharp
public PdfFontSubsetStrategy FontSubsetStrategy { get; set; }
```

### ImageQuality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/imagequality.md

#### PdfOptimizationOptions.ImageQuality property

Value in percent where 100% is unchanged quality and image size. To decrease the image size set this property to less than 100

```csharp
public int ImageQuality { get; set; }
```

### LinkDuplicateStreams
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/linkduplicatestreams.md

#### PdfOptimizationOptions.LinkDuplicateStreams property

Link duplicate streams

```csharp
public bool LinkDuplicateStreams { get; set; }
```

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/pdfoptimizationoptions.md

#### PdfOptimizationOptions constructor

Initializes new instance of `PdfOptimizationOptions` class.

```csharp
public PdfOptimizationOptions()
```

### RemoveUnusedObjects
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/removeunusedobjects.md

#### PdfOptimizationOptions.RemoveUnusedObjects property

Remove unused objects

```csharp
public bool RemoveUnusedObjects { get; set; }
```

### RemoveUnusedStreams
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/removeunusedstreams.md

#### PdfOptimizationOptions.RemoveUnusedStreams property

Remove unused streams

```csharp
public bool RemoveUnusedStreams { get; set; }
```

### UnembedFonts
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptimizationoptions/unembedfonts.md

#### PdfOptimizationOptions.UnembedFonts property

Make fonts not embedded if set to true

```csharp
public bool UnembedFonts { get; set; }
```

### PdfOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions.md

#### PdfOptions class

Options for conversion to Pdf file type.

```csharp
public sealed class PdfOptions : ValueObject, IZoomConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfOptions() | Initializes a new instance of the `PdfOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DocumentInfo { get; set; } | Meta information of PDF document. |
| FormattingOptions { get; set; } | Pdf formatting options |
| Grayscale { get; set; } | Convert a PDF from RGB colorspace to grayscale |
| Linearize { get; set; } | Linearizes PDF Document for the Web |
| OptimizationOptions { get; set; } | Pdf optimization options |
| PdfFormat { get; set; } | Sets the pdf format of the converted document. |
| RemovePdfACompliance { get; set; } | Removes Pdf-A Compliance |
| Zoom { get; set; } | Specifies the zoom level in percentage. Default is 100. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### DocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/documentinfo.md

#### PdfOptions.DocumentInfo property

Meta information of PDF document.

```csharp
public PdfDocumentInfo DocumentInfo { get; set; }
```

### FormattingOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/formattingoptions.md

#### PdfOptions.FormattingOptions property

Pdf formatting options

```csharp
public PdfFormattingOptions FormattingOptions { get; set; }
```

### Grayscale
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/grayscale.md

#### PdfOptions.Grayscale property

Convert a PDF from RGB colorspace to grayscale

```csharp
public bool Grayscale { get; set; }
```

### Linearize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/linearize.md

#### PdfOptions.Linearize property

Linearizes PDF Document for the Web

```csharp
public bool Linearize { get; set; }
```

### OptimizationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/optimizationoptions.md

#### PdfOptions.OptimizationOptions property

Pdf optimization options

```csharp
public PdfOptimizationOptions OptimizationOptions { get; set; }
```

### PdfFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/pdfformat.md

#### PdfOptions.PdfFormat property

Sets the pdf format of the converted document.

```csharp
public PdfFormats PdfFormat { get; set; }
```

### PdfOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/pdfoptions.md

#### PdfOptions constructor

Initializes a new instance of the `PdfOptions` class.

```csharp
public PdfOptions()
```

### RemovePdfACompliance
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/removepdfacompliance.md

#### PdfOptions.RemovePdfACompliance property

Removes Pdf-A Compliance

```csharp
public bool RemovePdfACompliance { get; set; }
```

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfoptions/zoom.md

#### PdfOptions.Zoom property

Specifies the zoom level in percentage. Default is 100.

```csharp
public int Zoom { get; set; }
```

### PdfPageLayout
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout.md

#### PdfPageLayout class

Describes Pdf page layout.

```csharp
public class PdfPageLayout : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Default | Default layout. |
| static readonly OneColumn | Display pages in one column. |
| static readonly SinglePage | Single page. |
| static readonly TwoColumnLeft | Display the pages in two columns, with odd-numbered pages on the left. |
| static readonly TwoColumnRight | Display the pages in two columns, with odd-numbered pages on the right. |
| static readonly TwoPagesLeft | Display the pages two at a time, with odd-numbered pages on the left. |
| static readonly TwoPagesRight | Display the pages two at a time, with odd-numbered pages on the right. |

### Default
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/default.md

#### PdfPageLayout.Default field

Default layout.

```csharp
public static readonly PdfPageLayout Default;
```

### OneColumn
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/onecolumn.md

#### PdfPageLayout.OneColumn field

Display pages in one column.

```csharp
public static readonly PdfPageLayout OneColumn;
```

### SinglePage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/singlepage.md

#### PdfPageLayout.SinglePage field

Single page.

```csharp
public static readonly PdfPageLayout SinglePage;
```

### TwoColumnLeft
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/twocolumnleft.md

#### PdfPageLayout.TwoColumnLeft field

Display the pages in two columns, with odd-numbered pages on the left.

```csharp
public static readonly PdfPageLayout TwoColumnLeft;
```

### TwoColumnRight
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/twocolumnright.md

#### PdfPageLayout.TwoColumnRight field

Display the pages in two columns, with odd-numbered pages on the right.

```csharp
public static readonly PdfPageLayout TwoColumnRight;
```

### TwoPagesLeft
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/twopagesleft.md

#### PdfPageLayout.TwoPagesLeft field

Display the pages two at a time, with odd-numbered pages on the left.

```csharp
public static readonly PdfPageLayout TwoPagesLeft;
```

### TwoPagesRight
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagelayout/twopagesright.md

#### PdfPageLayout.TwoPagesRight field

Display the pages two at a time, with odd-numbered pages on the right.

```csharp
public static readonly PdfPageLayout TwoPagesRight;
```

### PdfPageMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode.md

#### PdfPageMode class

Describes Pdf page mode

```csharp
public class PdfPageMode : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly FullScreen | FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible. |
| static readonly UseAttachments | Attachments panel visible. |
| static readonly UseNone | Don't use any components. |
| static readonly UseOC | Optional content group panel visible. |
| static readonly UseOutlines | Document outline visible. |
| static readonly UseThumbs | Thumbnail images visible. |

### FullScreen
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode/fullscreen.md

#### PdfPageMode.FullScreen field

FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.

```csharp
public static readonly PdfPageMode FullScreen;
```

### UseAttachments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode/useattachments.md

#### PdfPageMode.UseAttachments field

Attachments panel visible.

```csharp
public static readonly PdfPageMode UseAttachments;
```

### UseNone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode/usenone.md

#### PdfPageMode.UseNone field

Don't use any components.

```csharp
public static readonly PdfPageMode UseNone;
```

### UseOC
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode/useoc.md

#### PdfPageMode.UseOC field

Optional content group panel visible.

```csharp
public static readonly PdfPageMode UseOC;
```

### UseOutlines
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode/useoutlines.md

#### PdfPageMode.UseOutlines field

Document outline visible.

```csharp
public static readonly PdfPageMode UseOutlines;
```

### UseThumbs
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfpagemode/usethumbs.md

#### PdfPageMode.UseThumbs field

Thumbnail images visible.

```csharp
public static readonly PdfPageMode UseThumbs;
```

### PdfRecognitionMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfrecognitionmode.md

#### PdfRecognitionMode class

Allows to control how a PDF document is converted into a word processing document.

```csharp
public sealed class PdfRecognitionMode : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Flow | Full recognition mode, the engine performs grouping and multi-level analysis to restore the original document author's intent and produce a maximally editable document. The downside is that the output document might look different from the original PDF file. |
| static readonly Textbox | This mode is fast and good for maximally preserving original look of the PDF file, but editability of the resulting document could be limited. Every visually grouped block of text int the original PDF file is converted into a textbox in the resulting document. This achieves maximal resemblance of the output document to the original PDF file. The output document will look good, but it will consist entirely of textboxes and it could makes further editing of the document in Microsoft Word quite hard. This is the default mode. |

### Flow
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfrecognitionmode/flow.md

#### PdfRecognitionMode.Flow field

Full recognition mode, the engine performs grouping and multi-level analysis to restore the original document author's intent and produce a maximally editable document. The downside is that the output document might look different from the original PDF file.

```csharp
public static readonly PdfRecognitionMode Flow;
```

### Textbox
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/pdfrecognitionmode/textbox.md

#### PdfRecognitionMode.Textbox field

This mode is fast and good for maximally preserving original look of the PDF file, but editability of the resulting document could be limited. Every visually grouped block of text int the original PDF file is converted into a textbox in the resulting document. This achieves maximal resemblance of the output document to the original PDF file. The output document will look good, but it will consist entirely of textboxes and it could makes further editing of the document in Microsoft Word quite hard. This is the default mode.

```csharp
public static readonly PdfRecognitionMode Textbox;
```

### PresentationConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/presentationconvertoptions.md

#### PresentationConvertOptions class

Describes options for conversion to Presentation file type.

```csharp
public class PresentationConvertOptions : CommonConvertOptions<PresentationFileType>, 
    IPasswordConvertOptions, IZoomConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationConvertOptions() | Initializes new instance of `PresentationConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Password { get; set; } | Set this property if you want to protect the converted document with a password. |
| Watermark { get; set; } | Implements `Watermark` |
| Zoom { get; set; } | Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/presentationconvertoptions/password.md

#### PresentationConvertOptions.Password property

Set this property if you want to protect the converted document with a password.

```csharp
public string Password { get; set; }
```

### PresentationConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/presentationconvertoptions/presentationconvertoptions.md

#### PresentationConvertOptions constructor

Initializes new instance of `PresentationConvertOptions` class.

```csharp
public PresentationConvertOptions()
```

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/presentationconvertoptions/zoom.md

#### PresentationConvertOptions.Zoom property

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

```csharp
public int Zoom { get; set; }
```

### ProjectManagementConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/projectmanagementconvertoptions.md

#### ProjectManagementConvertOptions class

Options for conversion to Project management file type.

```csharp
public class ProjectManagementConvertOptions : ConvertOptions<ProjectManagementFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| ProjectManagementConvertOptions() | Initializes new instance of `ProjectManagementConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ProjectManagementConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/projectmanagementconvertoptions/projectmanagementconvertoptions.md

#### ProjectManagementConvertOptions constructor

Initializes new instance of `ProjectManagementConvertOptions` class.

```csharp
public ProjectManagementConvertOptions()
```

### PsdColorModes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes.md

#### PsdColorModes class

Defines Psd color modes enumeration.

```csharp
public class PsdColorModes : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Bitmap | Bitmap. |
| static readonly Cmyk | CMYK. |
| static readonly Duotone | Duotone. |
| static readonly Grayscale | Grayscale. |
| static readonly Indexed | Indexed. |
| static readonly Lab | Lab. |
| static readonly Multichannel | Multichannel. |
| static readonly Rgb | RGB. |

### Bitmap
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/bitmap.md

#### PsdColorModes.Bitmap field

Bitmap.

```csharp
public static readonly PsdColorModes Bitmap;
```

### Cmyk
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/cmyk.md

#### PsdColorModes.Cmyk field

CMYK.

```csharp
public static readonly PsdColorModes Cmyk;
```

### Duotone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/duotone.md

#### PsdColorModes.Duotone field

Duotone.

```csharp
public static readonly PsdColorModes Duotone;
```

### Grayscale
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/grayscale.md

#### PsdColorModes.Grayscale field

Grayscale.

```csharp
public static readonly PsdColorModes Grayscale;
```

### Indexed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/indexed.md

#### PsdColorModes.Indexed field

Indexed.

```csharp
public static readonly PsdColorModes Indexed;
```

### Lab
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/lab.md

#### PsdColorModes.Lab field

Lab.

```csharp
public static readonly PsdColorModes Lab;
```

### Multichannel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/multichannel.md

#### PsdColorModes.Multichannel field

Multichannel.

```csharp
public static readonly PsdColorModes Multichannel;
```

### Rgb
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcolormodes/rgb.md

#### PsdColorModes.Rgb field

RGB.

```csharp
public static readonly PsdColorModes Rgb;
```

### PsdCompressionMethods
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcompressionmethods.md

#### PsdCompressionMethods class

Describes Psd compression methods.

```csharp
public class PsdCompressionMethods : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Raw | RAW. |
| static readonly Rle | RLE. |
| static readonly ZipWithoutPrediction | ZipWithoutPrediction. |
| static readonly ZipWithPrediction | ZipWithPrediction. |

### Raw
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcompressionmethods/raw.md

#### PsdCompressionMethods.Raw field

RAW.

```csharp
public static readonly PsdCompressionMethods Raw;
```

### Rle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcompressionmethods/rle.md

#### PsdCompressionMethods.Rle field

RLE.

```csharp
public static readonly PsdCompressionMethods Rle;
```

### ZipWithoutPrediction
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcompressionmethods/zipwithoutprediction.md

#### PsdCompressionMethods.ZipWithoutPrediction field

ZipWithoutPrediction.

```csharp
public static readonly PsdCompressionMethods ZipWithoutPrediction;
```

### ZipWithPrediction
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdcompressionmethods/zipwithprediction.md

#### PsdCompressionMethods.ZipWithPrediction field

ZipWithPrediction.

```csharp
public static readonly PsdCompressionMethods ZipWithPrediction;
```

### PsdOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions.md

#### PsdOptions class

Options for converting to Psd file type.

```csharp
public sealed class PsdOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| PsdOptions() | Initializes new instance of `PsdOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ChannelBitsCount { get; set; } | Bits count per color channel. |
| ChannelsCount { get; set; } | Color channels count. |
| ColorMode { get; set; } | Psd color mode. |
| Compression { get; set; } | Psd compression method. |
| Version { get; set; } | Psd file version. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ChannelBitsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions/channelbitscount.md

#### PsdOptions.ChannelBitsCount property

Bits count per color channel.

```csharp
public short ChannelBitsCount { get; set; }
```

### ChannelsCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions/channelscount.md

#### PsdOptions.ChannelsCount property

Color channels count.

```csharp
public short ChannelsCount { get; set; }
```

### ColorMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions/colormode.md

#### PsdOptions.ColorMode property

Psd color mode.

```csharp
public PsdColorModes ColorMode { get; set; }
```

### Compression
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions/compression.md

#### PsdOptions.Compression property

Psd compression method.

```csharp
public PsdCompressionMethods Compression { get; set; }
```

### PsdOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions/psdoptions.md

#### PsdOptions constructor

Initializes new instance of `PsdOptions` class.

```csharp
public PsdOptions()
```

### Version
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/psdoptions/version.md

#### PsdOptions.Version property

Psd file version.

```csharp
public int Version { get; set; }
```

### Rotation
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rotation.md

#### Rotation class

Describes page rotation enumeration

```csharp
public class Rotation : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly None | None. |
| static readonly On180 | 180 degrees. |
| static readonly On270 | 270 degrees. |
| static readonly On90 | 90 degrees. |

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rotation/none.md

#### Rotation.None field

None.

```csharp
public static readonly Rotation None;
```

### On180
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rotation/on180.md

#### Rotation.On180 field

180 degrees.

```csharp
public static readonly Rotation On180;
```

### On270
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rotation/on270.md

#### Rotation.On270 field

270 degrees.

```csharp
public static readonly Rotation On270;
```

### On90
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rotation/on90.md

#### Rotation.On90 field

90 degrees.

```csharp
public static readonly Rotation On90;
```

### RtfOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rtfoptions.md

#### RtfOptions class

Options for conversion to RTF file type.

```csharp
public sealed class RtfOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| RtfOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ExportImagesForOldReaders { get; set; } | Specifies whether the keywords for "old readers" are written to RTF or not. This can significantly affect the size of the RTF document. Default is False. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ExportImagesForOldReaders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rtfoptions/exportimagesforoldreaders.md

#### RtfOptions.ExportImagesForOldReaders property

Specifies whether the keywords for "old readers" are written to RTF or not. This can significantly affect the size of the RTF document. Default is False.

```csharp
public bool ExportImagesForOldReaders { get; set; }
```

### RtfOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/rtfoptions/rtfoptions.md

#### RtfOptions constructor

The default constructor.

```csharp
public RtfOptions()
```

### SpreadsheetConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions.md

#### SpreadsheetConvertOptions class

Options for conversion to Spreadsheet file type.

```csharp
public class SpreadsheetConvertOptions : CommonConvertOptions<SpreadsheetFileType>, 
    IPasswordConvertOptions, IZoomConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetConvertOptions() | Initializes new instance of `SpreadsheetConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; set; } | Specifies the encoding to be used when convert to a delimited formats |
| Format { get; set; } | The desired file type the input document should be converted to. (2 properties) |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Password { get; set; } | Set this property if you want to protect the converted document with a password. |
| Separator { get; set; } | Specifies the separator to be used when convert to a delimited formats |
| Watermark { get; set; } | Implements `Watermark` |
| Zoom { get; set; } | Specifies the zoom level in percentage. Default is 100. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Encoding
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/encoding.md

#### SpreadsheetConvertOptions.Encoding property

Specifies the encoding to be used when convert to a delimited formats

```csharp
public Encoding Encoding { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/format.md

#### SpreadsheetConvertOptions.Format property

The desired file type the input document should be converted to.

```csharp
public SpreadsheetFileType Format { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/password.md

#### SpreadsheetConvertOptions.Password property

Set this property if you want to protect the converted document with a password.

```csharp
public string Password { get; set; }
```

### Separator
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/separator.md

#### SpreadsheetConvertOptions.Separator property

Specifies the separator to be used when convert to a delimited formats

```csharp
public char Separator { get; set; }
```

### SpreadsheetConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/spreadsheetconvertoptions.md

#### SpreadsheetConvertOptions constructor

Initializes new instance of `SpreadsheetConvertOptions` class.

```csharp
public SpreadsheetConvertOptions()
```

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/zoom.md

#### SpreadsheetConvertOptions.Zoom property

Specifies the zoom level in percentage. Default is 100.

```csharp
public int Zoom { get; set; }
```

### ThreeDConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/threedconvertoptions.md

#### ThreeDConvertOptions class

Options for conversion to 3D type.

```csharp
public class ThreeDConvertOptions : ConvertOptions<ThreeDFileType>, IPagedConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ThreeDConvertOptions() | Initializes new instance of `ThreeDConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| PagesCount { get; set; } | Implements `PagesCount` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### PageNumber
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/threedconvertoptions/pagenumber.md

#### ThreeDConvertOptions.PageNumber property

Implements `PageNumber`

```csharp
public int PageNumber { get; set; }
```

### PagesCount
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/threedconvertoptions/pagescount.md

#### ThreeDConvertOptions.PagesCount property

Implements `PagesCount`

```csharp
public int PagesCount { get; set; }
```

### ThreeDConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/threedconvertoptions/threedconvertoptions.md

#### ThreeDConvertOptions constructor

Initializes new instance of `ThreeDConvertOptions` class.

```csharp
public ThreeDConvertOptions()
```

### TiffCompressionMethods
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffcompressionmethods.md

#### TiffCompressionMethods class

Describes Tiff compression methods enumeration.

```csharp
public class TiffCompressionMethods : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Ccitt3 | CCITT3 compression. |
| static readonly Ccitt4 | CCITT4 compression. |
| static readonly Lzw | LZW compression. |
| static readonly None | No compression. |
| static readonly Rle | RLE compression. |

### Ccitt3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffcompressionmethods/ccitt3.md

#### TiffCompressionMethods.Ccitt3 field

CCITT3 compression.

```csharp
public static readonly TiffCompressionMethods Ccitt3;
```

### Ccitt4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffcompressionmethods/ccitt4.md

#### TiffCompressionMethods.Ccitt4 field

CCITT4 compression.

```csharp
public static readonly TiffCompressionMethods Ccitt4;
```

### Lzw
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffcompressionmethods/lzw.md

#### TiffCompressionMethods.Lzw field

LZW compression.

```csharp
public static readonly TiffCompressionMethods Lzw;
```

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffcompressionmethods/none.md

#### TiffCompressionMethods.None field

No compression.

```csharp
public static readonly TiffCompressionMethods None;
```

### Rle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffcompressionmethods/rle.md

#### TiffCompressionMethods.Rle field

RLE compression.

```csharp
public static readonly TiffCompressionMethods Rle;
```

### TiffOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffoptions.md

#### TiffOptions class

Options for conversion to TIFF file type.

```csharp
public sealed class TiffOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffOptions() | Initializes a new instance of the `TiffOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Compression { get; set; } | Sets Tiff compression. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Compression
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffoptions/compression.md

#### TiffOptions.Compression property

Sets Tiff compression.

```csharp
public TiffCompressionMethods Compression { get; set; }
```

### TiffOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/tiffoptions/tiffoptions.md

#### TiffOptions constructor

Initializes a new instance of the `TiffOptions` class.

```csharp
public TiffOptions()
```

### VideoConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/videoconvertoptions.md

#### VideoConvertOptions class

Options for conversion to Video type.

```csharp
public sealed class VideoConvertOptions : ConvertOptions<VideoFileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| VideoConvertOptions() | Initializes new instance of `VideoConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AudioFormat { get; set; } | What audio format to be used |
| ExtractAudioOnly { get; set; } | If set to true, extracts the audio from the video |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| FramesPerSecond { get; set; } | Frames per second. Default is 30. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AudioFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/videoconvertoptions/audioformat.md

#### VideoConvertOptions.AudioFormat property

What audio format to be used

```csharp
public AudioFileType AudioFormat { get; set; }
```

### ExtractAudioOnly
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/videoconvertoptions/extractaudioonly.md

#### VideoConvertOptions.ExtractAudioOnly property

If set to true, extracts the audio from the video

```csharp
public bool ExtractAudioOnly { get; set; }
```

### FramesPerSecond
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/videoconvertoptions/framespersecond.md

#### VideoConvertOptions.FramesPerSecond property

Frames per second. Default is 30.

```csharp
public double FramesPerSecond { get; set; }
```

### VideoConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/videoconvertoptions/videoconvertoptions.md

#### VideoConvertOptions constructor

Initializes new instance of `VideoConvertOptions` class.

```csharp
public VideoConvertOptions()
```

### WatermarkImageOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkimageoptions.md

#### WatermarkImageOptions class

Options for settings watermark to the converted document

```csharp
public sealed class WatermarkImageOptions : WatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkImageOptions(byte[]) | Create WatermarkOptions class and set watermark text |

#### Properties

| Name | Description |
| --- | --- |
| AutoAlign { get; set; } | Auto scale the watermark. If the value is true the position and size is automatically calculated to fit the page size. |
| Background { get; set; } | Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top. |
| Height { get; set; } | Watermark height |
| Image { get; } | Image watermark |
| Left { get; set; } | Watermark left position |
| RotationAngle { get; set; } | Watermark rotation angle |
| Top { get; set; } | Watermark top position |
| Transparency { get; set; } | Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible. |
| Width { get; set; } | Watermark width |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clone current instance |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Image
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkimageoptions/image.md

#### WatermarkImageOptions.Image property

Image watermark

```csharp
public byte[] Image { get; }
```

### WatermarkImageOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkimageoptions/watermarkimageoptions.md

#### WatermarkImageOptions constructor

Create WatermarkOptions class and set watermark text

```csharp
public WatermarkImageOptions(byte[] image)
```

| Parameter | Type | Description |
| --- | --- | --- |
| image | Byte[] | The image to be used as watermark |

### WatermarkOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions.md

#### WatermarkOptions class

Options for settings watermark to the converted document

```csharp
public abstract class WatermarkOptions : ValueObject, ICloneable
```

#### Properties

| Name | Description |
| --- | --- |
| AutoAlign { get; set; } | Auto scale the watermark. If the value is true the position and size is automatically calculated to fit the page size. |
| Background { get; set; } | Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top. |
| Height { get; set; } | Watermark height |
| Left { get; set; } | Watermark left position |
| RotationAngle { get; set; } | Watermark rotation angle |
| Top { get; set; } | Watermark top position |
| Transparency { get; set; } | Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible. |
| Width { get; set; } | Watermark width |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clone current instance |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AutoAlign
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/autoalign.md

#### WatermarkOptions.AutoAlign property

Auto scale the watermark. If the value is true the position and size is automatically calculated to fit the page size.

```csharp
public bool AutoAlign { get; set; }
```

### Background
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/background.md

#### WatermarkOptions.Background property

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

```csharp
public bool Background { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/clone.md

#### WatermarkOptions.Clone method

Clone current instance

```csharp
public object Clone()
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/height.md

#### WatermarkOptions.Height property

Watermark height

```csharp
public int Height { get; set; }
```

### Left
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/left.md

#### WatermarkOptions.Left property

Watermark left position

```csharp
public int Left { get; set; }
```

### RotationAngle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/rotationangle.md

#### WatermarkOptions.RotationAngle property

Watermark rotation angle

```csharp
public int RotationAngle { get; set; }
```

### Top
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/top.md

#### WatermarkOptions.Top property

Watermark top position

```csharp
public int Top { get; set; }
```

### Transparency
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/transparency.md

#### WatermarkOptions.Transparency property

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

```csharp
public double Transparency { get; set; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarkoptions/width.md

#### WatermarkOptions.Width property

Watermark width

```csharp
public int Width { get; set; }
```

### WatermarkTextOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarktextoptions.md

#### WatermarkTextOptions class

Options for settings text watermark to the converted document

```csharp
public sealed class WatermarkTextOptions : WatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkTextOptions(string) | Create WatermarkOptions class and set watermark text |

#### Properties

| Name | Description |
| --- | --- |
| AutoAlign { get; set; } | Auto scale the watermark. If the value is true the position and size is automatically calculated to fit the page size. |
| Background { get; set; } | Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top. |
| Color { get; set; } | Watermark font color if text watermark is applied |
| Height { get; set; } | Watermark height |
| Left { get; set; } | Watermark left position |
| RotationAngle { get; set; } | Watermark rotation angle |
| Text { get; } | Watermark text |
| Top { get; set; } | Watermark top position |
| Transparency { get; set; } | Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible. |
| WatermarkFont { get; set; } | Watermark font if text watermark is applied |
| Width { get; set; } | Watermark width |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clone current instance |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Color
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarktextoptions/color.md

#### WatermarkTextOptions.Color property

Watermark font color if text watermark is applied

```csharp
public Color Color { get; set; }
```

### Text
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarktextoptions/text.md

#### WatermarkTextOptions.Text property

Watermark text

```csharp
public string Text { get; }
```

### WatermarkFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarktextoptions/watermarkfont.md

#### WatermarkTextOptions.WatermarkFont property

Watermark font if text watermark is applied

```csharp
public Font WatermarkFont { get; set; }
```

### WatermarkTextOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/watermarktextoptions/watermarktextoptions.md

#### WatermarkTextOptions constructor

Create WatermarkOptions class and set watermark text

```csharp
public WatermarkTextOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The text to be used as watermark. |

### WebConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions.md

#### WebConvertOptions class

Options for conversion to Web file type.

```csharp
public class WebConvertOptions : CommonConvertOptions<WebFileType>, IUsePdfConvertOptions, 
    IZoomConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WebConvertOptions() | Initializes new instance of `WebConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| EmbedFontResources { get; set; } | Specifies whether to embed font resources within the main HTML. Default is false. Note: If FixedLayout is set to true, font resources will always be embedded. |
| FixedLayout { get; set; } | If `true` fixed layout will be used e.g. absolutely positioned html elements Default: true |
| FixedLayoutShowBorders { get; set; } | Show page borders when converting to fixed layout. Default is True. |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| UsePdf { get; set; } | If `true`, the input firstly is converted to PDF and after that to desired format |
| Watermark { get; set; } | Implements `Watermark` |
| Zoom { get; set; } | Specifies the zoom level in percentage. Default is 100. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### EmbedFontResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions/embedfontresources.md

#### WebConvertOptions.EmbedFontResources property

Specifies whether to embed font resources within the main HTML. Default is false. Note: If FixedLayout is set to true, font resources will always be embedded.

```csharp
public bool EmbedFontResources { get; set; }
```

### FixedLayout
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions/fixedlayout.md

#### WebConvertOptions.FixedLayout property

If `true` fixed layout will be used e.g. absolutely positioned html elements Default: true

```csharp
public bool FixedLayout { get; set; }
```

### FixedLayoutShowBorders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions/fixedlayoutshowborders.md

#### WebConvertOptions.FixedLayoutShowBorders property

Show page borders when converting to fixed layout. Default is True.

```csharp
public bool FixedLayoutShowBorders { get; set; }
```

### UsePdf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions/usepdf.md

#### WebConvertOptions.UsePdf property

If `true`, the input firstly is converted to PDF and after that to desired format

```csharp
public bool UsePdf { get; set; }
```

### WebConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions/webconvertoptions.md

#### WebConvertOptions constructor

Initializes new instance of `WebConvertOptions` class.

```csharp
public WebConvertOptions()
```

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webconvertoptions/zoom.md

#### WebConvertOptions.Zoom property

Specifies the zoom level in percentage. Default is 100.

```csharp
public int Zoom { get; set; }
```

### WebpOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webpoptions.md

#### WebpOptions class

Options for conversion to Webp file type.

```csharp
public sealed class WebpOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| WebpOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Lossless { get; set; } | Indicates if the compression of the converted file will be lossless. |
| Quality { get; set; } | Gets or sets the quality. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Lossless
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webpoptions/lossless.md

#### WebpOptions.Lossless property

Indicates if the compression of the converted file will be lossless.

```csharp
public bool Lossless { get; set; }
```

### Quality
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webpoptions/quality.md

#### WebpOptions.Quality property

Gets or sets the quality.

```csharp
public int Quality { get; set; }
```

### WebpOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/webpoptions/webpoptions.md

#### WebpOptions constructor

The default constructor.

```csharp
public WebpOptions()
```

### WordProcessingConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions.md

#### WordProcessingConvertOptions class

Options for conversion to WordProcessing file type.

```csharp
public class WordProcessingConvertOptions : CommonConvertOptions<WordProcessingFileType>, 
    IDpiConvertOptions, IPageMarginOptions, IPageOrientationOptions, IPageSizeOptions, 
    IPasswordConvertOptions, IPdfRecognitionModeOptions, IZoomConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingConvertOptions() | Initializes new instance of `WordProcessingConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Dpi { get; set; } | Desired page DPI after conversion. The default resolution is: 96 dpi. |
| FallbackPageSize { get; set; } | Fallback page size |
| Format { get; set; } | The desired file type the input document should be converted to. |
| virtual Format { get; set; } | Implements `Format` |
| MarginSettings { get; set; } | Page margin settings |
| MarkdownOptions { get; set; } | Implements `MarkdownOptions` |
| OrientationSettings { get; set; } | Page orientation settings |
| PageNumber { get; set; } | Implements `PageNumber` |
| Pages { get; set; } | Implements `Pages` |
| PagesCount { get; set; } | Implements `PagesCount` |
| Password { get; set; } | Set this property if you want to protect the converted document with a password. |
| PdfRecognitionMode { get; set; } | Implements `PdfRecognitionMode` |
| RtfOptions { get; set; } | RTF specific convert options |
| SizeSettings { get; set; } | Page size settings |
| Watermark { get; set; } | Implements `Watermark` |
| Zoom { get; set; } | Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current options instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Dpi
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/dpi.md

#### WordProcessingConvertOptions.Dpi property

Desired page DPI after conversion. The default resolution is: 96 dpi.

```csharp
public int Dpi { get; set; }
```

### FallbackPageSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/fallbackpagesize.md

#### WordProcessingConvertOptions.FallbackPageSize property

Fallback page size

```csharp
public PageSize FallbackPageSize { get; set; }
```

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/marginsettings.md

#### WordProcessingConvertOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### MarkdownOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/markdownoptions.md

#### WordProcessingConvertOptions.MarkdownOptions property

Implements `MarkdownOptions`

```csharp
public MarkdownOptions MarkdownOptions { get; set; }
```

### OrientationSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/orientationsettings.md

#### WordProcessingConvertOptions.OrientationSettings property

Page orientation settings

```csharp
public PageOrientation OrientationSettings { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/password.md

#### WordProcessingConvertOptions.Password property

Set this property if you want to protect the converted document with a password.

```csharp
public string Password { get; set; }
```

### PdfRecognitionMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/pdfrecognitionmode.md

#### WordProcessingConvertOptions.PdfRecognitionMode property

Implements `PdfRecognitionMode`

```csharp
public PdfRecognitionMode PdfRecognitionMode { get; set; }
```

### RtfOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/rtfoptions.md

#### WordProcessingConvertOptions.RtfOptions property

RTF specific convert options

```csharp
public RtfOptions RtfOptions { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/sizesettings.md

#### WordProcessingConvertOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### WordProcessingConvertOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/wordprocessingconvertoptions.md

#### WordProcessingConvertOptions constructor

Initializes new instance of `WordProcessingConvertOptions` class.

```csharp
public WordProcessingConvertOptions()
```

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/zoom.md

#### WordProcessingConvertOptions.Zoom property

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

```csharp
public int Zoom { get; set; }
```

### GroupDocs.Conversion.Options.Load
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load.md

The namespace provides classes to specify additional options for document loading process.

#### Classes

| Class | Description |
| --- | --- |
| AttachmentIcon | Represents an attachment icon configuration for email attachments. |
| AudioLoadOptions | Options for loading audio documents. |
| BaseImageLoadOptions | Options for loading Image documents. |
| CadDrawTypeMode | Represents possible modes for colorization of objects. |
| CadLoadOptions | Options for loading CAD documents. |
| CompressionLoadOptions | Options for loading compression documents. |
| CsvLoadOptions | Options for loading Csv documents. |
| DatabaseLoadOptions | Options for loading database documents. |
| DiagramLoadOptions | Options for loading Diagram documents. |
| EBookLoadOptions | Options for loading EBook documents. |
| EmailField | Describes email fields enumeration |
| EmailLoadOptions | Options for loading Email documents. |
| EpubLoadOptions | Options for loading Epub documents. |
| FinanceLoadOptions | Options for loading finance documents. |
| FontLoadOptions | Options for loading Font documents. |
| GisLoadOptions | Options for loading GIS documents. |
| GmlLoadOptions | Options for loading Gml documents. |
| HtmlRenderingModes | Describes html rendering modes enumeration. |
| HyphenationOptions | Options for setting hyphenation documents. |
| ImageLoadOptions | Options for loading Image documents. |
| LoadOptions | Abstract document load options class. |
| MboxLoadOptions | Options for loading Mbox documents. |
| NoteLoadOptions | Options for loading One documents. |
| NsfLoadOptions | Options for loading Nsf documents. |
| OlmLoadOptions | Options for loading Olm documents. |
| PageDescriptionLanguageLoadOptions | Options for loading page description language documents. |
| PageLayoutOptions | Describes page layout modes when loading web documents. |
| PclLoadOptions | Options for loading Pcl documents. |
| PdfLoadOptions | Options for loading Pdf documents. |
| PersonalStorageLoadOptions | Options for loading personal storage documents. |
| PresentationCommentsPosition | Represents the way comments are printed with the slide. |
| PresentationLoadOptions | Options for loading Presentation documents. |
| PresentationNotesPosition | Represents the way notes are printed with the slide. |
| PublisherLoadOptions | Options for loading Publisher documents. |
| RasterImageLoadOptions | Options for loading Image documents. |
| SpreadsheetLoadOptions | Options for loading Spreadsheet documents. |
| SpreadsheetPrintComments | Represents the way comments are printed with the sheet. |
| SvgLoadOptions | Options for loading Svg documents. |
| ThreeDLoadOptions | Options for loading 3D documents. |
| TsvLoadOptions | Options for loading Tsv documents. |
| TxtLeadingSpacesOptions | Describes txt leading spaces options enumeration. |
| TxtLoadOptions | Options for loading Txt documents. |
| TxtTrailingSpacesOptions | Describes txt trailing spaces options enumeration. |
| VcfLoadOptions | Options for loading Vcf documents. |
| VectorizationOptions | Options for vectorization images. |
| VideoLoadOptions | Options for loading video documents. |
| WebLoadOptions | Options for loading web documents. |
| WordProcessingBookmarksOptions | Options for handling bookmarks in WordProcessing |
| WordProcessingCommentDisplay | Specifies the rendering mode for document comments. |
| WordProcessingLoadOptions | Options for loading WordProcessing documents. |
| XmlLoadOptions | Options for loading XML documents. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICustomCssStyleOptions | Represents options for custom CSS styling during document conversion |
| IFontSubstituteLoadOptions | Options for loading documents with font substitutes. |
| IFontTransformationLoadOptions | Options for loading documents with font transformations. Font transformations occur after document loading and font substitution are complete. |
| IMetadataLoadOptions | Options to control metadata in the converted document. |
| IPageNumberingLoadOptions | Options to control page numbering in the converted document. |
| IResourceLoadingOptions | Represents set of options to control how external resources will be loaded |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### AttachmentIcon
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/attachmenticon.md

#### AttachmentIcon class

Represents an attachment icon configuration for email attachments.

```csharp
public class AttachmentIcon : ISerializable
```

#### Constructors

| Name | Description |
| --- | --- |
| AttachmentIcon(string, byte[]) | Initializes a new instance of the `AttachmentIcon` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileExtension { get; } | Gets or sets the file extension (e.g., ".pdf", ".docx"). |
| IconData { get; } | Gets or sets the icon data as byte array. |

#### Methods

| Name | Description |
| --- | --- |
| virtual GetObjectData(SerializationInfo, StreamingContext) | Implements ISerializable.GetObjectData. |

### AttachmentIcon
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/attachmenticon/attachmenticon.md

#### AttachmentIcon constructor

Initializes a new instance of the `AttachmentIcon` class.

```csharp
public AttachmentIcon(string fileExtension, byte[] iconData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | String | The file extension. |
| iconData | Byte[] | The icon data as byte array. |

### FileExtension
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/attachmenticon/fileextension.md

#### AttachmentIcon.FileExtension property

Gets or sets the file extension (e.g., ".pdf", ".docx").

```csharp
public string FileExtension { get; }
```

### GetObjectData
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/attachmenticon/getobjectdata.md

#### AttachmentIcon.GetObjectData method

Implements ISerializable.GetObjectData.

```csharp
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | The SerializationInfo. |
| context | StreamingContext | The StreamingContext. |

### IconData
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/attachmenticon/icondata.md

#### AttachmentIcon.IconData property

Gets or sets the icon data as byte array.

```csharp
public byte[] IconData { get; }
```

### AudioLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/audioloadoptions.md

#### AudioLoadOptions class

Options for loading audio documents.

```csharp
public sealed class AudioLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| AudioLoadOptions() | Initializes new instance of `AudioLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| SetAudioConnector(IAudioConnector) | Set audio document connector |

### AudioLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/audioloadoptions/audioloadoptions.md

#### AudioLoadOptions constructor

Initializes new instance of `AudioLoadOptions` class.

```csharp
public AudioLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/audioloadoptions/format.md

#### AudioLoadOptions.Format property

Input document file type.

```csharp
public AudioFileType Format { get; set; }
```

### SetAudioConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/audioloadoptions/setaudioconnector.md

#### AudioLoadOptions.SetAudioConnector method

Set audio document connector

```csharp
public void SetAudioConnector(IAudioConnector audioConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| audioConnector | IAudioConnector | Audio connector instance |

### BaseImageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/baseimageloadoptions.md

#### BaseImageLoadOptions class

Options for loading Image documents.

```csharp
public abstract class BaseImageLoadOptions : LoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/baseimageloadoptions/defaultfont.md

#### BaseImageLoadOptions.DefaultFont property

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/baseimageloadoptions/format.md

#### BaseImageLoadOptions.Format property

Input document file type.

```csharp
public ImageFileType Format { get; set; }
```

### ResetFontFolders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/baseimageloadoptions/resetfontfolders.md

#### BaseImageLoadOptions.ResetFontFolders property

Reset font folders before loading document

```csharp
public bool ResetFontFolders { get; set; }
```

### CadDrawTypeMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/caddrawtypemode.md

#### CadDrawTypeMode class

Represents possible modes for colorization of objects.

```csharp
public class CadDrawTypeMode : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly UseDrawColor | Allows to use common color. |
| static readonly UseObjectColor | Allows to use separate color for every object. |

### UseDrawColor
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/caddrawtypemode/usedrawcolor.md

#### CadDrawTypeMode.UseDrawColor field

Allows to use common color.

```csharp
public static readonly CadDrawTypeMode UseDrawColor;
```

### UseObjectColor
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/caddrawtypemode/useobjectcolor.md

#### CadDrawTypeMode.UseObjectColor field

Allows to use separate color for every object.

```csharp
public static readonly CadDrawTypeMode UseObjectColor;
```

### CadLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions.md

#### CadLoadOptions class

Options for loading CAD documents.

```csharp
public sealed class CadLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CadLoadOptions() | Initializes new instance of `CadLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets a background color. |
| CtbSources { get; set; } | Gets or sets the CTB sources. |
| DrawColor { get; set; } | Gets or sets foreground color. |
| DrawType { get; set; } | Gets or sets type of drawing. |
| Format { get; set; } | Input document file type |
| virtual Format { get; } | Input document file type. |
| LayoutNames { get; set; } | Specifies which CAD layouts to be converted |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### BackgroundColor
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/backgroundcolor.md

#### CadLoadOptions.BackgroundColor property

Gets or sets a background color.

```csharp
public Color BackgroundColor { get; set; }
```

### CadLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/cadloadoptions.md

#### CadLoadOptions constructor

Initializes new instance of `CadLoadOptions` class.

```csharp
public CadLoadOptions()
```

### CtbSources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/ctbsources.md

#### CadLoadOptions.CtbSources property

Gets or sets the CTB sources.

```csharp
public IDictionary<string, Stream> CtbSources { get; set; }
```

### DrawColor
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/drawcolor.md

#### CadLoadOptions.DrawColor property

Gets or sets foreground color.

```csharp
public Color DrawColor { get; set; }
```

### DrawType
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/drawtype.md

#### CadLoadOptions.DrawType property

Gets or sets type of drawing.

```csharp
public CadDrawTypeMode DrawType { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/format.md

#### CadLoadOptions.Format property

Input document file type

```csharp
public CadFileType Format { get; set; }
```

### LayoutNames
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/cadloadoptions/layoutnames.md

#### CadLoadOptions.LayoutNames property

Specifies which CAD layouts to be converted

```csharp
public string[] LayoutNames { get; set; }
```

### CompressionLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions.md

#### CompressionLoadOptions class

Options for loading compression documents.

```csharp
public sealed class CompressionLoadOptions : LoadOptions, IDocumentsContainerLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CompressionLoadOptions() | Initializes new instance of `CompressionLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ConvertOwned { get; } | Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted |
| ConvertOwner { get; } | Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted |
| Depth { get; set; } | Implements `Depth` Default: 3 |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| Password { get; set; } | Set password to load protected document. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### CompressionLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions/compressionloadoptions.md

#### CompressionLoadOptions constructor

Initializes new instance of `CompressionLoadOptions` class.

```csharp
public CompressionLoadOptions()
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions/convertowned.md

#### CompressionLoadOptions.ConvertOwned property

Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted

```csharp
public bool ConvertOwned { get; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions/convertowner.md

#### CompressionLoadOptions.ConvertOwner property

Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted

```csharp
public bool ConvertOwner { get; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions/depth.md

#### CompressionLoadOptions.Depth property

Implements `Depth` Default: 3

```csharp
public int Depth { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions/format.md

#### CompressionLoadOptions.Format property

Input document file type.

```csharp
public CompressionFileType Format { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/compressionloadoptions/password.md

#### CompressionLoadOptions.Password property

Set password to load protected document.

```csharp
public string Password { get; set; }
```

### CsvLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions.md

#### CsvLoadOptions class

Options for loading Csv documents.

```csharp
public sealed class CsvLoadOptions : SpreadsheetLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CsvLoadOptions() | Initializes new instance of `CsvLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AllColumnsInOnePagePerSheet { get; set; } | If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. |
| AutoFitRows { get; set; } | Autofits all rows when converting |
| CheckExcelRestriction { get; set; } | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |
| ColumnsPerPage { get; set; } | Split a worksheet into pages by columns. Default is 0, no pagination. |
| ConvertDateTimeData { get; set; } | Indicates whether the string in the file is converted to date. Default is True. |
| ConvertNumericData { get; set; } | Indicates whether the string in the file is converted to numeric. Default is True. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is false |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| ConvertRange { get; set; } | Convert specific range when converting to other than spreadsheet format. Example: "D1:F8". |
| CultureInfo { get; set; } | Get or set the system culture info at the time file is loaded |
| DefaultFont { get; set; } | Default font for spreadsheet document. The following font will be used if a font is missing. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| Encoding { get; set; } | Encoding. Default is Encoding.Default. |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting spreadsheet document. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| HasFormula { get; set; } | Indicates whether text is formula if it starts with "=". |
| IgnoreFormulaCalculationErrors { get; set; } | Indicates whether to ignore formula calculation errors. The error may be unsupported function, external links, etc. Default is false. |
| IsMultiEncoded { get; set; } | True means the file contains several encodings. |
| MarginSettings { get; set; } | Page margin settings |
| OnePagePerSheet { get; set; } | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true. |
| OptimizePdfSize { get; set; } | If True and converting to Pdf the conversion is optimized for better file size than print quality. |
| Password { get; set; } | Set password to unprotect protected document. |
| PreserveDocumentStructure { get; set; } | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| PrintComments { get; set; } | Represents the way comments are printed with the sheet. Default is PrintNoComments. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |
| RowsPerPage { get; set; } | Split a worksheet into pages by rows. Default is 0, no pagination. |
| Separator { get; set; } | Delimiter of a Csv file. |
| SheetIndexes { get; set; } | List of sheet indexes to convert. The indexes must be zero-based |
| Sheets { get; set; } | Sheet name to convert |
| ShowGridLines { get; set; } | Show grid lines when converting Excel files. |
| ShowHiddenSheets { get; set; } | Show hidden sheets when converting Excel files. |
| SizeSettings { get; set; } | Page size settings |
| SkipEmptyRowsAndColumns { get; set; } | Skips empty rows and columns when converting. Default is True. |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| SkipFooters { get; set; } | Skip footers when converting spreadsheet documents. Default: false. |
| SkipHeaders { get; set; } | Skip headers when converting spreadsheet documents. Default: false. |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ConvertDateTimeData
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/convertdatetimedata.md

#### CsvLoadOptions.ConvertDateTimeData property

Indicates whether the string in the file is converted to date. Default is True.

```csharp
public bool ConvertDateTimeData { get; set; }
```

### ConvertNumericData
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/convertnumericdata.md

#### CsvLoadOptions.ConvertNumericData property

Indicates whether the string in the file is converted to numeric. Default is True.

```csharp
public bool ConvertNumericData { get; set; }
```

### CsvLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/csvloadoptions.md

#### CsvLoadOptions constructor

Initializes new instance of `CsvLoadOptions` class.

```csharp
public CsvLoadOptions()
```

### Encoding
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/encoding.md

#### CsvLoadOptions.Encoding property

Encoding. Default is Encoding.Default.

```csharp
public Encoding Encoding { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/format.md

#### CsvLoadOptions.Format property

Input document file type.

```csharp
public SpreadsheetFileType Format { get; }
```

### HasFormula
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/hasformula.md

#### CsvLoadOptions.HasFormula property

Indicates whether text is formula if it starts with "=".

```csharp
public bool HasFormula { get; set; }
```

### IsMultiEncoded
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/ismultiencoded.md

#### CsvLoadOptions.IsMultiEncoded property

True means the file contains several encodings.

```csharp
public bool IsMultiEncoded { get; set; }
```

### Separator
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/csvloadoptions/separator.md

#### CsvLoadOptions.Separator property

Delimiter of a Csv file.

```csharp
public char Separator { get; set; }
```

### DatabaseLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/databaseloadoptions.md

#### DatabaseLoadOptions class

Options for loading database documents.

```csharp
public sealed class DatabaseLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DatabaseLoadOptions() | Initializes new instance of `DatabaseLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### DatabaseLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/databaseloadoptions/databaseloadoptions.md

#### DatabaseLoadOptions constructor

Initializes new instance of `DatabaseLoadOptions` class.

```csharp
public DatabaseLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/databaseloadoptions/format.md

#### DatabaseLoadOptions.Format property

Input document file type.

```csharp
public DatabaseFileType Format { get; set; }
```

### DiagramLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/diagramloadoptions.md

#### DiagramLoadOptions class

Options for loading Diagram documents.

```csharp
public sealed class DiagramLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramLoadOptions() | Initializes new instance of `DiagramLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | Default font for Diagram document. The following font will be used if a font is missing. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/diagramloadoptions/defaultfont.md

#### DiagramLoadOptions.DefaultFont property

Default font for Diagram document. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### DiagramLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/diagramloadoptions/diagramloadoptions.md

#### DiagramLoadOptions constructor

Initializes new instance of `DiagramLoadOptions` class.

```csharp
public DiagramLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/diagramloadoptions/format.md

#### DiagramLoadOptions.Format property

Input document file type.

```csharp
public DiagramFileType Format { get; set; }
```

### EBookLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ebookloadoptions.md

#### EBookLoadOptions class

Options for loading EBook documents.

```csharp
public class EBookLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EBookLoadOptions() | Initializes new instance of `EBookLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### EBookLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ebookloadoptions/ebookloadoptions.md

#### EBookLoadOptions constructor

Initializes new instance of `EBookLoadOptions` class.

```csharp
public EBookLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ebookloadoptions/format.md

#### EBookLoadOptions.Format property

Input document file type.

```csharp
public EBookFileType Format { get; set; }
```

### EmailField
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield.md

#### EmailField class

Describes email fields enumeration

```csharp
public class EmailField : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Attachments | Default field text is "Attachments". |
| static readonly Bcc | Default field text is "Bcc". |
| static readonly Cc | Default field text is "Cc". |
| static readonly End | Default field text is "End". |
| static readonly From | Default field text is "From". |
| static readonly Importance | Default field text is "Importance". |
| static readonly Location | Default field text is "Location". |
| static readonly Organizer | Default field text is "Organizer". |
| static readonly PageHeader | Default field text is "PageHeader". |
| static readonly Recurrence | Default field text is "Recurrence". |
| static readonly RecurrencePattern | Default field text is "RecurrencePattern". |
| static readonly RequiredAttendees | Default field text is "RequiredAttendees". |
| static readonly Sent | Default field text is "Sent". |
| static readonly ShowTimeAs | Default field text is "ShowTimeAs". |
| static readonly Start | Default field text is "Start". |
| static readonly Subject | Default field text is "Subject". |
| static readonly TabField | Default field text is "TabField". |
| static readonly To | Default field text is "To". |

### Attachments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/attachments.md

#### EmailField.Attachments field

Default field text is "Attachments".

```csharp
public static readonly EmailField Attachments;
```

### Bcc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/bcc.md

#### EmailField.Bcc field

Default field text is "Bcc".

```csharp
public static readonly EmailField Bcc;
```

### Cc
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/cc.md

#### EmailField.Cc field

Default field text is "Cc".

```csharp
public static readonly EmailField Cc;
```

### End
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/end.md

#### EmailField.End field

Default field text is "End".

```csharp
public static readonly EmailField End;
```

### From
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/from.md

#### EmailField.From field

Default field text is "From".

```csharp
public static readonly EmailField From;
```

### Importance
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/importance.md

#### EmailField.Importance field

Default field text is "Importance".

```csharp
public static readonly EmailField Importance;
```

### Location
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/location.md

#### EmailField.Location field

Default field text is "Location".

```csharp
public static readonly EmailField Location;
```

### Organizer
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/organizer.md

#### EmailField.Organizer field

Default field text is "Organizer".

```csharp
public static readonly EmailField Organizer;
```

### PageHeader
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/pageheader.md

#### EmailField.PageHeader field

Default field text is "PageHeader".

```csharp
public static readonly EmailField PageHeader;
```

### Recurrence
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/recurrence.md

#### EmailField.Recurrence field

Default field text is "Recurrence".

```csharp
public static readonly EmailField Recurrence;
```

### RecurrencePattern
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/recurrencepattern.md

#### EmailField.RecurrencePattern field

Default field text is "RecurrencePattern".

```csharp
public static readonly EmailField RecurrencePattern;
```

### RequiredAttendees
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/requiredattendees.md

#### EmailField.RequiredAttendees field

Default field text is "RequiredAttendees".

```csharp
public static readonly EmailField RequiredAttendees;
```

### Sent
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/sent.md

#### EmailField.Sent field

Default field text is "Sent".

```csharp
public static readonly EmailField Sent;
```

### ShowTimeAs
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/showtimeas.md

#### EmailField.ShowTimeAs field

Default field text is "ShowTimeAs".

```csharp
public static readonly EmailField ShowTimeAs;
```

### Start
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/start.md

#### EmailField.Start field

Default field text is "Start".

```csharp
public static readonly EmailField Start;
```

### Subject
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/subject.md

#### EmailField.Subject field

Default field text is "Subject".

```csharp
public static readonly EmailField Subject;
```

### TabField
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/tabfield.md

#### EmailField.TabField field

Default field text is "TabField".

```csharp
public static readonly EmailField TabField;
```

### To
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailfield/to.md

#### EmailField.To field

Default field text is "To".

```csharp
public static readonly EmailField To;
```

### EmailLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions.md

#### EmailLoadOptions class

Options for loading Email documents.

```csharp
public sealed class EmailLoadOptions : LoadOptions, ICustomCssStyleOptions, 
    IDocumentsContainerLoadOptions, IFontSubstituteLoadOptions, IPageMarginOptions, 
    IPageOrientationOptions, IPageSizeOptions, IResourceLoadingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailLoadOptions() | Initializes new instance of `EmailLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AttachmentIcons { get; set; } | Gets or sets the list of attachment icons. The list can be customized to provide specific icons for different file types. By default, contains common file type icons. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is true |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| CustomCssStyle { get; set; } | Implements `CustomCssStyle` |
| DefaultFont { get; set; } | Default font for email document. The following font will be used if a font is missing. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| DisplayAttachments { get; set; } | Option to display or hide attachments in the header. Default: true. |
| DisplayBccEmailAddress { get; set; } | Option to display or hide "Bcc" email address. Default: false. |
| DisplayCcEmailAddress { get; set; } | Option to display or hide "Cc" email address. Default: false. |
| DisplayEmailAddresses { get; set; } | Option to control whether email addresses are displayed alongside names. Example: "John Doe &lt;john.doe@sample.com&gt;" or just "John Doe." Default: true. |
| DisplayFromEmailAddress { get; set; } | Option to display or hide "from" email address. Default: true. |
| DisplayHeader { get; set; } | Option to display or hide the email header. Default: true. |
| DisplaySent { get; set; } | Option to display or hide sent date/time in the header. Default: true. |
| DisplaySubject { get; set; } | Option to display or hide subject in the header. Default: true. |
| DisplayToEmailAddress { get; set; } | Option to display or hide "to" email address. Default: true. |
| FieldTextMap { get; set; } | The mapping between email message `EmailField` and field text representation |
| FontSubstitutes { get; set; } | List of font substitutes. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| MarginSettings { get; set; } | Page margin settings |
| OrientationSettings { get; set; } | Page orientation settings |
| PreserveOriginalDate { get; set; } | Defines whether need to keep original date header string in mail message when saving or not (Default value is true) |
| ResourceLoadingTimeout { get; set; } | Timeout for loading external resources |
| SizeSettings { get; set; } | Page size settings |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| TimeZoneOffset { get; set; } | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC. |
| UseDefaultAttachmentIcons { get; set; } | Gets or sets whether to use default attachment icons. Default: true. |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AttachmentIcons
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/attachmenticons.md

#### EmailLoadOptions.AttachmentIcons property

Gets or sets the list of attachment icons. The list can be customized to provide specific icons for different file types. By default, contains common file type icons.

```csharp
public IList<AttachmentIcon> AttachmentIcons { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/clone.md

#### EmailLoadOptions.Clone method

Clones current instance.

```csharp
public object Clone()
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/convertowned.md

#### EmailLoadOptions.ConvertOwned property

Implements `ConvertOwned` Default is true

```csharp
public bool ConvertOwned { get; set; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/convertowner.md

#### EmailLoadOptions.ConvertOwner property

Implements `ConvertOwner` Default is true

```csharp
public bool ConvertOwner { get; set; }
```

### CustomCssStyle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/customcssstyle.md

#### EmailLoadOptions.CustomCssStyle property

Implements `CustomCssStyle`

```csharp
public string CustomCssStyle { get; set; }
```

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/defaultfont.md

#### EmailLoadOptions.DefaultFont property

Default font for email document. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/depth.md

#### EmailLoadOptions.Depth property

Implements `Depth` Default: 1

```csharp
public int Depth { get; set; }
```

### DisplayAttachments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displayattachments.md

#### EmailLoadOptions.DisplayAttachments property

Option to display or hide attachments in the header. Default: true.

```csharp
public bool DisplayAttachments { get; set; }
```

### DisplayBccEmailAddress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displaybccemailaddress.md

#### EmailLoadOptions.DisplayBccEmailAddress property

Option to display or hide "Bcc" email address. Default: false.

```csharp
public bool DisplayBccEmailAddress { get; set; }
```

### DisplayCcEmailAddress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displayccemailaddress.md

#### EmailLoadOptions.DisplayCcEmailAddress property

Option to display or hide "Cc" email address. Default: false.

```csharp
public bool DisplayCcEmailAddress { get; set; }
```

### DisplayEmailAddresses
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displayemailaddresses.md

#### EmailLoadOptions.DisplayEmailAddresses property

Option to control whether email addresses are displayed alongside names. Example: "John Doe &lt;john.doe@sample.com&gt;" or just "John Doe." Default: true.

```csharp
public bool DisplayEmailAddresses { get; set; }
```

### DisplayFromEmailAddress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displayfromemailaddress.md

#### EmailLoadOptions.DisplayFromEmailAddress property

Option to display or hide "from" email address. Default: true.

```csharp
public bool DisplayFromEmailAddress { get; set; }
```

### DisplayHeader
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displayheader.md

#### EmailLoadOptions.DisplayHeader property

Option to display or hide the email header. Default: true.

```csharp
public bool DisplayHeader { get; set; }
```

### DisplaySent
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displaysent.md

#### EmailLoadOptions.DisplaySent property

Option to display or hide sent date/time in the header. Default: true.

```csharp
public bool DisplaySent { get; set; }
```

### DisplaySubject
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displaysubject.md

#### EmailLoadOptions.DisplaySubject property

Option to display or hide subject in the header. Default: true.

```csharp
public bool DisplaySubject { get; set; }
```

### DisplayToEmailAddress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/displaytoemailaddress.md

#### EmailLoadOptions.DisplayToEmailAddress property

Option to display or hide "to" email address. Default: true.

```csharp
public bool DisplayToEmailAddress { get; set; }
```

### EmailLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/emailloadoptions.md

#### EmailLoadOptions constructor

Initializes new instance of `EmailLoadOptions` class.

```csharp
public EmailLoadOptions()
```

### FieldTextMap
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/fieldtextmap.md

#### EmailLoadOptions.FieldTextMap property

The mapping between email message `EmailField` and field text representation

```csharp
public Dictionary<EmailField, string> FieldTextMap { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/fontsubstitutes.md

#### EmailLoadOptions.FontSubstitutes property

List of font substitutes.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/format.md

#### EmailLoadOptions.Format property

Input document file type.

```csharp
public EmailFileType Format { get; set; }
```

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/marginsettings.md

#### EmailLoadOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### OrientationSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/orientationsettings.md

#### EmailLoadOptions.OrientationSettings property

Page orientation settings

```csharp
public PageOrientation OrientationSettings { get; set; }
```

### PreserveOriginalDate
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/preserveoriginaldate.md

#### EmailLoadOptions.PreserveOriginalDate property

Defines whether need to keep original date header string in mail message when saving or not (Default value is true)

```csharp
public bool PreserveOriginalDate { get; set; }
```

### ResourceLoadingTimeout
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/resourceloadingtimeout.md

#### EmailLoadOptions.ResourceLoadingTimeout property

Timeout for loading external resources

```csharp
public TimeSpan ResourceLoadingTimeout { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/sizesettings.md

#### EmailLoadOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/skipexternalresources.md

#### EmailLoadOptions.SkipExternalResources property

Implements `SkipExternalResources`

```csharp
public bool SkipExternalResources { get; set; }
```

### TimeZoneOffset
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/timezoneoffset.md

#### EmailLoadOptions.TimeZoneOffset property

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.

```csharp
public TimeSpan TimeZoneOffset { get; set; }
```

### UseDefaultAttachmentIcons
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/usedefaultattachmenticons.md

#### EmailLoadOptions.UseDefaultAttachmentIcons property

Gets or sets whether to use default attachment icons. Default: true.

```csharp
public bool UseDefaultAttachmentIcons { get; set; }
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/emailloadoptions/whitelistedresources.md

#### EmailLoadOptions.WhitelistedResources property

Implements `WhitelistedResources`

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### EpubLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/epubloadoptions.md

#### EpubLoadOptions class

Options for loading Epub documents.

```csharp
public sealed class EpubLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EpubLoadOptions() | Initializes new instance of `EpubLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### EpubLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/epubloadoptions/epubloadoptions.md

#### EpubLoadOptions constructor

Initializes new instance of `EpubLoadOptions` class.

```csharp
public EpubLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/epubloadoptions/format.md

#### EpubLoadOptions.Format property

Input document file type.

```csharp
public EBookFileType Format { get; }
```

### FinanceLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/financeloadoptions.md

#### FinanceLoadOptions class

Options for loading finance documents.

```csharp
public class FinanceLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| FinanceLoadOptions() | Initializes new instance of `FinanceLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### FinanceLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/financeloadoptions/financeloadoptions.md

#### FinanceLoadOptions constructor

Initializes new instance of `FinanceLoadOptions` class.

```csharp
public FinanceLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/financeloadoptions/format.md

#### FinanceLoadOptions.Format property

Input document file type.

```csharp
public FinanceFileType Format { get; set; }
```

### FontLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/fontloadoptions.md

#### FontLoadOptions class

Options for loading Font documents.

```csharp
public class FontLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| FontLoadOptions() | Initializes new instance of `FontLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### FontLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/fontloadoptions/fontloadoptions.md

#### FontLoadOptions constructor

Initializes new instance of `FontLoadOptions` class.

```csharp
public FontLoadOptions()
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/fontloadoptions/format.md

#### FontLoadOptions.Format property

Input document file type.

```csharp
public FontFileType Format { get; set; }
```

### GisLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gisloadoptions.md

#### GisLoadOptions class

Options for loading GIS documents.

```csharp
public class GisLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GisLoadOptions() | Initializes new instance of `GisLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| Height { get; set; } | Sets desired page height for converting GIS document. Default is 1000. |
| Width { get; set; } | Sets desired page width for converting GIS document. Default is 1000. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gisloadoptions/format.md

#### GisLoadOptions.Format property

Input document file type.

```csharp
public GisFileType Format { get; set; }
```

### GisLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gisloadoptions/gisloadoptions.md

#### GisLoadOptions constructor

Initializes new instance of `GisLoadOptions` class.

```csharp
public GisLoadOptions()
```

### Height
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gisloadoptions/height.md

#### GisLoadOptions.Height property

Sets desired page height for converting GIS document. Default is 1000.

```csharp
public int Height { get; set; }
```

### Width
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gisloadoptions/width.md

#### GisLoadOptions.Width property

Sets desired page width for converting GIS document. Default is 1000.

```csharp
public int Width { get; set; }
```

### GmlLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gmlloadoptions.md

#### GmlLoadOptions class

Options for loading Gml documents.

```csharp
public sealed class GmlLoadOptions : GisLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GmlLoadOptions() | Initializes new instance of `GmlLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| Height { get; set; } | Sets desired page height for converting GIS document. Default is 1000. |
| LoadSchemasFromInternet { get; set; } | Determines whether Conversion is allowed to load XML schema from Internet. If set to false, schemas with absolute URIs that does not start with ‘file://’ would not be loaded. Default is false. |
| RestoreSchema { get; set; } | Determines whether Conversion is allowed to parse attributes in a Gml file in which an XML schema is missing or cannot be loaded. If set to true, Conversion reader does not require the presence of an XML Schema. Default is false. |
| SchemaLocation { get; set; } | Space separated list of URI pairs. First URI in every pair is a URI of the namespace, second URI is a Path to XML schema of the namespace. If set to null, Conversion will try read schemaLocation from the root element of the document. Default is null |
| Width { get; set; } | Sets desired page width for converting GIS document. Default is 1000. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gmlloadoptions/format.md

#### GmlLoadOptions.Format property

Input document file type.

```csharp
public GisFileType Format { get; }
```

### GmlLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gmlloadoptions/gmlloadoptions.md

#### GmlLoadOptions constructor

Initializes new instance of `GmlLoadOptions` class.

```csharp
public GmlLoadOptions()
```

### LoadSchemasFromInternet
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gmlloadoptions/loadschemasfrominternet.md

#### GmlLoadOptions.LoadSchemasFromInternet property

Determines whether Conversion is allowed to load XML schema from Internet. If set to false, schemas with absolute URIs that does not start with ‘file://’ would not be loaded. Default is false.

```csharp
public bool LoadSchemasFromInternet { get; set; }
```

### RestoreSchema
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gmlloadoptions/restoreschema.md

#### GmlLoadOptions.RestoreSchema property

Determines whether Conversion is allowed to parse attributes in a Gml file in which an XML schema is missing or cannot be loaded. If set to true, Conversion reader does not require the presence of an XML Schema. Default is false.

```csharp
public bool RestoreSchema { get; set; }
```

### SchemaLocation
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/gmlloadoptions/schemalocation.md

#### GmlLoadOptions.SchemaLocation property

Space separated list of URI pairs. First URI in every pair is a URI of the namespace, second URI is a Path to XML schema of the namespace. If set to null, Conversion will try read schemaLocation from the root element of the document. Default is null

```csharp
public string SchemaLocation { get; set; }
```

### HtmlRenderingModes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/htmlrenderingmodes.md

#### HtmlRenderingModes class

Describes html rendering modes enumeration.

```csharp
public class HtmlRenderingModes : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly AbsolutePositioning | Absolute positioning rendering mode |
| static readonly Flow | Flow rendering mode |

### AbsolutePositioning
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/htmlrenderingmodes/absolutepositioning.md

#### HtmlRenderingModes.AbsolutePositioning field

Absolute positioning rendering mode

```csharp
public static readonly HtmlRenderingModes AbsolutePositioning;
```

### Flow
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/htmlrenderingmodes/flow.md

#### HtmlRenderingModes.Flow field

Flow rendering mode

```csharp
public static readonly HtmlRenderingModes Flow;
```

### HyphenationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/hyphenationoptions.md

#### HyphenationOptions class

Options for setting hyphenation documents.

```csharp
public sealed class HyphenationOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| HyphenationOptions() | Creates new instance of `HyphenationOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoHyphenation { get; set; } | Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false. |
| HyphenateCaps { get; set; } | Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true. |
| HyphenationDictionaries { get; set; } | Dictionary containing associates between ISO language codes with provided hyphenation dictionary streams. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AutoHyphenation
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/hyphenationoptions/autohyphenation.md

#### HyphenationOptions.AutoHyphenation property

Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false.

```csharp
public bool AutoHyphenation { get; set; }
```

### HyphenateCaps
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/hyphenationoptions/hyphenatecaps.md

#### HyphenationOptions.HyphenateCaps property

Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true.

```csharp
public bool HyphenateCaps { get; set; }
```

### HyphenationDictionaries
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/hyphenationoptions/hyphenationdictionaries.md

#### HyphenationOptions.HyphenationDictionaries property

Dictionary containing associates between ISO language codes with provided hyphenation dictionary streams.

```csharp
public Dictionary<string, Stream> HyphenationDictionaries { get; set; }
```

### HyphenationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/hyphenationoptions/hyphenationoptions.md

#### HyphenationOptions constructor

Creates new instance of `HyphenationOptions` class.

```csharp
public HyphenationOptions()
```

### ICustomCssStyleOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/icustomcssstyleoptions.md

#### ICustomCssStyleOptions interface

Represents options for custom CSS styling during document conversion

```csharp
public interface ICustomCssStyleOptions
```

#### Properties

| Name | Description |
| --- | --- |
| CustomCssStyle { get; set; } | Custom CSS style to be applied to the document during conversion. This style will be applied to the document's &lt;head&gt; tag to customize rendering. |

### CustomCssStyle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/icustomcssstyleoptions/customcssstyle.md

#### ICustomCssStyleOptions.CustomCssStyle property

Custom CSS style to be applied to the document during conversion. This style will be applied to the document's &lt;head&gt; tag to customize rendering.

```csharp
public string CustomCssStyle { get; set; }
```

### IFontSubstituteLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ifontsubstituteloadoptions.md

#### IFontSubstituteLoadOptions interface

Options for loading documents with font substitutes.

```csharp
public interface IFontSubstituteLoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | The font to be used if a font is missing. |
| FontSubstitutes { get; set; } | Substitute specific fonts |

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ifontsubstituteloadoptions/defaultfont.md

#### IFontSubstituteLoadOptions.DefaultFont property

The font to be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ifontsubstituteloadoptions/fontsubstitutes.md

#### IFontSubstituteLoadOptions.FontSubstitutes property

Substitute specific fonts

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### IFontTransformationLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ifonttransformationloadoptions.md

#### IFontTransformationLoadOptions interface

Options for loading documents with font transformations. Font transformations occur after document loading and font substitution are complete.

```csharp
public interface IFontTransformationLoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| FontTransformations { get; set; } | Transform existing fonts after document loading and font substitution. Transformations are applied in the order they appear in the list. Use this for styling, branding, or accessibility font changes. |

### FontTransformations
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ifonttransformationloadoptions/fonttransformations.md

#### IFontTransformationLoadOptions.FontTransformations property

Transform existing fonts after document loading and font substitution. Transformations are applied in the order they appear in the list. Use this for styling, branding, or accessibility font changes.

```csharp
public IList<FontTransformation> FontTransformations { get; set; }
```

### ImageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/imageloadoptions.md

#### ImageLoadOptions class

Options for loading Image documents.

```csharp
public sealed class ImageLoadOptions : BaseImageLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageLoadOptions() | Initializes a new instance of the `ImageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/imageloadoptions/format.md

#### ImageLoadOptions.Format property

Input document file type.

```csharp
public ImageFileType Format { get; set; }
```

### ImageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/imageloadoptions/imageloadoptions.md

#### ImageLoadOptions constructor

Initializes a new instance of the `ImageLoadOptions` class.

```csharp
public ImageLoadOptions()
```

### IMetadataLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/imetadataloadoptions.md

#### IMetadataLoadOptions interface

Options to control metadata in the converted document.

```csharp
public interface IMetadataLoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |

### ClearBuiltInDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/imetadataloadoptions/clearbuiltindocumentproperties.md

#### IMetadataLoadOptions.ClearBuiltInDocumentProperties property

Removes built-in metadata properties from the document.

```csharp
public bool ClearBuiltInDocumentProperties { get; set; }
```

### ClearCustomDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/imetadataloadoptions/clearcustomdocumentproperties.md

#### IMetadataLoadOptions.ClearCustomDocumentProperties property

Removes custom metadata properties from the document.

```csharp
public bool ClearCustomDocumentProperties { get; set; }
```

### IPageNumberingLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ipagenumberingloadoptions.md

#### IPageNumberingLoadOptions interface

Options to control page numbering in the converted document.

```csharp
public interface IPageNumberingLoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| PageNumbering { get; set; } | Enable or disable generation of page numbering in converted document. Default: false |

### PageNumbering
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/ipagenumberingloadoptions/pagenumbering.md

#### IPageNumberingLoadOptions.PageNumbering property

Enable or disable generation of page numbering in converted document. Default: false

```csharp
public bool PageNumbering { get; set; }
```

### IResourceLoadingOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/iresourceloadingoptions.md

#### IResourceLoadingOptions interface

Represents set of options to control how external resources will be loaded

```csharp
public interface IResourceLoadingOptions
```

#### Properties

| Name | Description |
| --- | --- |
| SkipExternalResources { get; set; } | If true, all external resources will not be loaded except those in `WhitelistedResources` list. Default: true |
| WhitelistedResources { get; set; } | External resources that will be always loaded |

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/iresourceloadingoptions/skipexternalresources.md

#### IResourceLoadingOptions.SkipExternalResources property

If true, all external resources will not be loaded except those in `WhitelistedResources` list. Default: true

```csharp
public bool SkipExternalResources { get; set; }
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/iresourceloadingoptions/whitelistedresources.md

#### IResourceLoadingOptions.WhitelistedResources property

External resources that will be always loaded

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### LoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/loadoptions.md

#### LoadOptions class

Abstract document load options class.

```csharp
public abstract class LoadOptions : ValueObject
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/loadoptions/format.md

#### LoadOptions.Format property

Input document file type.

```csharp
public virtual FileType Format { get; }
```

### MboxLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/mboxloadoptions.md

#### MboxLoadOptions class

Options for loading Mbox documents.

```csharp
public sealed class MboxLoadOptions : LoadOptions, IDocumentsContainerLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MboxLoadOptions() | Initializes new instance of `MboxLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ConvertOwned { get; } | Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted |
| ConvertOwner { get; } | Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted |
| Depth { get; set; } | Implements `Depth` Default: 3 |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/mboxloadoptions/clone.md

#### MboxLoadOptions.Clone method

Clones current instance.

```csharp
public object Clone()
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/mboxloadoptions/convertowned.md

#### MboxLoadOptions.ConvertOwned property

Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted

```csharp
public bool ConvertOwned { get; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/mboxloadoptions/convertowner.md

#### MboxLoadOptions.ConvertOwner property

Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted

```csharp
public bool ConvertOwner { get; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/mboxloadoptions/depth.md

#### MboxLoadOptions.Depth property

Implements `Depth` Default: 3

```csharp
public int Depth { get; set; }
```

### MboxLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/mboxloadoptions/mboxloadoptions.md

#### MboxLoadOptions constructor

Initializes new instance of `MboxLoadOptions` class.

```csharp
public MboxLoadOptions()
```

### NoteLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/noteloadoptions.md

#### NoteLoadOptions class

Options for loading One documents.

```csharp
public sealed class NoteLoadOptions : LoadOptions, IFontSubstituteLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| NoteLoadOptions() | Initializes new instance of `NoteLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | Default font for Note document. The following font will be used if a font is missing. |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting Note document. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| Password { get; set; } | Set password to unprotect protected document. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/noteloadoptions/defaultfont.md

#### NoteLoadOptions.DefaultFont property

Default font for Note document. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/noteloadoptions/fontsubstitutes.md

#### NoteLoadOptions.FontSubstitutes property

Substitute specific fonts when converting Note document.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/noteloadoptions/format.md

#### NoteLoadOptions.Format property

Input document file type.

```csharp
public NoteFileType Format { get; }
```

### NoteLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/noteloadoptions/noteloadoptions.md

#### NoteLoadOptions constructor

Initializes new instance of `NoteLoadOptions` class.

```csharp
public NoteLoadOptions()
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/noteloadoptions/password.md

#### NoteLoadOptions.Password property

Set password to unprotect protected document.

```csharp
public string Password { get; set; }
```

### NsfLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/nsfloadoptions.md

#### NsfLoadOptions class

Options for loading Nsf documents.

```csharp
public sealed class NsfLoadOptions : LoadOptions, IDocumentsContainerLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| NsfLoadOptions() | Initializes new instance of `NsfLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ConvertOwned { get; } | Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted |
| ConvertOwner { get; } | Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted |
| Depth { get; set; } | Implements `Depth` Default: 3 |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/nsfloadoptions/clone.md

#### NsfLoadOptions.Clone method

Clones current instance.

```csharp
public object Clone()
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/nsfloadoptions/convertowned.md

#### NsfLoadOptions.ConvertOwned property

Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted

```csharp
public bool ConvertOwned { get; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/nsfloadoptions/convertowner.md

#### NsfLoadOptions.ConvertOwner property

Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted

```csharp
public bool ConvertOwner { get; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/nsfloadoptions/depth.md

#### NsfLoadOptions.Depth property

Implements `Depth` Default: 3

```csharp
public int Depth { get; set; }
```

### NsfLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/nsfloadoptions/nsfloadoptions.md

#### NsfLoadOptions constructor

Initializes new instance of `NsfLoadOptions` class.

```csharp
public NsfLoadOptions()
```

### OlmLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions.md

#### OlmLoadOptions class

Options for loading Olm documents.

```csharp
public sealed class OlmLoadOptions : LoadOptions, IDocumentsContainerLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OlmLoadOptions() | Initializes new instance of `OlmLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ConvertOwned { get; } | Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted |
| ConvertOwner { get; } | Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted |
| Depth { get; set; } | Implements `Depth` Default: 3 |
| Folder { get; set; } | Folder which to be processed Default is Inbox |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions/clone.md

#### OlmLoadOptions.Clone method

Clones current instance.

```csharp
public object Clone()
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions/convertowned.md

#### OlmLoadOptions.ConvertOwned property

Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted

```csharp
public bool ConvertOwned { get; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions/convertowner.md

#### OlmLoadOptions.ConvertOwner property

Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted

```csharp
public bool ConvertOwner { get; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions/depth.md

#### OlmLoadOptions.Depth property

Implements `Depth` Default: 3

```csharp
public int Depth { get; set; }
```

### Folder
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions/folder.md

#### OlmLoadOptions.Folder property

Folder which to be processed Default is Inbox

```csharp
public string Folder { get; set; }
```

### OlmLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/olmloadoptions/olmloadoptions.md

#### OlmLoadOptions constructor

Initializes new instance of `OlmLoadOptions` class.

```csharp
public OlmLoadOptions()
```

### PageDescriptionLanguageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions.md

#### PageDescriptionLanguageLoadOptions class

Options for loading page description language documents.

```csharp
public class PageDescriptionLanguageLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PageDescriptionLanguageLoadOptions() | Initializes new instance of `PageDescriptionLanguageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions/format.md

#### PageDescriptionLanguageLoadOptions.Format property

Input document file type.

```csharp
public PageDescriptionLanguageFileType Format { get; set; }
```

### PageDescriptionLanguageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions/pagedescriptionlanguageloadoptions.md

#### PageDescriptionLanguageLoadOptions constructor

Initializes new instance of `PageDescriptionLanguageLoadOptions` class.

```csharp
public PageDescriptionLanguageLoadOptions()
```

### PageLayoutOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagelayoutoptions.md

#### PageLayoutOptions class

Describes page layout modes when loading web documents.

```csharp
public class PageLayoutOptions : FlagsEnumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| virtual HasFlag&lt;T&gt;(T) | Checks if the current flag has the specified flag. |
| virtual HasFlagValue(int) | Checks if the current flag has the specified value. |
| override ToString() | Converts the current object to a string. |
| operator &#x7C; | Combines two `PageLayoutOptions` flags using bitwise OR. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly None | Default value |
| static readonly ScaleToPageHeight | This flag indicates that the content of the document will be scaled to fit the height of the first page. All document content will be placed on the single page only. |
| static readonly ScaleToPageWidth | Indicates that the content of the document will be scaled to fit the page where the difference between the available page width and the overlapping content is greatest. |

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagelayoutoptions/none.md

#### PageLayoutOptions.None field

Default value

```csharp
public static readonly PageLayoutOptions None;
```

### op_BitwiseOr
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagelayoutoptions/op_bitwiseor.md

#### PageLayoutOptions BitwiseOr operator

Combines two `PageLayoutOptions` flags using bitwise OR.

```csharp
public static PageLayoutOptions operator |(PageLayoutOptions left, PageLayoutOptions right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | PageLayoutOptions | The first flag. |
| right | PageLayoutOptions | The second flag. |

##### Return Value

A combined `PageLayoutOptions` containing both flags.

### ScaleToPageHeight
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagelayoutoptions/scaletopageheight.md

#### PageLayoutOptions.ScaleToPageHeight field

This flag indicates that the content of the document will be scaled to fit the height of the first page. All document content will be placed on the single page only.

```csharp
public static readonly PageLayoutOptions ScaleToPageHeight;
```

### ScaleToPageWidth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pagelayoutoptions/scaletopagewidth.md

#### PageLayoutOptions.ScaleToPageWidth field

Indicates that the content of the document will be scaled to fit the page where the difference between the available page width and the overlapping content is greatest.

```csharp
public static readonly PageLayoutOptions ScaleToPageWidth;
```

### PclLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pclloadoptions.md

#### PclLoadOptions class

Options for loading Pcl documents.

```csharp
public sealed class PclLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PclLoadOptions() | Initializes new instance of `PclLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pclloadoptions/format.md

#### PclLoadOptions.Format property

Input document file type.

```csharp
public PageDescriptionLanguageFileType Format { get; }
```

### PclLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pclloadoptions/pclloadoptions.md

#### PclLoadOptions constructor

Initializes new instance of `PclLoadOptions` class.

```csharp
public PclLoadOptions()
```

### ResetFontFolders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pclloadoptions/resetfontfolders.md

#### PclLoadOptions.ResetFontFolders property

Reset font folders before loading document

```csharp
public bool ResetFontFolders { get; set; }
```

### PdfLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions.md

#### PdfLoadOptions class

Options for loading Pdf documents.

```csharp
public sealed class PdfLoadOptions : LoadOptions, IDocumentsContainerLoadOptions, 
    IFontSubstituteLoadOptions, IFontTransformationLoadOptions, IMetadataLoadOptions, 
    IPageNumberingLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfLoadOptions() | Initializes new instance of `PdfLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is false |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| DefaultFont { get; set; } | Default font for Pdf document. The following font will be used if a font is missing. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| FlattenAllFields { get; set; } | Flatten all the fields of the PDF form. |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting Pdf document. |
| FontTransformations { get; set; } | Transform existing fonts after document loading and font substitution are complete. Font transformations can modify any fonts in the document, including fonts that were successfully loaded. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| HidePdfAnnotations { get; set; } | Hide annotations in Pdf documents. |
| PageNumbering { get; set; } | Enable or disable generation of page numbering in converted document. Default: false |
| Password { get; set; } | Set password to unprotect protected document. |
| RemoveEmbeddedFiles { get; set; } | Remove embedded files. |
| RemoveJavascript { get; set; } | Remove javascript. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### ClearBuiltInDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/clearbuiltindocumentproperties.md

#### PdfLoadOptions.ClearBuiltInDocumentProperties property

Removes built-in metadata properties from the document.

```csharp
public bool ClearBuiltInDocumentProperties { get; set; }
```

### ClearCustomDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/clearcustomdocumentproperties.md

#### PdfLoadOptions.ClearCustomDocumentProperties property

Removes custom metadata properties from the document.

```csharp
public bool ClearCustomDocumentProperties { get; set; }
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/convertowned.md

#### PdfLoadOptions.ConvertOwned property

Implements `ConvertOwned` Default is false

```csharp
public bool ConvertOwned { get; set; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/convertowner.md

#### PdfLoadOptions.ConvertOwner property

Implements `ConvertOwner` Default is true

```csharp
public bool ConvertOwner { get; set; }
```

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/defaultfont.md

#### PdfLoadOptions.DefaultFont property

Default font for Pdf document. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/depth.md

#### PdfLoadOptions.Depth property

Implements `Depth` Default: 1

```csharp
public int Depth { get; set; }
```

### FlattenAllFields
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/flattenallfields.md

#### PdfLoadOptions.FlattenAllFields property

Flatten all the fields of the PDF form.

```csharp
public bool FlattenAllFields { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/fontsubstitutes.md

#### PdfLoadOptions.FontSubstitutes property

Substitute specific fonts when converting Pdf document.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### FontTransformations
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/fonttransformations.md

#### PdfLoadOptions.FontTransformations property

Transform existing fonts after document loading and font substitution are complete. Font transformations can modify any fonts in the document, including fonts that were successfully loaded.

```csharp
public IList<FontTransformation> FontTransformations { get; set; }
```

##### Remarks

**Note:** Font transformations are applied after all font substitution steps are complete.

Transformations are processed in the order they appear in the list.

Use cases: Styling changes, branding requirements, accessibility improvements.

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/format.md

#### PdfLoadOptions.Format property

Input document file type.

```csharp
public PdfFileType Format { get; }
```

### HidePdfAnnotations
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/hidepdfannotations.md

#### PdfLoadOptions.HidePdfAnnotations property

Hide annotations in Pdf documents.

```csharp
public bool HidePdfAnnotations { get; set; }
```

### PageNumbering
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/pagenumbering.md

#### PdfLoadOptions.PageNumbering property

Enable or disable generation of page numbering in converted document. Default: false

```csharp
public bool PageNumbering { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/password.md

#### PdfLoadOptions.Password property

Set password to unprotect protected document.

```csharp
public string Password { get; set; }
```

### PdfLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/pdfloadoptions.md

#### PdfLoadOptions constructor

Initializes new instance of `PdfLoadOptions` class.

```csharp
public PdfLoadOptions()
```

### RemoveEmbeddedFiles
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/removeembeddedfiles.md

#### PdfLoadOptions.RemoveEmbeddedFiles property

Remove embedded files.

```csharp
public bool RemoveEmbeddedFiles { get; set; }
```

### RemoveJavascript
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/removejavascript.md

#### PdfLoadOptions.RemoveJavascript property

Remove javascript.

```csharp
public bool RemoveJavascript { get; set; }
```

### ResetFontFolders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/pdfloadoptions/resetfontfolders.md

#### PdfLoadOptions.ResetFontFolders property

Reset font folders before loading document

```csharp
public bool ResetFontFolders { get; set; }
```

### PersonalStorageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions.md

#### PersonalStorageLoadOptions class

Options for loading personal storage documents.

```csharp
public sealed class PersonalStorageLoadOptions : LoadOptions, IDocumentsContainerLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PersonalStorageLoadOptions() | Initializes new instance of `PersonalStorageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ConvertOwned { get; } | Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted |
| ConvertOwner { get; } | Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted |
| Depth { get; set; } | Implements `Depth` Default: 3 |
| Folder { get; set; } | Folder which to be processed Default is Inbox |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/clone.md

#### PersonalStorageLoadOptions.Clone method

Clones current instance.

```csharp
public object Clone()
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/convertowned.md

#### PersonalStorageLoadOptions.ConvertOwned property

Implements `ConvertOwned` Readonly. Set to true. The owned documents will be converted

```csharp
public bool ConvertOwned { get; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/convertowner.md

#### PersonalStorageLoadOptions.ConvertOwner property

Implements `ConvertOwner` Readonly. Set to false. The owner will not be converted

```csharp
public bool ConvertOwner { get; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/depth.md

#### PersonalStorageLoadOptions.Depth property

Implements `Depth` Default: 3

```csharp
public int Depth { get; set; }
```

### Folder
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/folder.md

#### PersonalStorageLoadOptions.Folder property

Folder which to be processed Default is Inbox

```csharp
public string Folder { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/format.md

#### PersonalStorageLoadOptions.Format property

Input document file type.

```csharp
public EmailFileType Format { get; set; }
```

### PersonalStorageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/personalstorageloadoptions/personalstorageloadoptions.md

#### PersonalStorageLoadOptions constructor

Initializes new instance of `PersonalStorageLoadOptions` class.

```csharp
public PersonalStorageLoadOptions()
```

### PresentationCommentsPosition
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationcommentsposition.md

#### PresentationCommentsPosition class

Represents the way comments are printed with the slide.

```csharp
public class PresentationCommentsPosition : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Bottom | Represents the comments are printed at end of the page. |
| static readonly None | Represents the comments are not printed. |
| static readonly Right | Represents the comments are printed at the right of the page. |

### Bottom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationcommentsposition/bottom.md

#### PresentationCommentsPosition.Bottom field

Represents the comments are printed at end of the page.

```csharp
public static readonly PresentationCommentsPosition Bottom;
```

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationcommentsposition/none.md

#### PresentationCommentsPosition.None field

Represents the comments are not printed.

```csharp
public static readonly PresentationCommentsPosition None;
```

### Right
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationcommentsposition/right.md

#### PresentationCommentsPosition.Right field

Represents the comments are printed at the right of the page.

```csharp
public static readonly PresentationCommentsPosition Right;
```

### PresentationLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions.md

#### PresentationLoadOptions class

Options for loading Presentation documents.

```csharp
public class PresentationLoadOptions : LoadOptions, IDocumentsContainerLoadOptions, 
    IFontSubstituteLoadOptions, IMetadataLoadOptions, IResourceLoadingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationLoadOptions() | Initializes new instance of `PresentationLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |
| CommentsPosition { get; set; } | Represents the way comments are printed with the slide. Default is None. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is false |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| DefaultFont { get; set; } | Default font for rendering the presentation. The following font will be used if a presentation font is missing. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting Presentation document. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| NotesPosition { get; set; } | Represents the way notes are printed with the slide. Default is None. |
| Password { get; set; } | Set password to unprotect protected document. |
| PreserveDocumentStructure { get; set; } | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| ShowHiddenSlides { get; set; } | Show hidden slides. |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| SetVideoConnector(IPresentationVideoConnector) | Set video document connector |

### ClearBuiltInDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/clearbuiltindocumentproperties.md

#### PresentationLoadOptions.ClearBuiltInDocumentProperties property

Removes built-in metadata properties from the document.

```csharp
public bool ClearBuiltInDocumentProperties { get; set; }
```

### ClearCustomDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/clearcustomdocumentproperties.md

#### PresentationLoadOptions.ClearCustomDocumentProperties property

Removes custom metadata properties from the document.

```csharp
public bool ClearCustomDocumentProperties { get; set; }
```

### CommentsPosition
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/commentsposition.md

#### PresentationLoadOptions.CommentsPosition property

Represents the way comments are printed with the slide. Default is None.

```csharp
public PresentationCommentsPosition CommentsPosition { get; set; }
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/convertowned.md

#### PresentationLoadOptions.ConvertOwned property

Implements `ConvertOwned` Default is false

```csharp
public bool ConvertOwned { get; set; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/convertowner.md

#### PresentationLoadOptions.ConvertOwner property

Implements `ConvertOwner` Default is true

```csharp
public bool ConvertOwner { get; set; }
```

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/defaultfont.md

#### PresentationLoadOptions.DefaultFont property

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

```csharp
public string DefaultFont { get; set; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/depth.md

#### PresentationLoadOptions.Depth property

Implements `Depth` Default: 1

```csharp
public int Depth { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/fontsubstitutes.md

#### PresentationLoadOptions.FontSubstitutes property

Substitute specific fonts when converting Presentation document.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/format.md

#### PresentationLoadOptions.Format property

Input document file type.

```csharp
public PresentationFileType Format { get; set; }
```

### NotesPosition
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/notesposition.md

#### PresentationLoadOptions.NotesPosition property

Represents the way notes are printed with the slide. Default is None.

```csharp
public PresentationNotesPosition NotesPosition { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/password.md

#### PresentationLoadOptions.Password property

Set password to unprotect protected document.

```csharp
public string Password { get; set; }
```

### PresentationLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/presentationloadoptions.md

#### PresentationLoadOptions constructor

Initializes new instance of `PresentationLoadOptions` class.

```csharp
public PresentationLoadOptions()
```

### PreserveDocumentStructure
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/preservedocumentstructure.md

#### PresentationLoadOptions.PreserveDocumentStructure property

Determines whether the document structure should be preserved when converting to PDF (default is false).

```csharp
public bool PreserveDocumentStructure { get; set; }
```

##### Remarks

Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

### SetVideoConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/setvideoconnector.md

#### PresentationLoadOptions.SetVideoConnector method

Set video document connector

```csharp
public void SetVideoConnector(IPresentationVideoConnector videoConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| videoConnector | IPresentationVideoConnector | Video connector instance |

### ShowHiddenSlides
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/showhiddenslides.md

#### PresentationLoadOptions.ShowHiddenSlides property

Show hidden slides.

```csharp
public bool ShowHiddenSlides { get; set; }
```

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/skipexternalresources.md

#### PresentationLoadOptions.SkipExternalResources property

Implements `SkipExternalResources`

```csharp
public bool SkipExternalResources { get; set; }
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationloadoptions/whitelistedresources.md

#### PresentationLoadOptions.WhitelistedResources property

Implements `WhitelistedResources`

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### PresentationNotesPosition
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationnotesposition.md

#### PresentationNotesPosition class

Represents the way notes are printed with the slide.

```csharp
public class PresentationNotesPosition : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly BottomFull | Specifies the notes should be full displayed using additional pages as it is needed. |
| static readonly BottomTruncated | Specifies the notes should be displayed in only one page. |
| static readonly None | Notes will not be printed. |

### BottomFull
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationnotesposition/bottomfull.md

#### PresentationNotesPosition.BottomFull field

Specifies the notes should be full displayed using additional pages as it is needed.

```csharp
public static readonly PresentationNotesPosition BottomFull;
```

### BottomTruncated
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationnotesposition/bottomtruncated.md

#### PresentationNotesPosition.BottomTruncated field

Specifies the notes should be displayed in only one page.

```csharp
public static readonly PresentationNotesPosition BottomTruncated;
```

### None
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/presentationnotesposition/none.md

#### PresentationNotesPosition.None field

Notes will not be printed.

```csharp
public static readonly PresentationNotesPosition None;
```

### PublisherLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/publisherloadoptions.md

#### PublisherLoadOptions class

Options for loading Publisher documents.

```csharp
public class PublisherLoadOptions : LoadOptions, IFontSubstituteLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PublisherLoadOptions() | Initializes new instance of `PublisherLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | Default font for Publisher document. The following font will be used if a font is missing. |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting Publisher document. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/publisherloadoptions/defaultfont.md

#### PublisherLoadOptions.DefaultFont property

Default font for Publisher document. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/publisherloadoptions/fontsubstitutes.md

#### PublisherLoadOptions.FontSubstitutes property

Substitute specific fonts when converting Publisher document.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/publisherloadoptions/format.md

#### PublisherLoadOptions.Format property

Input document file type.

```csharp
public PublisherFileType Format { get; }
```

### PublisherLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/publisherloadoptions/publisherloadoptions.md

#### PublisherLoadOptions constructor

Initializes new instance of `PublisherLoadOptions` class.

```csharp
public PublisherLoadOptions()
```

### RasterImageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions.md

#### RasterImageLoadOptions class

Options for loading Image documents.

```csharp
public sealed class RasterImageLoadOptions : BaseImageLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| RasterImageLoadOptions() | Initializes a new instance of the `RasterImageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CropArea { get; set; } | Crop image area before conversion |
| DefaultFont { get; set; } | Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |
| VectorizationOptions { get; set; } | Sets vectorization options |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| SetHeicConnector(IHeicConnector) | Set Heic image connector |
| SetOcrConnector(IOcrConnector) | Set image OCR connector |

### CropArea
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions/croparea.md

#### RasterImageLoadOptions.CropArea property

Crop image area before conversion

```csharp
public Rectangle CropArea { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions/format.md

#### RasterImageLoadOptions.Format property

Input document file type.

```csharp
public ImageFileType Format { get; set; }
```

### RasterImageLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions/rasterimageloadoptions.md

#### RasterImageLoadOptions constructor

Initializes a new instance of the `RasterImageLoadOptions` class.

```csharp
public RasterImageLoadOptions()
```

### SetHeicConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions/setheicconnector.md

#### RasterImageLoadOptions.SetHeicConnector method

Set Heic image connector

```csharp
public void SetHeicConnector(IHeicConnector heicConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| heicConnector | IHeicConnector | Heic connector instance |

### SetOcrConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions/setocrconnector.md

#### RasterImageLoadOptions.SetOcrConnector method

Set image OCR connector

```csharp
public void SetOcrConnector(IOcrConnector ocrConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | OCR connector instance |

### VectorizationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/rasterimageloadoptions/vectorizationoptions.md

#### RasterImageLoadOptions.VectorizationOptions property

Sets vectorization options

```csharp
public VectorizationOptions VectorizationOptions { get; set; }
```

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions class

Options for loading Spreadsheet documents.

```csharp
public class SpreadsheetLoadOptions : LoadOptions, IDocumentsContainerLoadOptions, 
    IFontSubstituteLoadOptions, IMetadataLoadOptions, IPageMarginOptions, IPageSizeOptions, 
    IResourceLoadingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Initializes new instance of `SpreadsheetLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AllColumnsInOnePagePerSheet { get; set; } | If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. |
| AutoFitRows { get; set; } | Autofits all rows when converting |
| CheckExcelRestriction { get; set; } | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |
| ColumnsPerPage { get; set; } | Split a worksheet into pages by columns. Default is 0, no pagination. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is false |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| ConvertRange { get; set; } | Convert specific range when converting to other than spreadsheet format. Example: "D1:F8". |
| CultureInfo { get; set; } | Get or set the system culture info at the time file is loaded |
| DefaultFont { get; set; } | Default font for spreadsheet document. The following font will be used if a font is missing. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting spreadsheet document. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| IgnoreFormulaCalculationErrors { get; set; } | Indicates whether to ignore formula calculation errors. The error may be unsupported function, external links, etc. Default is false. |
| MarginSettings { get; set; } | Page margin settings |
| OnePagePerSheet { get; set; } | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true. |
| OptimizePdfSize { get; set; } | If True and converting to Pdf the conversion is optimized for better file size than print quality. |
| Password { get; set; } | Set password to unprotect protected document. |
| PreserveDocumentStructure { get; set; } | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| PrintComments { get; set; } | Represents the way comments are printed with the sheet. Default is PrintNoComments. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |
| RowsPerPage { get; set; } | Split a worksheet into pages by rows. Default is 0, no pagination. |
| SheetIndexes { get; set; } | List of sheet indexes to convert. The indexes must be zero-based |
| Sheets { get; set; } | Sheet name to convert |
| ShowGridLines { get; set; } | Show grid lines when converting Excel files. |
| ShowHiddenSheets { get; set; } | Show hidden sheets when converting Excel files. |
| SizeSettings { get; set; } | Page size settings |
| SkipEmptyRowsAndColumns { get; set; } | Skips empty rows and columns when converting. Default is True. |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| SkipFooters { get; set; } | Skip footers when converting spreadsheet documents. Default: false. |
| SkipHeaders { get; set; } | Skip headers when converting spreadsheet documents. Default: false. |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### AllColumnsInOnePagePerSheet
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/allcolumnsinonepagepersheet.md

#### SpreadsheetLoadOptions.AllColumnsInOnePagePerSheet property

If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

```csharp
public bool AllColumnsInOnePagePerSheet { get; set; }
```

### AutoFitRows
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/autofitrows.md

#### SpreadsheetLoadOptions.AutoFitRows property

Autofits all rows when converting

```csharp
public bool AutoFitRows { get; set; }
```

### CheckExcelRestriction
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/checkexcelrestriction.md

#### SpreadsheetLoadOptions.CheckExcelRestriction property

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

```csharp
public bool CheckExcelRestriction { get; set; }
```

### ClearBuiltInDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/clearbuiltindocumentproperties.md

#### SpreadsheetLoadOptions.ClearBuiltInDocumentProperties property

Removes built-in metadata properties from the document.

```csharp
public bool ClearBuiltInDocumentProperties { get; set; }
```

### ClearCustomDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/clearcustomdocumentproperties.md

#### SpreadsheetLoadOptions.ClearCustomDocumentProperties property

Removes custom metadata properties from the document.

```csharp
public bool ClearCustomDocumentProperties { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/clone.md

#### SpreadsheetLoadOptions.Clone method

Clones current instance.

```csharp
public object Clone()
```

### ColumnsPerPage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/columnsperpage.md

#### SpreadsheetLoadOptions.ColumnsPerPage property

Split a worksheet into pages by columns. Default is 0, no pagination.

```csharp
public int ColumnsPerPage { get; set; }
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/convertowned.md

#### SpreadsheetLoadOptions.ConvertOwned property

Implements `ConvertOwned` Default is false

```csharp
public bool ConvertOwned { get; set; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/convertowner.md

#### SpreadsheetLoadOptions.ConvertOwner property

Implements `ConvertOwner` Default is true

```csharp
public bool ConvertOwner { get; set; }
```

### ConvertRange
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/convertrange.md

#### SpreadsheetLoadOptions.ConvertRange property

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

```csharp
public string ConvertRange { get; set; }
```

### CultureInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/cultureinfo.md

#### SpreadsheetLoadOptions.CultureInfo property

Get or set the system culture info at the time file is loaded

```csharp
public CultureInfo CultureInfo { get; set; }
```

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/defaultfont.md

#### SpreadsheetLoadOptions.DefaultFont property

Default font for spreadsheet document. The following font will be used if a font is missing.

```csharp
public string DefaultFont { get; set; }
```

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/depth.md

#### SpreadsheetLoadOptions.Depth property

Implements `Depth` Default: 1

```csharp
public int Depth { get; set; }
```

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/fontsubstitutes.md

#### SpreadsheetLoadOptions.FontSubstitutes property

Substitute specific fonts when converting spreadsheet document.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/format.md

#### SpreadsheetLoadOptions.Format property

Input document file type.

```csharp
public SpreadsheetFileType Format { get; set; }
```

### IgnoreFormulaCalculationErrors
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/ignoreformulacalculationerrors.md

#### SpreadsheetLoadOptions.IgnoreFormulaCalculationErrors property

Indicates whether to ignore formula calculation errors. The error may be unsupported function, external links, etc. Default is false.

```csharp
public bool IgnoreFormulaCalculationErrors { get; set; }
```

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/marginsettings.md

#### SpreadsheetLoadOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### OnePagePerSheet
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/onepagepersheet.md

#### SpreadsheetLoadOptions.OnePagePerSheet property

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.

```csharp
public bool OnePagePerSheet { get; set; }
```

### OptimizePdfSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/optimizepdfsize.md

#### SpreadsheetLoadOptions.OptimizePdfSize property

If True and converting to Pdf the conversion is optimized for better file size than print quality.

```csharp
public bool OptimizePdfSize { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/password.md

#### SpreadsheetLoadOptions.Password property

Set password to unprotect protected document.

```csharp
public string Password { get; set; }
```

### PreserveDocumentStructure
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/preservedocumentstructure.md

#### SpreadsheetLoadOptions.PreserveDocumentStructure property

Determines whether the document structure should be preserved when converting to PDF (default is false).

```csharp
public bool PreserveDocumentStructure { get; set; }
```

##### Remarks

Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

### PrintComments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/printcomments.md

#### SpreadsheetLoadOptions.PrintComments property

Represents the way comments are printed with the sheet. Default is PrintNoComments.

```csharp
public SpreadsheetPrintComments PrintComments { get; set; }
```

### ResetFontFolders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/resetfontfolders.md

#### SpreadsheetLoadOptions.ResetFontFolders property

Reset font folders before loading document

```csharp
public bool ResetFontFolders { get; set; }
```

### RowsPerPage
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/rowsperpage.md

#### SpreadsheetLoadOptions.RowsPerPage property

Split a worksheet into pages by rows. Default is 0, no pagination.

```csharp
public int RowsPerPage { get; set; }
```

### SheetIndexes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/sheetindexes.md

#### SpreadsheetLoadOptions.SheetIndexes property

List of sheet indexes to convert. The indexes must be zero-based

```csharp
public IList<int> SheetIndexes { get; set; }
```

### Sheets
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/sheets.md

#### SpreadsheetLoadOptions.Sheets property

Sheet name to convert

```csharp
public IList<string> Sheets { get; set; }
```

### ShowGridLines
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/showgridlines.md

#### SpreadsheetLoadOptions.ShowGridLines property

Show grid lines when converting Excel files.

```csharp
public bool ShowGridLines { get; set; }
```

### ShowHiddenSheets
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/showhiddensheets.md

#### SpreadsheetLoadOptions.ShowHiddenSheets property

Show hidden sheets when converting Excel files.

```csharp
public bool ShowHiddenSheets { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/sizesettings.md

#### SpreadsheetLoadOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### SkipEmptyRowsAndColumns
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/skipemptyrowsandcolumns.md

#### SpreadsheetLoadOptions.SkipEmptyRowsAndColumns property

Skips empty rows and columns when converting. Default is True.

```csharp
public bool SkipEmptyRowsAndColumns { get; set; }
```

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/skipexternalresources.md

#### SpreadsheetLoadOptions.SkipExternalResources property

Implements `SkipExternalResources`

```csharp
public bool SkipExternalResources { get; set; }
```

### SkipFooters
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/skipfooters.md

#### SpreadsheetLoadOptions.SkipFooters property

Skip footers when converting spreadsheet documents. Default: false.

```csharp
public bool SkipFooters { get; set; }
```

### SkipHeaders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/skipheaders.md

#### SpreadsheetLoadOptions.SkipHeaders property

Skip headers when converting spreadsheet documents. Default: false.

```csharp
public bool SkipHeaders { get; set; }
```

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions constructor

Initializes new instance of `SpreadsheetLoadOptions` class.

```csharp
public SpreadsheetLoadOptions()
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetloadoptions/whitelistedresources.md

#### SpreadsheetLoadOptions.WhitelistedResources property

Implements `WhitelistedResources`

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### SpreadsheetPrintComments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetprintcomments.md

#### SpreadsheetPrintComments class

Represents the way comments are printed with the sheet.

```csharp
public class SpreadsheetPrintComments : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly PrintInPlace | Represents to print comments as displayed on sheet. |
| static readonly PrintNoComments | Represents not to print comments. |
| static readonly PrintSheetEnd | Represents to print comments at end of sheet. |
| static readonly PrintWithThreadedComments | Represents to print comments as displayed on sheet include threaded comments. |

### PrintInPlace
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetprintcomments/printinplace.md

#### SpreadsheetPrintComments.PrintInPlace field

Represents to print comments as displayed on sheet.

```csharp
public static readonly SpreadsheetPrintComments PrintInPlace;
```

### PrintNoComments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetprintcomments/printnocomments.md

#### SpreadsheetPrintComments.PrintNoComments field

Represents not to print comments.

```csharp
public static readonly SpreadsheetPrintComments PrintNoComments;
```

### PrintSheetEnd
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetprintcomments/printsheetend.md

#### SpreadsheetPrintComments.PrintSheetEnd field

Represents to print comments at end of sheet.

```csharp
public static readonly SpreadsheetPrintComments PrintSheetEnd;
```

### PrintWithThreadedComments
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/spreadsheetprintcomments/printwiththreadedcomments.md

#### SpreadsheetPrintComments.PrintWithThreadedComments field

Represents to print comments as displayed on sheet include threaded comments.

```csharp
public static readonly SpreadsheetPrintComments PrintWithThreadedComments;
```

### SvgLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions.md

#### SvgLoadOptions class

Options for loading Svg documents.

```csharp
public class SvgLoadOptions : LoadOptions, IResourceLoadingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SvgLoadOptions() | Initializes new instance of `SvgLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CropToContentBounds { get; set; } | Gets or sets a value indicating whether to crop the SVG bounding box to the content bounds before conversion. The default is false. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| MinimumHeight { get; set; } | Set minimum height for converting SVG document. It's used when converting to raster formats. Default is 600. |
| MinimumWidth { get; set; } | Set minimum width for converting SVG document. It's used when converting to raster formats. Default is 800. |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| WhitelistedResources { get; set; } | External resources that will always be loaded. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### CropToContentBounds
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/croptocontentbounds.md

#### SvgLoadOptions.CropToContentBounds property

Gets or sets a value indicating whether to crop the SVG bounding box to the content bounds before conversion. The default is false.

```csharp
public bool CropToContentBounds { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/format.md

#### SvgLoadOptions.Format property

Input document file type.

```csharp
public PageDescriptionLanguageFileType Format { get; set; }
```

### MinimumHeight
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/minimumheight.md

#### SvgLoadOptions.MinimumHeight property

Set minimum height for converting SVG document. It's used when converting to raster formats. Default is 600.

```csharp
public int MinimumHeight { get; set; }
```

### MinimumWidth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/minimumwidth.md

#### SvgLoadOptions.MinimumWidth property

Set minimum width for converting SVG document. It's used when converting to raster formats. Default is 800.

```csharp
public int MinimumWidth { get; set; }
```

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/skipexternalresources.md

#### SvgLoadOptions.SkipExternalResources property

Implements `SkipExternalResources`

```csharp
public bool SkipExternalResources { get; set; }
```

### SvgLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/svgloadoptions.md

#### SvgLoadOptions constructor

Initializes new instance of `SvgLoadOptions` class.

```csharp
public SvgLoadOptions()
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/svgloadoptions/whitelistedresources.md

#### SvgLoadOptions.WhitelistedResources property

External resources that will always be loaded.

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### ThreeDLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/threedloadoptions.md

#### ThreeDLoadOptions class

Options for loading 3D documents.

```csharp
public class ThreeDLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ThreeDLoadOptions() | Initializes new instance of `ThreeDLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/threedloadoptions/format.md

#### ThreeDLoadOptions.Format property

Input document file type.

```csharp
public ThreeDFileType Format { get; set; }
```

### ThreeDLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/threedloadoptions/threedloadoptions.md

#### ThreeDLoadOptions constructor

Initializes new instance of `ThreeDLoadOptions` class.

```csharp
public ThreeDLoadOptions()
```

### TsvLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/tsvloadoptions.md

#### TsvLoadOptions class

Options for loading Tsv documents.

```csharp
public sealed class TsvLoadOptions : SpreadsheetLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TsvLoadOptions() | Initializes new instance of `TsvLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AllColumnsInOnePagePerSheet { get; set; } | If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. |
| AutoFitRows { get; set; } | Autofits all rows when converting |
| CheckExcelRestriction { get; set; } | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |
| ColumnsPerPage { get; set; } | Split a worksheet into pages by columns. Default is 0, no pagination. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is false |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| ConvertRange { get; set; } | Convert specific range when converting to other than spreadsheet format. Example: "D1:F8". |
| CultureInfo { get; set; } | Get or set the system culture info at the time file is loaded |
| DefaultFont { get; set; } | Default font for spreadsheet document. The following font will be used if a font is missing. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| FontSubstitutes { get; set; } | Substitute specific fonts when converting spreadsheet document. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| IgnoreFormulaCalculationErrors { get; set; } | Indicates whether to ignore formula calculation errors. The error may be unsupported function, external links, etc. Default is false. |
| MarginSettings { get; set; } | Page margin settings |
| OnePagePerSheet { get; set; } | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true. |
| OptimizePdfSize { get; set; } | If True and converting to Pdf the conversion is optimized for better file size than print quality. |
| Password { get; set; } | Set password to unprotect protected document. |
| PreserveDocumentStructure { get; set; } | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| PrintComments { get; set; } | Represents the way comments are printed with the sheet. Default is PrintNoComments. |
| ResetFontFolders { get; set; } | Reset font folders before loading document |
| RowsPerPage { get; set; } | Split a worksheet into pages by rows. Default is 0, no pagination. |
| SheetIndexes { get; set; } | List of sheet indexes to convert. The indexes must be zero-based |
| Sheets { get; set; } | Sheet name to convert |
| ShowGridLines { get; set; } | Show grid lines when converting Excel files. |
| ShowHiddenSheets { get; set; } | Show hidden sheets when converting Excel files. |
| SizeSettings { get; set; } | Page size settings |
| SkipEmptyRowsAndColumns { get; set; } | Skips empty rows and columns when converting. Default is True. |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| SkipFooters { get; set; } | Skip footers when converting spreadsheet documents. Default: false. |
| SkipHeaders { get; set; } | Skip headers when converting spreadsheet documents. Default: false. |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Clones current instance. |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/tsvloadoptions/format.md

#### TsvLoadOptions.Format property

Input document file type.

```csharp
public SpreadsheetFileType Format { get; }
```

### TsvLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/tsvloadoptions/tsvloadoptions.md

#### TsvLoadOptions constructor

Initializes new instance of `TsvLoadOptions` class.

```csharp
public TsvLoadOptions()
```

### TxtLeadingSpacesOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtleadingspacesoptions.md

#### TxtLeadingSpacesOptions class

Describes txt leading spaces options enumeration.

```csharp
public class TxtLeadingSpacesOptions : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly ConvertToIndent | Converts leading spaces to indents. |
| static readonly Preserve | Preserves leading spaces. |
| static readonly Trim | Trims leading spaces. |

### ConvertToIndent
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtleadingspacesoptions/converttoindent.md

#### TxtLeadingSpacesOptions.ConvertToIndent field

Converts leading spaces to indents.

```csharp
public static readonly TxtLeadingSpacesOptions ConvertToIndent;
```

### Preserve
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtleadingspacesoptions/preserve.md

#### TxtLeadingSpacesOptions.Preserve field

Preserves leading spaces.

```csharp
public static readonly TxtLeadingSpacesOptions Preserve;
```

### Trim
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtleadingspacesoptions/trim.md

#### TxtLeadingSpacesOptions.Trim field

Trims leading spaces.

```csharp
public static readonly TxtLeadingSpacesOptions Trim;
```

### TxtLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions.md

#### TxtLoadOptions class

Options for loading Txt documents.

```csharp
public sealed class TxtLoadOptions : LoadOptions, IPageMarginOptions, IPageSizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TxtLoadOptions() | Initializes new instance of `TxtLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultFont { get; set; } | Font to use when rendering plain text content during conversion. Since TXT files don't contain font information, this property specifies the display font for the text content. Default: Arial 10pt. |
| DetectNumberingWithWhitespaces { get; set; } | Allows to specify how numbered list items are recognized when plain text document is converted. The default value is true. |
| Encoding { get; set; } | Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| LeadingSpacesOptions { get; set; } | Gets or sets preferred option of a leading space handling. Default value is `ConvertToIndent`. |
| MarginSettings { get; set; } | Page margin settings |
| SizeSettings { get; set; } | Page size settings |
| TrailingSpacesOptions { get; set; } | Gets or sets preferred option of a trailing space handling. Default value is `Trim`. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

##### Remarks

**Font Configuration for Plain Text:**

Since TXT files don't contain font information, use DefaultTextFont to specify

the font for rendering the plain text content during conversion.

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/defaultfont.md

#### TxtLoadOptions.DefaultFont property

Font to use when rendering plain text content during conversion. Since TXT files don't contain font information, this property specifies the display font for the text content. Default: Arial 10pt.

```csharp
public Font DefaultFont { get; set; }
```

### DetectNumberingWithWhitespaces
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/detectnumberingwithwhitespaces.md

#### TxtLoadOptions.DetectNumberingWithWhitespaces property

Allows to specify how numbered list items are recognized when plain text document is converted. The default value is true.

```csharp
public bool DetectNumberingWithWhitespaces { get; set; }
```

##### Remarks

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "•", "*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

### Encoding
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/encoding.md

#### TxtLoadOptions.Encoding property

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

```csharp
public Encoding Encoding { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/format.md

#### TxtLoadOptions.Format property

Input document file type.

```csharp
public WordProcessingFileType Format { get; }
```

### LeadingSpacesOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/leadingspacesoptions.md

#### TxtLoadOptions.LeadingSpacesOptions property

Gets or sets preferred option of a leading space handling. Default value is `ConvertToIndent`.

```csharp
public TxtLeadingSpacesOptions LeadingSpacesOptions { get; set; }
```

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/marginsettings.md

#### TxtLoadOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/sizesettings.md

#### TxtLoadOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### TrailingSpacesOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/trailingspacesoptions.md

#### TxtLoadOptions.TrailingSpacesOptions property

Gets or sets preferred option of a trailing space handling. Default value is `Trim`.

```csharp
public TxtTrailingSpacesOptions TrailingSpacesOptions { get; set; }
```

### TxtLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txtloadoptions/txtloadoptions.md

#### TxtLoadOptions constructor

Initializes new instance of `TxtLoadOptions` class.

```csharp
public TxtLoadOptions()
```

### TxtTrailingSpacesOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txttrailingspacesoptions.md

#### TxtTrailingSpacesOptions class

Describes txt trailing spaces options enumeration.

```csharp
public class TxtTrailingSpacesOptions : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Preserve | Preserves trailing spaces |
| static readonly Trim | Trims trailing spaces |

### Preserve
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txttrailingspacesoptions/preserve.md

#### TxtTrailingSpacesOptions.Preserve field

Preserves trailing spaces

```csharp
public static readonly TxtTrailingSpacesOptions Preserve;
```

### Trim
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/txttrailingspacesoptions/trim.md

#### TxtTrailingSpacesOptions.Trim field

Trims trailing spaces

```csharp
public static readonly TxtTrailingSpacesOptions Trim;
```

### VcfLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vcfloadoptions.md

#### VcfLoadOptions class

Options for loading Vcf documents.

```csharp
public sealed class VcfLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| VcfLoadOptions() | Initializes new instance of `VcfLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; set; } | Gets or sets the encoding that will be used when loading Vcf document. Default is Encoding.Default. |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Encoding
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vcfloadoptions/encoding.md

#### VcfLoadOptions.Encoding property

Gets or sets the encoding that will be used when loading Vcf document. Default is Encoding.Default.

```csharp
public Encoding Encoding { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vcfloadoptions/format.md

#### VcfLoadOptions.Format property

Input document file type.

```csharp
public EmailFileType Format { get; }
```

### VcfLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vcfloadoptions/vcfloadoptions.md

#### VcfLoadOptions constructor

Initializes new instance of `VcfLoadOptions` class.

```csharp
public VcfLoadOptions()
```

### VectorizationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions.md

#### VectorizationOptions class

Options for vectorization images.

```csharp
public class VectorizationOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| VectorizationOptions() | Default constructor for VectorizationOptions. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets background color. Default value is transparent white. |
| ColorsLimit { get; set; } | Gets or sets the maximum number of colors used to quantize an image. Default value is 25. |
| EnableVectorization { get; set; } | Enable vectorization images. Default is false. |
| ImageSizeLimit { get; set; } | Gets or sets maximal dimension of image determined by multiplication image width and height. The size of the image will be scaled based on this property. Default value is 1800000. |
| LineWidth { get; set; } | Gets or sets the line width. The value of this parameter is affected by the graphics scale. Default value is 1. |
| Severity { get; set; } | Sets image trace smoother severity |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### BackgroundColor
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/backgroundcolor.md

#### VectorizationOptions.BackgroundColor property

Gets or sets background color. Default value is transparent white.

```csharp
public Color BackgroundColor { get; set; }
```

### ColorsLimit
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/colorslimit.md

#### VectorizationOptions.ColorsLimit property

Gets or sets the maximum number of colors used to quantize an image. Default value is 25.

```csharp
public int ColorsLimit { get; set; }
```

### EnableVectorization
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/enablevectorization.md

#### VectorizationOptions.EnableVectorization property

Enable vectorization images. Default is false.

```csharp
public bool EnableVectorization { get; set; }
```

### ImageSizeLimit
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/imagesizelimit.md

#### VectorizationOptions.ImageSizeLimit property

Gets or sets maximal dimension of image determined by multiplication image width and height. The size of the image will be scaled based on this property. Default value is 1800000.

```csharp
public int ImageSizeLimit { get; set; }
```

### LineWidth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/linewidth.md

#### VectorizationOptions.LineWidth property

Gets or sets the line width. The value of this parameter is affected by the graphics scale. Default value is 1.

```csharp
public float LineWidth { get; set; }
```

### Severity
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/severity.md

#### VectorizationOptions.Severity property

Sets image trace smoother severity

```csharp
public int Severity { get; set; }
```

### VectorizationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/vectorizationoptions/vectorizationoptions.md

#### VectorizationOptions constructor

Default constructor for VectorizationOptions.

```csharp
public VectorizationOptions()
```

### VideoLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/videoloadoptions.md

#### VideoLoadOptions class

Options for loading video documents.

```csharp
public sealed class VideoLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| VideoLoadOptions() | Initializes new instance of `VideoLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| SetVideoConnector(IVideoConnector) | Set video document connector |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/videoloadoptions/format.md

#### VideoLoadOptions.Format property

Input document file type.

```csharp
public VideoFileType Format { get; set; }
```

### SetVideoConnector
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/videoloadoptions/setvideoconnector.md

#### VideoLoadOptions.SetVideoConnector method

Set video document connector

```csharp
public void SetVideoConnector(IVideoConnector videoConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| videoConnector | IVideoConnector | Video connector instance |

### VideoLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/videoloadoptions/videoloadoptions.md

#### VideoLoadOptions constructor

Initializes new instance of `VideoLoadOptions` class.

```csharp
public VideoLoadOptions()
```

### WebLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions.md

#### WebLoadOptions class

Options for loading web documents.

```csharp
public class WebLoadOptions : LoadOptions, ICustomCssStyleOptions, IPageNumberingLoadOptions, 
    IResourceLoadingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WebLoadOptions() | Initializes new instance of `WebLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| BasePath { get; set; } | The base path/url for the html |
| ConfigureHeaders { get; set; } | Action for configuration of the request headers. First parameter of the action is the Uri. |
| CredentialsProvider { get; set; } | Credentials provider for the Uri. |
| CustomCssStyle { get; set; } | Implements `CustomCssStyle` |
| Encoding { get; set; } | Get or sets the encoding to be used when loading the web document. If the property is null the encoding will be determined from document character set attribute |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| HtmlRenderingMode { get; set; } | Controls how HTML content is rendered. Default: AbsolutePositioning |
| PageLayoutOptions { get; set; } | Specifies the page layout options when loading web documents. |
| PageNumbering { get; set; } | Enable or disable generation of page numbering in converted document. Default: false |
| ResourceLoadingTimeout { get; set; } | Timeout for loading external resources |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| UsePdf { get; set; } | Use pdf for the conversion. Default: false |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |
| Zoom { get; set; } | Specifies the zoom level as a percentage. The zoom level is applied to the document's &lt;body&gt; tag before conversion, scaling the document's visual appearance. A value of 100% represents the original size. The default value is 100. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### BasePath
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/basepath.md

#### WebLoadOptions.BasePath property

The base path/url for the html

```csharp
public string BasePath { get; set; }
```

### ConfigureHeaders
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/configureheaders.md

#### WebLoadOptions.ConfigureHeaders property

Action for configuration of the request headers. First parameter of the action is the Uri.

```csharp
public Action<string, NameValueCollection> ConfigureHeaders { get; set; }
```

### CredentialsProvider
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/credentialsprovider.md

#### WebLoadOptions.CredentialsProvider property

Credentials provider for the Uri.

```csharp
public Func<string, ICredentials> CredentialsProvider { get; set; }
```

### CustomCssStyle
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/customcssstyle.md

#### WebLoadOptions.CustomCssStyle property

Implements `CustomCssStyle`

```csharp
public string CustomCssStyle { get; set; }
```

### Encoding
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/encoding.md

#### WebLoadOptions.Encoding property

Get or sets the encoding to be used when loading the web document. If the property is null the encoding will be determined from document character set attribute

```csharp
public string Encoding { get; set; }
```

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/format.md

#### WebLoadOptions.Format property

Input document file type.

```csharp
public WebFileType Format { get; set; }
```

### HtmlRenderingMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/htmlrenderingmode.md

#### WebLoadOptions.HtmlRenderingMode property

Controls how HTML content is rendered. Default: AbsolutePositioning

```csharp
public HtmlRenderingModes HtmlRenderingMode { get; set; }
```

### PageLayoutOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/pagelayoutoptions.md

#### WebLoadOptions.PageLayoutOptions property

Specifies the page layout options when loading web documents.

```csharp
public PageLayoutOptions PageLayoutOptions { get; set; }
```

### PageNumbering
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/pagenumbering.md

#### WebLoadOptions.PageNumbering property

Enable or disable generation of page numbering in converted document. Default: false

```csharp
public bool PageNumbering { get; set; }
```

### ResourceLoadingTimeout
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/resourceloadingtimeout.md

#### WebLoadOptions.ResourceLoadingTimeout property

Timeout for loading external resources

```csharp
public TimeSpan ResourceLoadingTimeout { get; set; }
```

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/skipexternalresources.md

#### WebLoadOptions.SkipExternalResources property

Implements `SkipExternalResources`

```csharp
public bool SkipExternalResources { get; set; }
```

### UsePdf
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/usepdf.md

#### WebLoadOptions.UsePdf property

Use pdf for the conversion. Default: false

```csharp
public bool UsePdf { get; set; }
```

### WebLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/webloadoptions.md

#### WebLoadOptions constructor

Initializes new instance of `WebLoadOptions` class.

```csharp
public WebLoadOptions()
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/whitelistedresources.md

#### WebLoadOptions.WhitelistedResources property

Implements `WhitelistedResources`

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### Zoom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/webloadoptions/zoom.md

#### WebLoadOptions.Zoom property

Specifies the zoom level as a percentage. The zoom level is applied to the document's &lt;body&gt; tag before conversion, scaling the document's visual appearance. A value of 100% represents the original size. The default value is 100.

```csharp
public int Zoom { get; set; }
```

### WordProcessingBookmarksOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions.md

#### WordProcessingBookmarksOptions class

Options for handling bookmarks in WordProcessing

```csharp
public class WordProcessingBookmarksOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingBookmarksOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| BookmarksOutlineLevel { get; set; } | Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9. |
| ExpandedOutlineLevels { get; set; } | Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS. |
| HeadingsOutlineLevels { get; set; } | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### BookmarksOutlineLevel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/bookmarksoutlinelevel.md

#### WordProcessingBookmarksOptions.BookmarksOutlineLevel property

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.

```csharp
public int BookmarksOutlineLevel { get; set; }
```

### ExpandedOutlineLevels
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/expandedoutlinelevels.md

#### WordProcessingBookmarksOptions.ExpandedOutlineLevels property

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.

```csharp
public int ExpandedOutlineLevels { get; set; }
```

### HeadingsOutlineLevels
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/headingsoutlinelevels.md

#### WordProcessingBookmarksOptions.HeadingsOutlineLevels property

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.

```csharp
public int HeadingsOutlineLevels { get; set; }
```

### WordProcessingBookmarksOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/wordprocessingbookmarksoptions.md

#### WordProcessingBookmarksOptions constructor

The default constructor.

```csharp
public WordProcessingBookmarksOptions()
```

### WordProcessingCommentDisplay
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingcommentdisplay.md

#### WordProcessingCommentDisplay class

Specifies the rendering mode for document comments.

```csharp
public class WordProcessingCommentDisplay : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Annotation | Renders document comments in annotations. This is only available for Pdf format. |
| static readonly Balloon | Renders document comments in balloons in the margin. This is the default value. |
| static readonly Hidden | No document comments are rendered. |

### Annotation
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingcommentdisplay/annotation.md

#### WordProcessingCommentDisplay.Annotation field

Renders document comments in annotations. This is only available for Pdf format.

```csharp
public static readonly WordProcessingCommentDisplay Annotation;
```

### Balloon
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingcommentdisplay/balloon.md

#### WordProcessingCommentDisplay.Balloon field

Renders document comments in balloons in the margin. This is the default value.

```csharp
public static readonly WordProcessingCommentDisplay Balloon;
```

### Hidden
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingcommentdisplay/hidden.md

#### WordProcessingCommentDisplay.Hidden field

No document comments are rendered.

```csharp
public static readonly WordProcessingCommentDisplay Hidden;
```

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

Options for loading WordProcessing documents.

```csharp
public class WordProcessingLoadOptions : LoadOptions, IDocumentsContainerLoadOptions, 
    IFontSubstituteLoadOptions, IFontTransformationLoadOptions, IMetadataLoadOptions, 
    IPageMarginOptions, IPageNumberingLoadOptions, IPageSizeOptions, IResourceLoadingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingLoadOptions() | Initializes new instance of `WordProcessingLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoDetectRtlDirection { get; set; } | When true (default), paragraphs and runs whose text is dominantly right-to-left will have their bidi flags repaired before conversion. This matches the heuristic Microsoft Word and LibreOffice apply and fixes rendering of Arabic/Hebrew documents produced by generators (notably Google Docs) that emit OOXML without &lt;w:bidi/&gt; and with &lt;w:rtl w:val="0"/&gt; on runs that contain only RTL script. Set to false to preserve strict OOXML interpretation of the source markup. |
| BookmarkOptions { get; set; } | Bookmarks options |
| ClearBuiltInDocumentProperties { get; set; } | Removes built-in metadata properties from the document. |
| ClearCustomDocumentProperties { get; set; } | Removes custom metadata properties from the document. |
| CommentDisplayMode { get; set; } | Specifies how comments should be displayed in the output document. Default is ShowInBalloons. |
| ConvertOwned { get; set; } | Implements `ConvertOwned` Default is false |
| ConvertOwner { get; set; } | Implements `ConvertOwner` Default is true |
| DefaultFont { get; set; } | Sets the default font for a WordProcessing document. |
| Depth { get; set; } | Implements `Depth` Default: 1 |
| EmbedTrueTypeFonts { get; set; } | If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: true |
| FontConfigSubstitutionEnabled { get; set; } | Automatically substitutes missing fonts based on FontConfig in the system. Default: false. |
| FontInfoSubstitutionEnabled { get; set; } | Automatically substitutes missing fonts based on FontInfo in the document. Default: false. |
| FontNameSubstitutionEnabled { get; set; } | Automatically substitutes missing fonts based on the font name. Default: false. |
| FontSubstitutes { get; set; } | Substitutes specific fonts when converting a WordsProcessing document. |
| FontTransformations { get; set; } | Transform existing fonts after document loading and font substitution are complete. Font transformations can modify any fonts in the document, including fonts that were successfully loaded. |
| Format { get; set; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| HideWordTrackedChanges { get; set; } | Hide markup and track changes for Word documents. |
| HyphenationOptions { get; set; } | Set hyphenation options for WordProcessing documents. |
| KeepDateFieldOriginalValue { get; set; } | Keep original value of date field. Default: false |
| MarginSettings { get; set; } | Page margin settings |
| PageNumbering { get; set; } | Enable or disable generation of page numbering in converted document. Default: false |
| Password { get; set; } | Set password to unprotect protected document. |
| PreserveDocumentStructure { get; set; } | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| PreserveFormFields { get; set; } | Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false. |
| ShowFullCommenterName { get; set; } | Show full commenter name in comments. Default is false. |
| SizeSettings { get; set; } | Page size settings |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| UpdateFields { get; set; } | Update fields after loading. Default: false |
| UpdatePageLayout { get; set; } | Update page layout after loading. Default: false |
| UseTextShaper { get; set; } | Specifies whether to use a text shaper for better kerning display. Default is false. |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

##### Remarks

**Font Processing Pipeline:**

**Phase 1 - Font Substitution (during document loading):**

• Handles missing/unavailable fonts using FontSubstitutes, DefaultFont, and system substitution

• Processing order: FontName → FontConfig → FontSubstitutes → FontInfo → DefaultFont

**Phase 2 - Font Replacement (after document loading):**

• Modifies any existing fonts in the loaded document using FontReplacements

• Applied after all font substitution is complete

### AutoDetectRtlDirection
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/autodetectrtldirection.md

#### WordProcessingLoadOptions.AutoDetectRtlDirection property

When true (default), paragraphs and runs whose text is dominantly right-to-left will have their bidi flags repaired before conversion. This matches the heuristic Microsoft Word and LibreOffice apply and fixes rendering of Arabic/Hebrew documents produced by generators (notably Google Docs) that emit OOXML without &lt;w:bidi/&gt; and with &lt;w:rtl w:val="0"/&gt; on runs that contain only RTL script. Set to false to preserve strict OOXML interpretation of the source markup.

```csharp
public bool AutoDetectRtlDirection { get; set; }
```

### BookmarkOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/bookmarkoptions.md

#### WordProcessingLoadOptions.BookmarkOptions property

Bookmarks options

```csharp
public WordProcessingBookmarksOptions BookmarkOptions { get; set; }
```

### ClearBuiltInDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/clearbuiltindocumentproperties.md

#### WordProcessingLoadOptions.ClearBuiltInDocumentProperties property

Removes built-in metadata properties from the document.

```csharp
public bool ClearBuiltInDocumentProperties { get; set; }
```

### ClearCustomDocumentProperties
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/clearcustomdocumentproperties.md

#### WordProcessingLoadOptions.ClearCustomDocumentProperties property

Removes custom metadata properties from the document.

```csharp
public bool ClearCustomDocumentProperties { get; set; }
```

### CommentDisplayMode
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/commentdisplaymode.md

#### WordProcessingLoadOptions.CommentDisplayMode property

Specifies how comments should be displayed in the output document. Default is ShowInBalloons.

```csharp
public WordProcessingCommentDisplay CommentDisplayMode { get; set; }
```

### ConvertOwned
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/convertowned.md

#### WordProcessingLoadOptions.ConvertOwned property

Implements `ConvertOwned` Default is false

```csharp
public bool ConvertOwned { get; set; }
```

### ConvertOwner
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/convertowner.md

#### WordProcessingLoadOptions.ConvertOwner property

Implements `ConvertOwner` Default is true

```csharp
public bool ConvertOwner { get; set; }
```

### DefaultFont
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/defaultfont.md

#### WordProcessingLoadOptions.DefaultFont property

Sets the default font for a WordProcessing document.

```csharp
public string DefaultFont { get; set; }
```

##### Remarks

**Note:** The order of substitution is as follows:

1) Automatically substitute missing fonts based on font name (if enabled).

2) Automatically substitute missing fonts based on FontConfig (if enabled).

3) Substitute missing fonts based on FontSubstitutes (if set).

4) Automatically substitute missing fonts based on FontInfo (if enabled).

5) Substitute missing fonts based on DefaultFont (if set).

### Depth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/depth.md

#### WordProcessingLoadOptions.Depth property

Implements `Depth` Default: 1

```csharp
public int Depth { get; set; }
```

### EmbedTrueTypeFonts
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/embedtruetypefonts.md

#### WordProcessingLoadOptions.EmbedTrueTypeFonts property

If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: true

```csharp
public bool EmbedTrueTypeFonts { get; set; }
```

### FontConfigSubstitutionEnabled
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/fontconfigsubstitutionenabled.md

#### WordProcessingLoadOptions.FontConfigSubstitutionEnabled property

Automatically substitutes missing fonts based on FontConfig in the system. Default: false.

```csharp
public bool FontConfigSubstitutionEnabled { get; set; }
```

##### Remarks

**Note:** The order of substitution is as follows:

1) Automatically substitute missing fonts based on font name (if enabled).

2) Automatically substitute missing fonts based on FontConfig (if enabled).

3) Substitute missing fonts based on FontSubstitutes (if set).

4) Automatically substitute missing fonts based on FontInfo (if enabled).

5) Substitute missing fonts based on DefaultFont (if set).

### FontInfoSubstitutionEnabled
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/fontinfosubstitutionenabled.md

#### WordProcessingLoadOptions.FontInfoSubstitutionEnabled property

Automatically substitutes missing fonts based on FontInfo in the document. Default: false.

```csharp
public bool FontInfoSubstitutionEnabled { get; set; }
```

##### Remarks

**Note:** The order of substitution is as follows:

1) Automatically substitute missing fonts based on font name (if enabled).

2) Automatically substitute missing fonts based on FontConfig (if enabled).

3) Substitute missing fonts based on FontSubstitutes (if set).

4) Automatically substitute missing fonts based on FontInfo (if enabled).

5) Substitute missing fonts based on DefaultFont (if set).

### FontNameSubstitutionEnabled
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/fontnamesubstitutionenabled.md

#### WordProcessingLoadOptions.FontNameSubstitutionEnabled property

Automatically substitutes missing fonts based on the font name. Default: false.

```csharp
public bool FontNameSubstitutionEnabled { get; set; }
```

##### Remarks

**Note:** The order of substitution is as follows:

1) Automatically substitute missing fonts based on font name (if enabled).

2) Automatically substitute missing fonts based on FontConfig (if enabled).

3) Substitute missing fonts based on FontSubstitutes (if set).

4) Automatically substitute missing fonts based on FontInfo (if enabled).

5) Substitute missing fonts based on DefaultFont (if set).

### FontSubstitutes
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/fontsubstitutes.md

#### WordProcessingLoadOptions.FontSubstitutes property

Substitutes specific fonts when converting a WordsProcessing document.

```csharp
public IList<FontSubstitute> FontSubstitutes { get; set; }
```

##### Remarks

**Note:** The order of substitution is as follows:

1) Automatically substitute missing fonts based on font name (if enabled).

2) Automatically substitute missing fonts based on FontConfig (if enabled).

3) Substitute missing fonts based on FontSubstitutes (if set).

4) Automatically substitute missing fonts based on FontInfo (if enabled).

5) Substitute missing fonts based on DefaultFont (if set).

### FontTransformations
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/fonttransformations.md

#### WordProcessingLoadOptions.FontTransformations property

Transform existing fonts after document loading and font substitution are complete. Font transformations can modify any fonts in the document, including fonts that were successfully loaded.

```csharp
public IList<FontTransformation> FontTransformations { get; set; }
```

##### Remarks

**Note:** Font transformations are applied after all font substitution steps are complete.

Transformations are processed in the order they appear in the list.

Use cases: Styling changes, branding requirements, accessibility improvements.

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/format.md

#### WordProcessingLoadOptions.Format property

Input document file type.

```csharp
public WordProcessingFileType Format { get; set; }
```

### HideWordTrackedChanges
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/hidewordtrackedchanges.md

#### WordProcessingLoadOptions.HideWordTrackedChanges property

Hide markup and track changes for Word documents.

```csharp
public bool HideWordTrackedChanges { get; set; }
```

### HyphenationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/hyphenationoptions.md

#### WordProcessingLoadOptions.HyphenationOptions property

Set hyphenation options for WordProcessing documents.

```csharp
public HyphenationOptions HyphenationOptions { get; set; }
```

### KeepDateFieldOriginalValue
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/keepdatefieldoriginalvalue.md

#### WordProcessingLoadOptions.KeepDateFieldOriginalValue property

Keep original value of date field. Default: false

```csharp
public bool KeepDateFieldOriginalValue { get; set; }
```

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/marginsettings.md

#### WordProcessingLoadOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### PageNumbering
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/pagenumbering.md

#### WordProcessingLoadOptions.PageNumbering property

Enable or disable generation of page numbering in converted document. Default: false

```csharp
public bool PageNumbering { get; set; }
```

### Password
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/password.md

#### WordProcessingLoadOptions.Password property

Set password to unprotect protected document.

```csharp
public string Password { get; set; }
```

### PreserveDocumentStructure
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/preservedocumentstructure.md

#### WordProcessingLoadOptions.PreserveDocumentStructure property

Determines whether the document structure should be preserved when converting to PDF (default is false).

```csharp
public bool PreserveDocumentStructure { get; set; }
```

##### Remarks

Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

### PreserveFormFields
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/preserveformfields.md

#### WordProcessingLoadOptions.PreserveFormFields property

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

```csharp
public bool PreserveFormFields { get; set; }
```

### ShowFullCommenterName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/showfullcommentername.md

#### WordProcessingLoadOptions.ShowFullCommenterName property

Show full commenter name in comments. Default is false.

```csharp
public bool ShowFullCommenterName { get; set; }
```

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/sizesettings.md

#### WordProcessingLoadOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### SkipExternalResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/skipexternalresources.md

#### WordProcessingLoadOptions.SkipExternalResources property

Implements `SkipExternalResources`

```csharp
public bool SkipExternalResources { get; set; }
```

### UpdateFields
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/updatefields.md

#### WordProcessingLoadOptions.UpdateFields property

Update fields after loading. Default: false

```csharp
public bool UpdateFields { get; set; }
```

### UpdatePageLayout
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/updatepagelayout.md

#### WordProcessingLoadOptions.UpdatePageLayout property

Update page layout after loading. Default: false

```csharp
public bool UpdatePageLayout { get; set; }
```

### UseTextShaper
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/usetextshaper.md

#### WordProcessingLoadOptions.UseTextShaper property

Specifies whether to use a text shaper for better kerning display. Default is false.

```csharp
public bool UseTextShaper { get; set; }
```

### WhitelistedResources
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/whitelistedresources.md

#### WordProcessingLoadOptions.WhitelistedResources property

Implements `WhitelistedResources`

```csharp
public IList<string> WhitelistedResources { get; set; }
```

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/wordprocessingloadoptions/wordprocessingloadoptions.md

#### WordProcessingLoadOptions constructor

Initializes new instance of `WordProcessingLoadOptions` class.

```csharp
public WordProcessingLoadOptions()
```

### XmlLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/xmlloadoptions.md

#### XmlLoadOptions class

Options for loading XML documents.

```csharp
public sealed class XmlLoadOptions : WebLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| XmlLoadOptions() | Initializes new instance of `XmlLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| BasePath { get; set; } | The base path/url for the html |
| ConfigureHeaders { get; set; } | Action for configuration of the request headers. First parameter of the action is the Uri. |
| CredentialsProvider { get; set; } | Credentials provider for the Uri. |
| CustomCssStyle { get; set; } | Implements `CustomCssStyle` |
| Encoding { get; set; } | Get or sets the encoding to be used when loading the web document. If the property is null the encoding will be determined from document character set attribute |
| Format { get; } | Input document file type. |
| virtual Format { get; } | Input document file type. |
| HtmlRenderingMode { get; set; } | Controls how HTML content is rendered. Default: AbsolutePositioning |
| PageLayoutOptions { get; set; } | Specifies the page layout options when loading web documents. |
| PageNumbering { get; set; } | Enable or disable generation of page numbering in converted document. Default: false |
| ResourceLoadingTimeout { get; set; } | Timeout for loading external resources |
| SkipExternalResources { get; set; } | Implements `SkipExternalResources` |
| UseAsDataSource { get; set; } | Use Xml document as data source |
| UsePdf { get; set; } | Use pdf for the conversion. Default: false |
| WhitelistedResources { get; set; } | Implements `WhitelistedResources` |
| XslFoFactory { get; set; } | XSL-FO document stream to convert XML using XSL-FO markup file. |
| XsltFactory { get; set; } | XSLT document stream to convert XML performing XSL transformation to HTML. |
| Zoom { get; set; } | Specifies the zoom level as a percentage. The zoom level is applied to the document's &lt;body&gt; tag before conversion, scaling the document's visual appearance. A value of 100% represents the original size. The default value is 100. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Format
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/xmlloadoptions/format.md

#### XmlLoadOptions.Format property

Input document file type.

```csharp
public WebFileType Format { get; }
```

### UseAsDataSource
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/xmlloadoptions/useasdatasource.md

#### XmlLoadOptions.UseAsDataSource property

Use Xml document as data source

```csharp
public bool UseAsDataSource { get; set; }
```

### XmlLoadOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/xmlloadoptions/xmlloadoptions.md

#### XmlLoadOptions constructor

Initializes new instance of `XmlLoadOptions` class.

```csharp
public XmlLoadOptions()
```

### XslFoFactory
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/xmlloadoptions/xslfofactory.md

#### XmlLoadOptions.XslFoFactory property

XSL-FO document stream to convert XML using XSL-FO markup file.

```csharp
public Func<Stream> XslFoFactory { get; set; }
```

### XsltFactory
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.load/xmlloadoptions/xsltfactory.md

#### XmlLoadOptions.XsltFactory property

XSLT document stream to convert XML performing XSL transformation to HTML.

```csharp
public Func<Stream> XsltFactory { get; set; }
```

### GroupDocs.Conversion.Options
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options.md

The namespace provides classes to specify additional options for document loading and conversion process.

#### Classes

| Class | Description |
| --- | --- |
| PageMarginOptions | Represents options that support page margins |
| PageSize | Specifies page size |
| PageSizeOptions | Represents options that support page size |
#### Interfaces

| Interface | Description |
| --- | --- |
| IPageMarginOptions | Represents options that support page margins |
| IPageOrientationOptions | Represents options that support page orientation |
| IPageSizeOptions | Represents options that support page size |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### IPageMarginOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/ipagemarginoptions.md

#### IPageMarginOptions interface

Represents options that support page margins

```csharp
public interface IPageMarginOptions
```

#### Properties

| Name | Description |
| --- | --- |
| MarginSettings { get; set; } | Page margin settings |

### MarginSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/ipagemarginoptions/marginsettings.md

#### IPageMarginOptions.MarginSettings property

Page margin settings

```csharp
public PageMarginOptions MarginSettings { get; set; }
```

### IPageOrientationOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/ipageorientationoptions.md

#### IPageOrientationOptions interface

Represents options that support page orientation

```csharp
public interface IPageOrientationOptions
```

#### Properties

| Name | Description |
| --- | --- |
| OrientationSettings { get; set; } | Page orientation settings |

### OrientationSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/ipageorientationoptions/orientationsettings.md

#### IPageOrientationOptions.OrientationSettings property

Page orientation settings

```csharp
public PageOrientation OrientationSettings { get; set; }
```

### IPageSizeOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/ipagesizeoptions.md

#### IPageSizeOptions interface

Represents options that support page size

```csharp
public interface IPageSizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| SizeSettings { get; set; } | Page size settings |

### SizeSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/ipagesizeoptions/sizesettings.md

#### IPageSizeOptions.SizeSettings property

Page size settings

```csharp
public PageSizeOptions SizeSettings { get; set; }
```

### PageMarginOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagemarginoptions.md

#### PageMarginOptions class

Represents options that support page margins

```csharp
public class PageMarginOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| PageMarginOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Bottom { get; set; } | Desired page bottom margin in points. |
| Left { get; set; } | Desired page left margin in points. |
| Right { get; set; } | Desired page right margin in points. |
| Top { get; set; } | Desired page top margin in points. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### Bottom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagemarginoptions/bottom.md

#### PageMarginOptions.Bottom property

Desired page bottom margin in points.

```csharp
public float? Bottom { get; set; }
```

### Left
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagemarginoptions/left.md

#### PageMarginOptions.Left property

Desired page left margin in points.

```csharp
public float? Left { get; set; }
```

### PageMarginOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagemarginoptions/pagemarginoptions.md

#### PageMarginOptions constructor

The default constructor.

```csharp
public PageMarginOptions()
```

### Right
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagemarginoptions/right.md

#### PageMarginOptions.Right property

Desired page right margin in points.

```csharp
public float? Right { get; set; }
```

### Top
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagemarginoptions/top.md

#### PageMarginOptions.Top property

Desired page top margin in points.

```csharp
public float? Top { get; set; }
```

### PageSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize.md

#### PageSize class

Specifies page size

```csharp
public sealed class PageSize : Enumeration
```

#### Methods

| Name | Description |
| --- | --- |
| CompareTo(object) | Compares current object to other. |
| virtual Equals(Enumeration) | Determines whether two object instances are equal. |
| override Equals(object) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly A3 | 297 x 420 mm. |
| static readonly A4 | 210 x 297 mm. |
| static readonly A5 | 148 x 210 mm. |
| static readonly B4 | 250 x 353 mm |
| static readonly B5 | 176 x 250 mm. |
| static readonly Custom | Custom paper size. |
| static readonly EnvelopeDL | 110 x 220 mm. |
| static readonly Executive | 7.25 x 10.5 inches. |
| static readonly Folio | 8.5 x 13 inches. |
| static readonly Ledger | 17 x 11 inches. |
| static readonly Legal | 8.5 x 14 inches. |
| static readonly Letter | 8.5 x 11 inches. |
| static readonly Paper10x14 | 10 x 14 inches. |
| static readonly Paper11x17 | 11 x 17 inches. |
| static readonly Quarto | 8.47 x 10.83 inches. |
| static readonly Statement | 8.5 x 5.5 inches. |
| static readonly Tabloid | 11 x 17 inches. |
| static readonly Unset | Unset paper size. |

### A3
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/a3.md

#### PageSize.A3 field

297 x 420 mm.

```csharp
public static readonly PageSize A3;
```

### A4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/a4.md

#### PageSize.A4 field

210 x 297 mm.

```csharp
public static readonly PageSize A4;
```

### A5
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/a5.md

#### PageSize.A5 field

148 x 210 mm.

```csharp
public static readonly PageSize A5;
```

### B4
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/b4.md

#### PageSize.B4 field

250 x 353 mm

```csharp
public static readonly PageSize B4;
```

### B5
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/b5.md

#### PageSize.B5 field

176 x 250 mm.

```csharp
public static readonly PageSize B5;
```

### Custom
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/custom.md

#### PageSize.Custom field

Custom paper size.

```csharp
public static readonly PageSize Custom;
```

### EnvelopeDL
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/envelopedl.md

#### PageSize.EnvelopeDL field

110 x 220 mm.

```csharp
public static readonly PageSize EnvelopeDL;
```

### Executive
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/executive.md

#### PageSize.Executive field

7.25 x 10.5 inches.

```csharp
public static readonly PageSize Executive;
```

### Folio
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/folio.md

#### PageSize.Folio field

8.5 x 13 inches.

```csharp
public static readonly PageSize Folio;
```

### Ledger
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/ledger.md

#### PageSize.Ledger field

17 x 11 inches.

```csharp
public static readonly PageSize Ledger;
```

### Legal
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/legal.md

#### PageSize.Legal field

8.5 x 14 inches.

```csharp
public static readonly PageSize Legal;
```

### Letter
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/letter.md

#### PageSize.Letter field

8.5 x 11 inches.

```csharp
public static readonly PageSize Letter;
```

### Paper10x14
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/paper10x14.md

#### PageSize.Paper10x14 field

10 x 14 inches.

```csharp
public static readonly PageSize Paper10x14;
```

### Paper11x17
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/paper11x17.md

#### PageSize.Paper11x17 field

11 x 17 inches.

```csharp
public static readonly PageSize Paper11x17;
```

### Quarto
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/quarto.md

#### PageSize.Quarto field

8.47 x 10.83 inches.

```csharp
public static readonly PageSize Quarto;
```

### Statement
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/statement.md

#### PageSize.Statement field

8.5 x 5.5 inches.

```csharp
public static readonly PageSize Statement;
```

### Tabloid
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/tabloid.md

#### PageSize.Tabloid field

11 x 17 inches.

```csharp
public static readonly PageSize Tabloid;
```

### Unset
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesize/unset.md

#### PageSize.Unset field

Unset paper size.

```csharp
public static readonly PageSize Unset;
```

### PageSizeOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesizeoptions.md

#### PageSizeOptions class

Represents options that support page size

```csharp
public sealed class PageSizeOptions : ValueObject
```

#### Constructors

| Name | Description |
| --- | --- |
| PageSizeOptions() | Default constructor. Initializes `PageSize` to `Unset`. |

#### Properties

| Name | Description |
| --- | --- |
| PageHeight { get; set; } | Page height in points to be applied before conversion. When set, `PageSize` is automatically changed to `Custom`. |
| PageSize { get; set; } | Implements `PageSize` |
| PageWidth { get; set; } | Page width in points to be applied before conversion. When set, `PageSize` is automatically changed to `Custom`. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |

### PageHeight
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesizeoptions/pageheight.md

#### PageSizeOptions.PageHeight property

Page height in points to be applied before conversion. When set, `PageSize` is automatically changed to `Custom`.

```csharp
public float PageHeight { get; set; }
```

### PageSize
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesizeoptions/pagesize.md

#### PageSizeOptions.PageSize property

Implements `PageSize`

```csharp
public PageSize PageSize { get; set; }
```

### PageSizeOptions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesizeoptions/pagesizeoptions.md

#### PageSizeOptions constructor

Default constructor. Initializes `PageSize` to `Unset`.

```csharp
public PageSizeOptions()
```

### PageWidth
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.options/pagesizeoptions/pagewidth.md

#### PageSizeOptions.PageWidth property

Page width in points to be applied before conversion. When set, `PageSize` is automatically changed to `Custom`.

```csharp
public float PageWidth { get; set; }
```

### GroupDocs.Conversion
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion.md

The namespace provides classes to convert documents into all popular file formats in a simple and intuitive way.

#### Classes

| Class | Description |
| --- | --- |
| ConversionEvents | Aggregates conversion lifecycle event handlers. Pass an instance to the `Converter` constructor's `events` parameter or to the fluent `WithEvents` method. Prefer this over the individual `ConverterSettings` handler properties, which are obsolete. |
| ConvertContext | Defines convert context. |
| ConvertedContext | Defines convert context. |
| ConvertedPageContext | Defines convert page context. |
| Converter | Represents main class that controls document conversion process. |
| ConverterSettings | Defines settings for customizing `Converter` behaviour. |
| FluentConverter | Class for fluent conversion setup. |
| License | Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing). |
| LoadContext | Defines load context. |
| Metered | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |
| SaveContext | Defines save context. |
| SavePageContext | Defines save page context. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

### ConversionEvents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents.md

#### ConversionEvents class

Aggregates conversion lifecycle event handlers. Pass an instance to the `Converter` constructor's `events` parameter or to the fluent `WithEvents` method. Prefer this over the individual `ConverterSettings` handler properties, which are obsolete.

```csharp
public sealed class ConversionEvents
```

#### Constructors

| Name | Description |
| --- | --- |
| ConversionEvents() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| OnCompressionCompleted { get; set; } | Fired when compression of conversion output completes. Only invoked in builds that include the compression pipeline (LIB_ZIP). |
| OnConversionCompleted { get; set; } | Fired once when the conversion run finishes, regardless of success or failure. |
| OnConversionProgress { get; set; } | Fired periodically with conversion progress as a percentage (0–100). |
| OnConversionStarted { get; set; } | Fired once at the start of the conversion run, before any document is processed. |
| OnDocumentConverted { get; set; } | Fired once per whole-document conversion that completes successfully. |
| OnDocumentFailed { get; set; } | Fired once per whole-document conversion that fails. |
| OnFontSubstituted { get; set; } | Fired when a font referenced by the source document is not available and is substituted (either by a customer-supplied `FontSubstitute` rule, by the configured default font, or by the conversion pipeline's internal fallback). |
| OnPageConverted { get; set; } | Fired once per page when a per-page conversion completes successfully. |
| OnPageFailed { get; set; } | Fired once per page when a per-page conversion fails. |

### ConversionEvents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/conversionevents.md

#### ConversionEvents constructor

The default constructor.

```csharp
public ConversionEvents()
```

### OnCompressionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/oncompressioncompleted.md

#### ConversionEvents.OnCompressionCompleted property

Fired when compression of conversion output completes. Only invoked in builds that include the compression pipeline (LIB_ZIP).

```csharp
public Action<Stream> OnCompressionCompleted { get; set; }
```

### OnConversionCompleted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/onconversioncompleted.md

#### ConversionEvents.OnConversionCompleted property

Fired once when the conversion run finishes, regardless of success or failure.

```csharp
public Action OnConversionCompleted { get; set; }
```

### OnConversionProgress
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/onconversionprogress.md

#### ConversionEvents.OnConversionProgress property

Fired periodically with conversion progress as a percentage (0–100).

```csharp
public Action<byte> OnConversionProgress { get; set; }
```

### OnConversionStarted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/onconversionstarted.md

#### ConversionEvents.OnConversionStarted property

Fired once at the start of the conversion run, before any document is processed.

```csharp
public Action OnConversionStarted { get; set; }
```

### OnDocumentConverted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/ondocumentconverted.md

#### ConversionEvents.OnDocumentConverted property

Fired once per whole-document conversion that completes successfully.

```csharp
public Action<ConvertedContext> OnDocumentConverted { get; set; }
```

### OnDocumentFailed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/ondocumentfailed.md

#### ConversionEvents.OnDocumentFailed property

Fired once per whole-document conversion that fails.

```csharp
public Action<ConvertedContext, Exception> OnDocumentFailed { get; set; }
```

### OnFontSubstituted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/onfontsubstituted.md

#### ConversionEvents.OnFontSubstituted property

Fired when a font referenced by the source document is not available and is substituted (either by a customer-supplied `FontSubstitute` rule, by the configured default font, or by the conversion pipeline's internal fallback).

```csharp
public Action<FontSubstitutionContext> OnFontSubstituted { get; set; }
```

##### Remarks

The event is deduplicated per `(SourceFileName, OriginalFontName)` within a single `Converter.Convert(...)` call — subscribers receive at most one notification per missing font per source document. Fires synchronously on the conversion thread. Not raised for image conversions.

For presentation documents, font substitution is detected only on Windows, because the engine resolves it through platform-specific font matching that is unavailable on other operating systems.

### OnPageConverted
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/onpageconverted.md

#### ConversionEvents.OnPageConverted property

Fired once per page when a per-page conversion completes successfully.

```csharp
public Action<ConvertedPageContext> OnPageConverted { get; set; }
```

### OnPageFailed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/conversionevents/onpagefailed.md

#### ConversionEvents.OnPageFailed property

Fired once per page when a per-page conversion fails.

```csharp
public Action<ConvertedPageContext, Exception> OnPageFailed { get; set; }
```

### ConvertContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertcontext.md

#### ConvertContext class

Defines convert context.

```csharp
public sealed class ConvertContext
```

#### Properties

| Name | Description |
| --- | --- |
| CancellationToken { get; set; } | Cancellation token. |
| SourceFileName { get; } | Source file name. |
| SourceFormat { get; } | Source format. |

### CancellationToken
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertcontext/cancellationtoken.md

#### ConvertContext.CancellationToken property

Cancellation token.

```csharp
public CancellationToken CancellationToken { get; set; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertcontext/sourcefilename.md

#### ConvertContext.SourceFileName property

Source file name.

```csharp
public string SourceFileName { get; }
```

### SourceFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertcontext/sourceformat.md

#### ConvertContext.SourceFormat property

Source format.

```csharp
public FileType SourceFormat { get; }
```

### ConvertedContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext.md

#### ConvertedContext class

Defines convert context.

```csharp
public sealed class ConvertedContext
```

#### Properties

| Name | Description |
| --- | --- |
| ConvertedFormat { get; } | Converted format. |
| ConvertedStream { get; } | Converted file stream. |
| HierarchyLevel { get; } | Hierarchy level. |
| ItemIndex { get; } | Item index. |
| SourceFileName { get; } | Source file name. |
| SourceFormat { get; } | Source format. |

### ConvertedFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext/convertedformat.md

#### ConvertedContext.ConvertedFormat property

Converted format.

```csharp
public FileType ConvertedFormat { get; }
```

### ConvertedStream
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext/convertedstream.md

#### ConvertedContext.ConvertedStream property

Converted file stream.

```csharp
public Stream ConvertedStream { get; }
```

### HierarchyLevel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext/hierarchylevel.md

#### ConvertedContext.HierarchyLevel property

Hierarchy level.

```csharp
public int HierarchyLevel { get; }
```

### ItemIndex
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext/itemindex.md

#### ConvertedContext.ItemIndex property

Item index.

```csharp
public int ItemIndex { get; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext/sourcefilename.md

#### ConvertedContext.SourceFileName property

Source file name.

```csharp
public string SourceFileName { get; }
```

### SourceFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedcontext/sourceformat.md

#### ConvertedContext.SourceFormat property

Source format.

```csharp
public FileType SourceFormat { get; }
```

### ConvertedPageContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedpagecontext.md

#### ConvertedPageContext class

Defines convert page context.

```csharp
public sealed class ConvertedPageContext
```

#### Properties

| Name | Description |
| --- | --- |
| ConvertedFormat { get; } | Converted file format. |
| ConvertedStream { get; } | Converted file stream. |
| Page { get; } | Page number from the source document. |
| SourceFileName { get; } | Source file name. |
| SourceFormat { get; } | Source file format. |

### ConvertedFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedpagecontext/convertedformat.md

#### ConvertedPageContext.ConvertedFormat property

Converted file format.

```csharp
public FileType ConvertedFormat { get; }
```

### ConvertedStream
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedpagecontext/convertedstream.md

#### ConvertedPageContext.ConvertedStream property

Converted file stream.

```csharp
public Stream ConvertedStream { get; }
```

### Page
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedpagecontext/page.md

#### ConvertedPageContext.Page property

Page number from the source document.

```csharp
public int Page { get; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedpagecontext/sourcefilename.md

#### ConvertedPageContext.SourceFileName property

Source file name.

```csharp
public string SourceFileName { get; }
```

### SourceFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertedpagecontext/sourceformat.md

#### ConvertedPageContext.SourceFormat property

Source file format.

```csharp
public FileType SourceFormat { get; }
```

### Converter
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter.md

#### Converter class

Represents main class that controls document conversion process.

```csharp
public sealed class Converter : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Converter(Func&lt;Stream&gt;) | Initializes new instance of `Converter` class. |
| Converter(string) | Initializes new instance of `Converter` class. |
| Converter(Func&lt;Stream&gt;, Func&lt;ConverterSettings&gt;) | Initializes new instance of `Converter` class. |
| Converter(string, Func&lt;ConverterSettings&gt;) | Initializes new instance of `Converter` class. |
| Converter(Func&lt;Stream&gt;, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;) | Initializes new instance of `Converter` class with explicit conversion events. |
| Converter(Func&lt;Stream&gt;, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;) | Initializes new instance of `Converter` class. |
| Converter(string, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;) | Initializes new instance of `Converter` class with explicit conversion events. |
| Converter(string, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;) | Initializes new instance of `Converter` class. |
| Converter(Func&lt;Stream&gt;, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;) | Initializes new instance of `Converter` class with explicit conversion events. |
| Converter(string, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;) | Initializes new instance of `Converter` class with explicit conversion events. |

#### Methods

| Name | Description |
| --- | --- |
| Convert(ConvertOptions, Action&lt;ConvertedContext&gt;, CancellationToken) | Converts source document. Saves the whole converted document. |
| Convert(ConvertOptions, Action&lt;ConvertedPageContext&gt;, CancellationToken) | Converts source document. Saves the converted document page by page. |
| Convert(Func&lt;ConvertContext, ConvertOptions&gt;, Action&lt;ConvertedContext&gt;, CancellationToken) | Converts source document. Saves the whole converted document. |
| Convert(Func&lt;ConvertContext, ConvertOptions&gt;, Action&lt;ConvertedPageContext&gt;, CancellationToken) | Converts source document. Saves the converted document page by page. |
| Convert(Func&lt;SaveContext, Stream&gt;, ConvertOptions, CancellationToken) | Converts source document. Saves the whole converted document. |
| Convert(Func&lt;SaveContext, Stream&gt;, Func&lt;ConvertContext, ConvertOptions&gt;, CancellationToken) | Converts source document. Saves the whole converted document. |
| Convert(Func&lt;SavePageContext, Stream&gt;, ConvertOptions, CancellationToken) | Converts source document. Saves the converted document page by page. |
| Convert(Func&lt;SavePageContext, Stream&gt;, Func&lt;ConvertContext, ConvertOptions&gt;, CancellationToken) | Converts source document. Saves the converted document page by page. |
| Convert(string, ConvertOptions, CancellationToken) | Converts source document. Saves the whole converted document. |
| Dispose() | Releases resources. |
| GetDocumentInfo() | Gets source document info - pages count and other document properties specific to the file type. |
| GetDocumentInfo&lt;T&gt;() | Gets source document info - pages count and other document properties specific to the file type. |
| GetPossibleConversions() | Gets possible conversions for the source document. |
| IsDocumentPasswordProtected() | Checks is source document is password protected |
| static GetAllPossibleConversions() | Gets all supported conversions |
| static GetPossibleConversions(string) | Gets supported conversions for provided document extension |

##### Examples

**Basic conversion from file path:**

```csharp
// Convert DOCX to PDF
using (var converter = new Converter("sample.docx"))
{
    var options = new PdfConvertOptions();
    converter.Convert("output.pdf", options);
}
```

**Conversion with custom options:**

```csharp
// Convert DOCX to PDF with watermark and specific page range
using (var converter = new Converter("sample.docx"))
{
    var options = new PdfConvertOptions
    {
        PageNumber = 1,
        PagesCount = 3,
        Watermark = new WatermarkTextOptions("CONFIDENTIAL")
        {
            Color = System.Drawing.Color.Red,
            Width = 300,
            Height = 100
        }
    };
    converter.Convert("output.pdf", options);
}
```

**Conversion from stream:**

```csharp
// Convert document from stream to stream
using (var sourceStream = File.OpenRead("sample.docx"))
using (var converter = new Converter(() => sourceStream))
using (var outputStream = File.Create("output.pdf"))
{
    var options = new PdfConvertOptions();
    converter.Convert((SaveContext context) => outputStream, options);
}
```

**Conversion with load options (password-protected document):**

```csharp
// Load password-protected document and convert to PDF
var loadOptions = new WordProcessingLoadOptions
{
    Password = "secret_password"
};
using (var converter = new Converter("protected.docx", (LoadContext context) => loadOptions))
{
    var convertOptions = new PdfConvertOptions();
    converter.Convert("output.pdf", convertOptions);
}
```

**Page-by-page conversion:**

```csharp
// Convert document pages to separate image files
using (var converter = new Converter("sample.pdf"))
{
    var options = new ImageConvertOptions
    {
        Format = ImageFileType.Png
    };

    converter.Convert(
        (SavePageContext context) => File.Create($"page-{context.Page}.png"),
        options
    );
}
```

**Registering conversion event handlers (recommended path):**

```csharp
// Aggregate all event handlers in a ConversionEvents bag and pass it to the Converter.
var events = new ConversionEvents
{
    OnDocumentConverted = ctx       => Console.WriteLine($"Done: {ctx.SourceFileName}"),
    OnDocumentFailed    = (ctx, ex) => Console.Error.WriteLine($"Conversion of {ctx.SourceFileName} failed: {ex.Message}"),
    OnPageFailed        = (ctx, ex) => Console.Error.WriteLine($"Page {ctx.Page} of {ctx.SourceFileName} failed: {ex.Message}"),
};
using (var converter = new Converter("sample.docx", () => new ConverterSettings(), () => events))
{
    converter.Convert("output.pdf", new PdfConvertOptions());
}
```

The flat `OnConversionFailed`, `OnConversionByPageFailed`, and `OnCompressionCompleted` properties on `ConverterSettings` still work but are obsolete; new code should pass a `ConversionEvents` instance via the `events` constructor parameter.

**Get document information:**

```csharp
// Retrieve document metadata before conversion
using (var converter = new Converter("sample.docx"))
{
    var info = converter.GetDocumentInfo();
    Console.WriteLine($"Document has {info.PagesCount} pages");
    Console.WriteLine($"Format: {info.Format}");
    Console.WriteLine($"Size: {info.Size} bytes");
}
```

### Convert
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/convert.md

#### Convert(Func&lt;SaveContext, Stream&gt;, ConvertOptions, CancellationToken)

Converts source document. Saves the whole converted document.

```csharp
public void Convert(Func<SaveContext, Stream> targetStreamProvider, ConvertOptions convertOptions, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetStreamProvider | Func`2 | The delegate that saves converted document to a stream. |
| convertOptions | ConvertOptions | The convert options specific to desired target file type. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(ConvertOptions, Action&lt;ConvertedContext&gt;, CancellationToken)

Converts source document. Saves the whole converted document.

```csharp
public void Convert(ConvertOptions convertOptions, Action<ConvertedContext> documentCompleted, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptions | ConvertOptions | The convert options specific to desired target file type. |
| documentCompleted | Action`1 | Delegate that receives the converted document stream. Signature: `Action<ConvertedContext>`. The `ConvertedContext` parameter contains the converted document stream and metadata. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(Func&lt;SaveContext, Stream&gt;, Func&lt;ConvertContext, ConvertOptions&gt;, CancellationToken)

Converts source document. Saves the whole converted document.

```csharp
public void Convert(Func<SaveContext, Stream> targetStreamProvider, 
    Func<ConvertContext, ConvertOptions> convertOptionsProvider, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetStreamProvider | Func`2 | Delegate that provides the stream to save the converted document. Signature: `Func<SaveContext, Stream>`. The `SaveContext` parameter contains information about the save operation. |
| convertOptionsProvider | Func`2 | Delegate that provides conversion options. Signature: `Func<ConvertContext, ConvertOptions>`. The `ConvertContext` parameter contains information about the conversion operation. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(Func&lt;ConvertContext, ConvertOptions&gt;, Action&lt;ConvertedContext&gt;, CancellationToken)

Converts source document. Saves the whole converted document.

```csharp
public void Convert(Func<ConvertContext, ConvertOptions> convertOptionsProvider, 
    Action<ConvertedContext> documentCompleted, CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptionsProvider | Func`2 | Delegate that provides conversion options. Signature: `Func<ConvertContext, ConvertOptions>`. The `ConvertContext` parameter contains information about the conversion operation. |
| documentCompleted | Action`1 | Delegate that receives the converted document stream. Signature: `Action<ConvertedContext>`. The `ConvertedContext` parameter contains the converted document stream and metadata. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(string, ConvertOptions, CancellationToken)

Converts source document. Saves the whole converted document.

```csharp
public void Convert(string filePath, ConvertOptions convertOptions, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to the source document. |
| convertOptions | ConvertOptions | The convert options specific to desired target file type. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(Func&lt;SavePageContext, Stream&gt;, Func&lt;ConvertContext, ConvertOptions&gt;, CancellationToken)

Converts source document. Saves the converted document page by page.

```csharp
public void Convert(Func<SavePageContext, Stream> targetStreamProvider, 
    Func<ConvertContext, ConvertOptions> convertOptionsProvider, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetStreamProvider | Func`2 | Delegate that provides a stream for saving each converted page. Signature: `Func<SavePageContext, Stream>`. The `SavePageContext` parameter contains page number and document information. |
| convertOptionsProvider | Func`2 | Delegate that provides conversion options. Signature: `Func<ConvertContext, ConvertOptions>`. The `ConvertContext` parameter contains information about the conversion operation. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(Func&lt;SavePageContext, Stream&gt;, ConvertOptions, CancellationToken)

Converts source document. Saves the converted document page by page.

```csharp
public void Convert(Func<SavePageContext, Stream> targetStreamProvider, 
    ConvertOptions convertOptions, CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetStreamProvider | Func`2 | Delegate that provides a stream for saving each converted page. Signature: `Func<SavePageContext, Stream>`. The `SavePageContext` parameter contains page number and document information. |
| convertOptions | ConvertOptions | The convert options specific to desired target file type. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(ConvertOptions, Action&lt;ConvertedPageContext&gt;, CancellationToken)

Converts source document. Saves the converted document page by page.

```csharp
public void Convert(ConvertOptions convertOptions, Action<ConvertedPageContext> documentCompleted, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentCompleted | ConvertOptions | Delegate that receives each converted page. Signature: `Action<ConvertedPageContext>`. The `ConvertedPageContext` parameter contains page number, stream, source file name, and target file type. |
| convertOptions | Action`1 | The convert options specific to desired target file type. |
| cancellationToken | CancellationToken | The cancellation token. |

#### Convert(Func&lt;ConvertContext, ConvertOptions&gt;, Action&lt;ConvertedPageContext&gt;, CancellationToken)

Converts source document. Saves the converted document page by page.

```csharp
public void Convert(Func<ConvertContext, ConvertOptions> convertOptionsProvider, 
    Action<ConvertedPageContext> documentCompleted, CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptionsProvider | Func`2 | Delegate that provides conversion options. Signature: `Func<ConvertContext, ConvertOptions>`. The `ConvertContext` parameter contains information about the conversion operation. |
| documentCompleted | Action`1 | Delegate that receives each converted page. Signature: `Action<ConvertedPageContext>`. The `ConvertedPageContext` parameter contains page number, stream, source file name, and target file type. |
| cancellationToken | CancellationToken | The cancellation token. |

### Converter
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/converter.md

#### Converter(Func&lt;Stream&gt;)

Initializes new instance of `Converter` class.

```csharp
public Converter(Func<Stream> sourceStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStreamProvider | Func`1 | The method that returns readable stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourceStreamProvider* is null. |

#### Converter(Func&lt;Stream&gt;, Func&lt;ConverterSettings&gt;)

Initializes new instance of `Converter` class.

```csharp
public Converter(Func<Stream> sourceStreamProvider, Func<ConverterSettings> settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStreamProvider | Func`1 | The method that returns readable stream. |
| settings | Func`1 | The Converter settings. |

#### Converter(Func&lt;Stream&gt;, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;)

Initializes new instance of `Converter` class.

```csharp
public Converter(Func<Stream> sourceStreamProvider, Func<LoadContext, LoadOptions> loadOptions, 
    Func<ConverterSettings> settings = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStreamProvider | Func`1 | The method that returns readable stream. |
| loadOptions | Func`2 | Delegate that provides load options for the document. Signature: `Func<LoadContext, LoadOptions>`. The `LoadContext` parameter contains information about the document being loaded. |
| settings | Func`1 | The Converter settings. |

#### Converter(Func&lt;Stream&gt;, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;)

Initializes new instance of `Converter` class with explicit conversion events.

```csharp
public Converter(Func<Stream> sourceStreamProvider, Func<LoadContext, LoadOptions> loadOptions, 
    Func<ConverterSettings> settings, Func<ConversionEvents> events)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStreamProvider | Func`1 | The method that returns readable stream. |
| loadOptions | Func`2 | Delegate that provides load options for the document. |
| settings | Func`1 | The Converter settings. |
| events | Func`1 | Delegate that provides aggregated `ConversionEvents` registered for the converter's lifetime. |

#### Converter(Func&lt;Stream&gt;, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;)

Initializes new instance of `Converter` class with explicit conversion events.

```csharp
public Converter(Func<Stream> sourceStreamProvider, Func<ConverterSettings> settings, 
    Func<ConversionEvents> events)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStreamProvider | Func`1 | The method that returns readable stream. |
| settings | Func`1 | The Converter settings. |
| events | Func`1 | Delegate that provides aggregated `ConversionEvents` registered for the converter's lifetime. |

#### Converter(string)

Initializes new instance of `Converter` class.

```csharp
public Converter(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to the source document. |

#### Converter(string, Func&lt;ConverterSettings&gt;)

Initializes new instance of `Converter` class.

```csharp
public Converter(string filePath, Func<ConverterSettings> settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to the source document. |
| settings | Func`1 | The Converter settings. |

#### Converter(string, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;)

Initializes new instance of `Converter` class.

```csharp
public Converter(string filePath, Func<LoadContext, LoadOptions> loadOptions, 
    Func<ConverterSettings> settings = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to the source document. |
| loadOptions | Func`2 | Delegate that provides load options for the document. Signature: `Func<LoadContext, LoadOptions>`. The `LoadContext` parameter contains information about the document being loaded. |
| settings | Func`1 | The Converter settings. |

#### Converter(string, Func&lt;LoadContext, LoadOptions&gt;, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;)

Initializes new instance of `Converter` class with explicit conversion events.

```csharp
public Converter(string filePath, Func<LoadContext, LoadOptions> loadOptions, 
    Func<ConverterSettings> settings, Func<ConversionEvents> events)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to the source document. |
| loadOptions | Func`2 | Delegate that provides load options for the document. |
| settings | Func`1 | The Converter settings. |
| events | Func`1 | Delegate that provides aggregated `ConversionEvents` registered for the converter's lifetime. |

#### Converter(string, Func&lt;ConverterSettings&gt;, Func&lt;ConversionEvents&gt;)

Initializes new instance of `Converter` class with explicit conversion events.

```csharp
public Converter(string filePath, Func<ConverterSettings> settings, Func<ConversionEvents> events)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to the source document. |
| settings | Func`1 | The Converter settings. |
| events | Func`1 | Delegate that provides aggregated `ConversionEvents` registered for the converter's lifetime. |

### Dispose
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/dispose.md

#### Converter.Dispose method

Releases resources.

```csharp
public void Dispose()
```

### GetAllPossibleConversions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/getallpossibleconversions.md

#### Converter.GetAllPossibleConversions method

Gets all supported conversions

```csharp
public static IEnumerable<PossibleConversions> GetAllPossibleConversions()
```

##### Return Value

Collection of all possible conversions.

### GetDocumentInfo
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/getdocumentinfo.md

#### GetDocumentInfo()

Gets source document info - pages count and other document properties specific to the file type.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

Document information as `IDocumentInfo`.

#### GetDocumentInfo&lt;T&gt;()

Gets source document info - pages count and other document properties specific to the file type.

```csharp
public T GetDocumentInfo<T>()
    where T : IDocumentInfo
```

| Parameter | Description |
| --- | --- |
| T | The specific document info type. |

##### Return Value

Document information as the specified type T.

### GetPossibleConversions
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/getpossibleconversions.md

#### GetPossibleConversions()

Gets possible conversions for the source document.

```csharp
public PossibleConversions GetPossibleConversions()
```

##### Return Value

Possible conversions as `PossibleConversions`.

#### GetPossibleConversions(string)

Gets supported conversions for provided document extension

```csharp
public static PossibleConversions GetPossibleConversions(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | Document extension |

##### Return Value

Possible conversions for the specified extension as `PossibleConversions`.

##### Examples

Converter.GetPossibleConversions(".docx")

Converter.GetPossibleConversions("docx")

### IsDocumentPasswordProtected
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/converter/isdocumentpasswordprotected.md

#### Converter.IsDocumentPasswordProtected method

Checks is source document is password protected

```csharp
public bool IsDocumentPasswordProtected()
```

##### Return Value

true if document is password protected

### ConverterSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings.md

#### ConverterSettings class

Defines settings for customizing `Converter` behaviour.

```csharp
public sealed class ConverterSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| ConverterSettings() | Default constructor |

#### Properties

| Name | Description |
| --- | --- |
| Cache { get; set; } | The cache implementation used for storing conversion results. |
| FontDirectories { get; } | The custom font directories paths |
| Logger { get; set; } | The logger implementation used for logging conversion process. |
| ScanFontDirectoriesRecursively { get; set; } | If true, the converter will scan font directories recursively. |
| TempFolder { get; set; } | Temp folder used for conversion |

### Cache
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings/cache.md

#### ConverterSettings.Cache property

The cache implementation used for storing conversion results.

```csharp
public ICache Cache { get; set; }
```

### ConverterSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings/convertersettings.md

#### ConverterSettings constructor

Default constructor

```csharp
public ConverterSettings()
```

### FontDirectories
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings/fontdirectories.md

#### ConverterSettings.FontDirectories property

The custom font directories paths

```csharp
public List<string> FontDirectories { get; }
```

### Logger
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings/logger.md

#### ConverterSettings.Logger property

The logger implementation used for logging conversion process.

```csharp
public ILogger Logger { get; set; }
```

### ScanFontDirectoriesRecursively
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings/scanfontdirectoriesrecursively.md

#### ConverterSettings.ScanFontDirectoriesRecursively property

If true, the converter will scan font directories recursively.

```csharp
public bool ScanFontDirectoriesRecursively { get; set; }
```

### TempFolder
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/convertersettings/tempfolder.md

#### ConverterSettings.TempFolder property

Temp folder used for conversion

```csharp
public string TempFolder { get; set; }
```

### FluentConverter
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/fluentconverter.md

#### FluentConverter class

Class for fluent conversion setup.

```csharp
public static class FluentConverter
```

#### Methods

| Name | Description |
| --- | --- |
| static Load(Func&lt;Stream&gt;) | Configure source document stream |
| static Load(Func&lt;Stream[]&gt;) | Configure set of source documents streams |
| static Load(string) | Configure source document for conversion |
| static Load(string[]) | Configure set of source documents |
| static WithEvents(Action&lt;ConversionEvents&gt;) | Entry-stage variant of the fluent chain that starts with conversion lifecycle event handlers. Sits at the same entry stage as `WithSettings`, and the resulting `ConversionEvents` bag fires on every conversion run by the converter. |
| static WithSettings(Func&lt;ConverterSettings&gt;) | Configure conversion settings |

##### Remarks

Sample fluent conversion usage:

```csharp
var converter = FluentConverter.Create();
```

```csharp
FluentConverter.Load("")
    .ConvertTo("")
    .Convert();
```

```csharp
// Recommended: aggregate handlers via WithEvents at the early stage (before Load).
FluentConverter
    .WithEvents(e =>
    {
        e.OnDocumentConverted = ctx       => Console.WriteLine($"Done: {ctx.SourceFileName}");
        e.OnDocumentFailed    = (ctx, ex) => Console.Error.WriteLine(ex.Message);
    })
    .Load("input.docx")
    .ConvertTo("output.pdf").WithOptions(new PdfConvertOptions())
    .Convert();
```

```csharp
// Per-page mirror: per-page handlers via WithEvents at the early stage.
FluentConverter
    .WithEvents(e =>
    {
        e.OnPageConverted = ctx       => Console.WriteLine($"page {ctx.Page} done");
        e.OnPageFailed    = (ctx, ex) => Console.Error.WriteLine($"page {ctx.Page}: {ex.Message}");
    })
    .Load("input.pdf")
    .ConvertByPageTo(ctx => new FileStream($"page-{ctx.Page}.png", FileMode.Create))
    .WithOptions(new ImageConvertOptions { Format = ImageFileType.Png })
    .Convert();
```

```csharp
// Legacy chain still compiles unchanged (now backed by the obsolete staged interfaces):
FluentConverter.WithSettings(() => new ConverterSettings())
    .Load("").WithOptions(new PdfLoadOptions())
    .ConvertTo("").WithOptions(new PdfConvertOptions())
    .OnConversionCompleted(convertedDocumentStream => { })
    .Convert();
```

```csharp
FluentConverter.Load("").GetPossibleConversions();
FluentConverter.Load("").GetDocumentInfo();
FluentConverter.Load("").WithOptions(new PdfLoadOptions()).GetPossibleConversions();
FluentConverter.Load("").WithOptions(new PdfLoadOptions()).GetDocumentInfo();
```

### Load
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/fluentconverter/load.md

#### Load(string)

Configure source document for conversion

```csharp
public static IConversionLoadOptionsOrSourceDocumentLoaded Load(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Source document |

#### Load(string[])

Configure set of source documents

```csharp
public static IConversionLoadOptionsOrSourceDocumentLoaded Load(string[] fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String[] | Array of source files |

#### Load(Func&lt;Stream&gt;)

Configure source document stream

```csharp
public static IConversionLoadOptionsOrSourceDocumentLoaded Load(Func<Stream> documentStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | Func`1 | Source document stream provider |

#### Load(Func&lt;Stream[]&gt;)

Configure set of source documents streams

```csharp
public static IConversionLoadOptionsOrSourceDocumentLoaded Load(
    Func<Stream[]> documentStreamProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | Func`1 | Set of source documents streams provider |

### WithEvents
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/fluentconverter/withevents.md

#### FluentConverter.WithEvents method

Entry-stage variant of the fluent chain that starts with conversion lifecycle event handlers. Sits at the same entry stage as `WithSettings`, and the resulting `ConversionEvents` bag fires on every conversion run by the converter.

```csharp
public static IConversionFrom WithEvents(Action<ConversionEvents> configure)
```

| Parameter | Type | Description |
| --- | --- | --- |
| configure | Action`1 | Action that mutates the events bag. |

##### Return Value

The source-selection stage so that `Load` may be chained.

### WithSettings
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/fluentconverter/withsettings.md

#### FluentConverter.WithSettings method

Configure conversion settings

```csharp
public static IConversionFrom WithSettings(Func<ConverterSettings> settingsProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| settingsProvider | Func`1 | Provider of ConverterSettings |

### License
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/license.md

#### License class

Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing).

```csharp
public sealed class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| IsLicensed { get; } | Returns true if a valid license has been applied; false if the component is running in evaluation mode. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### IsLicensed
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/license/islicensed.md

#### License.IsLicensed property

Returns true if a valid license has been applied; false if the component is running in evaluation mode.

```csharp
public bool IsLicensed { get; }
```

### License
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/license/setlicense.md

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | The license stream. |

##### Examples

The following example demonstrates how to set a license passing Stream of the license file.

```csharp
using (FileStream licenseStream = new FileStream("LicenseFile.lic", FileMode.Open))
{
    GroupDocs.Conversion.License lic = new GroupDocs.Conversion.License();
    lic.SetLicense(licenseStream);
}
```

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | The license path. |

##### Examples

The following example demonstrates how to set a license passing a path to the license file.

```csharp
string licensePath = "GroupDocs.Conversion.lic";
GroupDocs.Conversion.License lic = new GroupDocs.Conversion.License();
lic.SetLicense(licensePath);
```

### LoadContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/loadcontext.md

#### LoadContext class

Defines load context.

```csharp
public sealed class LoadContext
```

#### Properties

| Name | Description |
| --- | --- |
| HierarchyLevel { get; } | Hierarchy level. |
| ItemIndex { get; } | Item index. |
| SourceFileName { get; } | Source file name. |
| SourceFormat { get; } | Source format. |
| SourceStream { get; } | Source stream. |

### HierarchyLevel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/loadcontext/hierarchylevel.md

#### LoadContext.HierarchyLevel property

Hierarchy level.

```csharp
public int HierarchyLevel { get; }
```

### ItemIndex
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/loadcontext/itemindex.md

#### LoadContext.ItemIndex property

Item index.

```csharp
public int ItemIndex { get; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/loadcontext/sourcefilename.md

#### LoadContext.SourceFileName property

Source file name.

```csharp
public string SourceFileName { get; }
```

### SourceFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/loadcontext/sourceformat.md

#### LoadContext.SourceFormat property

Source format.

```csharp
public FileType SourceFormat { get; }
```

### SourceStream
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/loadcontext/sourcestream.md

#### LoadContext.SourceStream property

Source stream.

```csharp
public Stream SourceStream { get; }
```

### Metered
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/metered.md

#### Metered class

Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license.

```csharp
public sealed class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Activates product with Metered keys. |
| static GetConsumptionCredit() | Retrieves count of credits consumed. |
| static GetConsumptionQuantity() | Retrieves amount of MBs processed. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves count of credits consumed.

```csharp
public static decimal GetConsumptionCredit()
```

##### Examples

Following example demonstrates how to retrieve count of credits consumed.

```csharp
string publicKey = "Public Key";
string privateKey = "Private Key";

Metered metered = new Metered();
metered.SetMeteredKey(publicKey, privateKey);

decimal creditsConsumed = Metered.GetConsumptionCredit();
```

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Retrieves amount of MBs processed.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Examples

Following example demonstrates how to retrieve amount of MBs processed.

```csharp
string publicKey = "Public Key";
string privateKey = "Private Key";

Metered metered = new Metered();
metered.SetMeteredKey(publicKey, privateKey);

decimal mbProcessed = Metered.GetConsumptionQuantity();
```

### Metered
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Activates product with Metered keys.

```csharp
public void SetMeteredKey(string publicKey, string privateKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | String | The public key. |
| privateKey | String | The private key. |

##### Examples

Following example demonstrates how to activate product with Metered keys.

```csharp
string publicKey = "Public Key";
string privateKey = "Private Key";

Metered metered = new Metered();
metered.SetMeteredKey(publicKey, privateKey);
```

### SaveContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savecontext.md

#### SaveContext class

Defines save context.

```csharp
public sealed class SaveContext
```

#### Properties

| Name | Description |
| --- | --- |
| HierarchyLevel { get; } | Hierarchy level. |
| ItemIndex { get; } | Item index. |
| SourceFileName { get; } | Source file name. |
| SourceFormat { get; } | Source format. |
| TargetFormat { get; } | Target format. |

### HierarchyLevel
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savecontext/hierarchylevel.md

#### SaveContext.HierarchyLevel property

Hierarchy level.

```csharp
public int HierarchyLevel { get; }
```

### ItemIndex
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savecontext/itemindex.md

#### SaveContext.ItemIndex property

Item index.

```csharp
public int ItemIndex { get; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savecontext/sourcefilename.md

#### SaveContext.SourceFileName property

Source file name.

```csharp
public string SourceFileName { get; }
```

### SourceFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savecontext/sourceformat.md

#### SaveContext.SourceFormat property

Source format.

```csharp
public FileType SourceFormat { get; }
```

### TargetFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savecontext/targetformat.md

#### SaveContext.TargetFormat property

Target format.

```csharp
public FileType TargetFormat { get; }
```

### SavePageContext
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savepagecontext.md

#### SavePageContext class

Defines save page context.

```csharp
public sealed class SavePageContext
```

#### Properties

| Name | Description |
| --- | --- |
| Page { get; } | Page number from the source document. |
| SourceFileName { get; } | Source file name. |
| SourceFormat { get; } | Source format. |
| TargetFormat { get; } | Target format. |

### Page
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savepagecontext/page.md

#### SavePageContext.Page property

Page number from the source document.

```csharp
public int Page { get; }
```

### SourceFileName
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savepagecontext/sourcefilename.md

#### SavePageContext.SourceFileName property

Source file name.

```csharp
public string SourceFileName { get; }
```

### SourceFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savepagecontext/sourceformat.md

#### SavePageContext.SourceFormat property

Source format.

```csharp
public FileType SourceFormat { get; }
```

### TargetFormat
Path: https://reference.groupdocs.com/conversion/net/groupdocs.conversion/savepagecontext/targetformat.md

#### SavePageContext.TargetFormat property

Target format.

```csharp
public FileType TargetFormat { get; }
```

## Node.js

### GroupDocs.Conversion for Node.js via Java
Path: https://reference.groupdocs.com/conversion/nodejs-java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.conversion | The scope for GroupDocs.Conversion classes |
| com.groupdocs.conversion.caching | The GroupDocs.Conversion.Caching namespace provides classes for customizing caching behaviour. |
| com.groupdocs.conversion.contracts | The GroupDocs.Conversion.Contracts namespace provides members to instantiate and release output document, manage font substitutions etc. |
| com.groupdocs.conversion.contracts.documentinfo | The GroupDocs.Conversion.Contracts.Documentinfo namespace provides metadata for a document. |
| com.groupdocs.conversion.filetypes | The GroupDocs.Conversion.FileTypes namespace provides classes which represent supported file types. |
| com.groupdocs.conversion.licensing | The GroupDocs.Conversion.Legacy.Licensing namespace provides classes for applying of the license |
| com.groupdocs.conversion.logging | The GroupDocs.Conversion.Logging namespace provides classes for customizing logging behaviour. |
| com.groupdocs.conversion.options.convert | The GroupDocs.Conversion.Options.Convert namespace provides classes to specify additional options for document conversion process. |
| com.groupdocs.conversion.options.load | The GroupDocs.Conversion.Options.Load namespace provides classes to specify additional options for document loading process. |
| com.groupdocs.conversion.reporting | The GroupDocs.Conversion.Options.Load namespace provides classes to implement converter listening. |

### com.groupdocs.conversion.caching
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.caching.md

The GroupDocs.Conversion.Caching namespace provides classes for customizing caching behaviour.

**Learn more**More about caching and optimizing conversion process performance: [Caching conversion results][]

[Caching conversion results]: https://docs.groupdocs.com/display/conversionnet/Caching

#### Classes

| Class | Description |
| --- | --- |
| FileCache | File caching behaviour. |
| MemoryCache | Memory caching behaviour. |

### FileCache
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.caching/filecache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.caching.ICache
```
public final class FileCache implements ICache
```

File caching behaviour. Means that cache is stored on the file system **Learn more**More about caching and optimizing conversion process performance: [Caching conversion results][]

[Caching conversion results]: https://docs.groupdocs.com/display/conversionnet/Caching
#### Constructors

| Constructor | Description |
| --- | --- |
| FileCache(String cachePath) | Creates new instance of FileCache class |
#### Methods

| Method | Description |
| --- | --- |
| set(String key, Object value) | Inserts a cache entry into the cache. |
| tryGetValue(String key) | Gets the entry associated with this key if present. |
| getKeys(String filter) | Returns all keys matching filter. |
##### FileCache(String cachePath)
```
public FileCache(String cachePath)
```

Creates new instance of FileCache class

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.lang.String | Relative or absolute path where document cache will be stored |

##### set(String key, Object value)
```
public void set(String key, Object value)
```

Inserts a cache entry into the cache.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A unique identifier for the cache entry. |
| value | java.lang.Object | The object to insert. |

##### tryGetValue(String key)
```
public Object tryGetValue(String key)
```

Gets the entry associated with this key if present.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry. |

**Returns:**
java.lang.Object - Object if the key was found or else null.
##### getKeys(String filter)
```
public Iterable<String> getKeys(String filter)
```

Returns all keys matching filter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | The filter to use. |

**Returns:**
java.lang.Iterable<java.lang.String> - Keys matching the filter.

### MemoryCache
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.caching/memorycache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.caching.ICache
```
public class MemoryCache implements ICache
```

Memory caching behaviour. Means that cache is stored in the memory **Learn more**More about caching and optimizing conversion process performance: [Caching conversion results][]

[Caching conversion results]: https://docs.groupdocs.com/display/conversionnet/Caching
#### Constructors

| Constructor | Description |
| --- | --- |
| MemoryCache() | Creates new instance of MemoryCache class |
#### Methods

| Method | Description |
| --- | --- |
| set(String key, Object value) | Inserts a cache entry into the cache. |
| tryGetValue(String key) | Gets the entry associated with this key if present. |
| getKeys(String filter) | Returns all keys matching filter. |
##### MemoryCache()
```
public MemoryCache()
```

Creates new instance of MemoryCache class

##### set(String key, Object value)
```
public void set(String key, Object value)
```

Inserts a cache entry into the cache.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A unique identifier for the cache entry. |
| value | java.lang.Object | The object to insert. |

##### tryGetValue(String key)
```
public Object tryGetValue(String key)
```

Gets the entry associated with this key if present.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry. |

**Returns:**
java.lang.Object - The located value or null.
##### getKeys(String filter)
```
public Iterable<String> getKeys(String filter)
```

Returns all keys matching filter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | he filter to use. |

**Returns:**
java.lang.Iterable<java.lang.String> - Keys matching the filter.

### com.groupdocs.conversion.contracts.documentinfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo.md

The GroupDocs.Conversion.Contracts.Documentinfo namespace provides metadata for a document.

#### Classes

| Class | Description |
| --- | --- |
| AudioDocumentInfo | Contains Audio document metadata |
| CadDocumentInfo | Contains Cad document metadata |
| CgmDocumentInfo | Contains Cgm document metadata |
| CsvDocumentInfo | Contains Csv document metadata |
| DiagramDocumentInfo | Contains Diagram document metadata |
| DjVuDocumentInfo | Contains DjVu document metadata |
| DocumentInfo | Provides base implementation for retrieving polymorphic document information |
| EmailDocumentInfo | Contains Email document metadata |
| EmptyDocumentInfo | Empty Document Info |
| EpsDocumentInfo | Contains Ps document metadata |
| EpubDocumentInfo | Contains Epub document metadata |
| FontDocumentInfo | Contains Font document metadata |
| IcoDocumentInfo | Contains Ico document metadata |
| ImageDocumentInfo | Contains Image document metadata |
| JsonDocumentInfo | Contains Json document metadata |
| MarkdownDocumentInfo | Contains Md document metadata |
| NoteDocumentInfo | Contains Note document metadata |
| OlmDocumentInfo | Contains olm document metadata |
| OlmFolderInfo | Olm Folder info |
| PasswordProtectedDocumentInfo | Provided document is password protected |
| PclDocumentInfo | Contains Pcl document metadata |
| PdfDocumentInfo | Contains Pdf document metadata |
| PersonalStorageDocumentInfo | Contains personal storage document metadata |
| PersonalStorageFolderInfo | Personal Storage Folder info |
| PresentationDocumentInfo | Contains Presentation document metadata |
| ProjectManagementDocumentInfo | Contains ProjectManagement document metadata |
| PsDocumentInfo | Contains Ps document metadata |
| PsdDocumentInfo | Contains Psd document metadata |
| PublisherDocumentInfo | Contains Publisher document metadata |
| SpreadsheetDocumentInfo | Contains Spreadsheet document metadata |
| SvgDocumentInfo | Contains Svg document metadata |
| TableOfContentsItem | Contains Table of contents item metadata |
| TexDocumentInfo | Contains Tex document metadata |
| TsvDocumentInfo | Contains Tsv document metadata |
| TxtDocumentInfo | Contains Txt document metadata |
| VcfDocumentInfo | Contains Vcf document metadata |
| VideoDocumentInfo | Contains Video document metadata |
| WebDocumentInfo | Contains Web document metadata |
| WordProcessingDocumentInfo | Contains Wordprocessing document metadata |
| XmlDocumentInfo | Contains Xml document metadata |
| XpsDocumentInfo | Contains Xps document metadata |
| XslFoDocumentInfo | Contains XslFo document metadata |

### AudioDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/audiodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class AudioDocumentInfo extends DocumentInfo
```

Contains Audio document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| AudioDocumentInfo(FileType format, long size) |  |
##### AudioDocumentInfo(FileType format, long size)
```
public AudioDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### CadDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/caddocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class CadDocumentInfo extends DocumentInfo
```

Contains Cad document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| CadDocumentInfo(Image cad, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | width |
| getHeight() | height |
| getLayouts() | layouts in the document |
| getLayers() | layers in the document |
##### CadDocumentInfo(Image cad, FileType format, long size)
```
public CadDocumentInfo(Image cad, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cad | com.aspose.cad.Image |  |
| format | FileType |  |
| size | long |  |

##### getWidth()
```
public int getWidth()
```

width

**Returns:**
int - width
##### getHeight()
```
public int getHeight()
```

height

**Returns:**
int - height
##### getLayouts()
```
public List<String> getLayouts()
```

layouts in the document

**Returns:**
java.util.List<java.lang.String> - layouts in the document
##### getLayers()
```
public List<String> getLayers()
```

layers in the document

**Returns:**
java.util.List<java.lang.String> - layers in the document

### CgmDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/cgmdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class CgmDocumentInfo extends PdfDocumentInfo
```

Contains Cgm document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| CgmDocumentInfo(Document cgm, FileType format, long size) |  |
##### CgmDocumentInfo(Document cgm, FileType format, long size)
```
public CgmDocumentInfo(Document cgm, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cgm | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### CsvDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/csvdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.SpreadsheetDocumentInfo
```
public class CsvDocumentInfo extends SpreadsheetDocumentInfo
```

Contains Csv document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| CsvDocumentInfo(Workbook csv, FileType format, long size) |  |
##### CsvDocumentInfo(Workbook csv, FileType format, long size)
```
public CsvDocumentInfo(Workbook csv, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| csv | com.aspose.cells.Workbook |  |
| format | FileType |  |
| size | long |  |

### DiagramDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/diagramdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class DiagramDocumentInfo extends DocumentInfo
```

Contains Diagram document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramDocumentInfo(Diagram diagram, FileType format, long size) |  |
##### DiagramDocumentInfo(Diagram diagram, FileType format, long size)
```
public DiagramDocumentInfo(Diagram diagram, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| diagram | com.aspose.diagram.Diagram |  |
| format | FileType |  |
| size | long |  |

### DjVuDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/djvudocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.ImageDocumentInfo
```
public class DjVuDocumentInfo extends ImageDocumentInfo
```

Contains DjVu document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| DjVuDocumentInfo(DjvuImage image, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getVerticalResolution() | Gets vertical resolution |
| getHorizontalResolution() | Get horizontal resolution |
| getOpacity() | Gets image opacity |
##### DjVuDocumentInfo(DjvuImage image, FileType format, long size)
```
public DjVuDocumentInfo(DjvuImage image, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.imaging.fileformats.djvu.DjvuImage |  |
| format | FileType |  |
| size | long |  |

##### getVerticalResolution()
```
public double getVerticalResolution()
```

Gets vertical resolution

**Returns:**
double - vertical resolution
##### getHorizontalResolution()
```
public double getHorizontalResolution()
```

Get horizontal resolution

**Returns:**
double - horizontal resolution
##### getOpacity()
```
public float getOpacity()
```

Gets image opacity

**Returns:**
float - image opacity

### DocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.documentinfo.IDocumentInfo
```
public abstract class DocumentInfo implements IDocumentInfo
```

Provides base implementation for retrieving polymorphic document information
#### Methods

| Method | Description |
| --- | --- |
| getPropertyNames() | \{@inheritDoc\} |
| getProperty(String propertyName) | \{@inheritDoc\} |
| getPagesCount() | \{@inheritDoc\} |
| getFormat() | \{@inheritDoc\} |
| getSize() | \{@inheritDoc\} |
| getCreationDate() | \{@inheritDoc\} |
##### getPropertyNames()
```
public List<String> getPropertyNames()
```

List of all properties which could be get for the current document info

**Returns:**
java.util.List<java.lang.String>
##### getProperty(String propertyName)
```
public String getProperty(String propertyName)
```

Get value for a property provided as a key

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String |  |

**Returns:**
java.lang.String
##### getPagesCount()
```
public int getPagesCount()
```

Document pages count.

**Returns:**
int
##### getFormat()
```
public String getFormat()
```

Document format

**Returns:**
java.lang.String
##### getSize()
```
public long getSize()
```

Document size in bytes

**Returns:**
long
##### getCreationDate()
```
public Date getCreationDate()
```

Document creation date

**Returns:**
java.util.Date

### EmailDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/emaildocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class EmailDocumentInfo extends DocumentInfo
```

Contains Email document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailDocumentInfo(MailMessage mail, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| isSigned() | Gets is signed |
| isEncrypted() | Gets is encrypted |
| isHtml() | Gets is html |
| getAttachmentsCount() | Gets attachments count |
| getAttachmentsNames() | Gets attachments names |
##### EmailDocumentInfo(MailMessage mail, FileType format, long size)
```
public EmailDocumentInfo(MailMessage mail, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mail | com.aspose.email.MailMessage |  |
| format | FileType |  |
| size | long |  |

##### isSigned()
```
public boolean isSigned()
```

Gets is signed

**Returns:**
boolean - true if is signed
##### isEncrypted()
```
public boolean isEncrypted()
```

Gets is encrypted

**Returns:**
boolean - true if is encrypted
##### isHtml()
```
public boolean isHtml()
```

Gets is html

**Returns:**
boolean - true if is html
##### getAttachmentsCount()
```
public int getAttachmentsCount()
```

Gets attachments count

**Returns:**
int - attachments count
##### getAttachmentsNames()
```
public List<String> getAttachmentsNames()
```

Gets attachments names

**Returns:**
java.util.List<java.lang.String> - attachments names

### EmptyDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/emptydocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class EmptyDocumentInfo extends DocumentInfo
```

Empty Document Info
#### Constructors

| Constructor | Description |
| --- | --- |
| EmptyDocumentInfo(FileType format, long size) | C-tor |
##### EmptyDocumentInfo(FileType format, long size)
```
public EmptyDocumentInfo(FileType format, long size)
```

C-tor

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType | Document file format |
| size | long | Document size |

### EpsDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/epsdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.ImageDocumentInfo
```
public class EpsDocumentInfo extends ImageDocumentInfo
```

Contains Ps document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| EpsDocumentInfo(Image ps, FileType format, long size) |  |
##### EpsDocumentInfo(Image ps, FileType format, long size)
```
public EpsDocumentInfo(Image ps, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ps | com.aspose.imaging.Image |  |
| format | FileType |  |
| size | long |  |

### EpubDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/epubdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class EpubDocumentInfo extends PdfDocumentInfo
```

Contains Epub document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| EpubDocumentInfo(Document epub, FileType format, long size) |  |
##### EpubDocumentInfo(Document epub, FileType format, long size)
```
public EpubDocumentInfo(Document epub, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| epub | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### FontDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/fontdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class FontDocumentInfo extends DocumentInfo
```

Contains Font document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| FontDocumentInfo(FileType format, long size) |  |
##### FontDocumentInfo(FileType format, long size)
```
public FontDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### IcoDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/icodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.ImageDocumentInfo
```
public class IcoDocumentInfo extends ImageDocumentInfo
```

Contains Ico document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IcoDocumentInfo(Image ico, FileType format, long size) |  |
##### IcoDocumentInfo(Image ico, FileType format, long size)
```
public IcoDocumentInfo(Image ico, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ico | com.aspose.imaging.Image |  |
| format | FileType |  |
| size | long |  |

### ImageDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/imagedocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class ImageDocumentInfo extends DocumentInfo
```

Contains Image document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageDocumentInfo(Image image, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets bits per pixel |
| getHeight() | Gets height |
| getWidth() | Gets width |
##### ImageDocumentInfo(Image image, FileType format, long size)
```
public ImageDocumentInfo(Image image, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.imaging.Image |  |
| format | FileType |  |
| size | long |  |

##### getBitsPerPixel()
```
public int getBitsPerPixel()
```

Gets bits per pixel

**Returns:**
int - bits per pixel
##### getHeight()
```
public int getHeight()
```

Gets height

**Returns:**
int - height
##### getWidth()
```
public int getWidth()
```

Gets width

**Returns:**
int - width

### JsonDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/jsondocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class JsonDocumentInfo extends DocumentInfo
```

Contains Json document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonDocumentInfo(FileType format, long size) |  |
##### JsonDocumentInfo(FileType format, long size)
```
public JsonDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### MarkdownDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/markdowndocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.WordProcessingDocumentInfo
```
public class MarkdownDocumentInfo extends WordProcessingDocumentInfo
```

Contains Md document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| MarkdownDocumentInfo(Document txt, FileType format, long size) |  |
##### MarkdownDocumentInfo(Document txt, FileType format, long size)
```
public MarkdownDocumentInfo(Document txt, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| txt | com.aspose.words.Document |  |
| format | FileType |  |
| size | long |  |

### NoteDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/notedocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class NoteDocumentInfo extends DocumentInfo
```

Contains Note document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| NoteDocumentInfo(Document note, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets title |
##### NoteDocumentInfo(Document note, FileType format, long size)
```
public NoteDocumentInfo(Document note, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| note | com.aspose.note.Document |  |
| format | FileType |  |
| size | long |  |

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title

### OlmDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/olmdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class OlmDocumentInfo extends DocumentInfo
```

Contains olm document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| OlmDocumentInfo(OlmStorage storage, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getFolders() | Folders in the storage |
##### OlmDocumentInfo(OlmStorage storage, long size)
```
public OlmDocumentInfo(OlmStorage storage, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storage | com.aspose.email.OlmStorage |  |
| size | long |  |

##### getFolders()
```
public List<OlmFolderInfo> getFolders()
```

Folders in the storage

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.OlmFolderInfo>

### OlmFolderInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/olmfolderinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class OlmFolderInfo extends ValueObject
```

Olm Folder info
#### Constructors

| Constructor | Description |
| --- | --- |
| OlmFolderInfo(String name, int count) |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Name of the folder |
| getItemsCount() | Count of the items in the folder |
| toString() | String representation of personal storage folder info String representation of personal storage folder info in format FolderName (ItemsCount) |
##### OlmFolderInfo(String name, int count)
```
public OlmFolderInfo(String name, int count)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |
| count | int |  |

##### getName()
```
public String getName()
```

Name of the folder

**Returns:**
java.lang.String
##### getItemsCount()
```
public int getItemsCount()
```

Count of the items in the folder

**Returns:**
int
##### toString()
```
public String toString()
```

String representation of personal storage folder info String representation of personal storage folder info in format FolderName (ItemsCount)

**Returns:**
java.lang.String

### PasswordProtectedDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/passwordprotecteddocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PasswordProtectedDocumentInfo extends DocumentInfo
```

Provided document is password protected
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordProtectedDocumentInfo(FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| isPasswordProtected() | Gets is document password protected |
##### PasswordProtectedDocumentInfo(FileType format, long size)
```
public PasswordProtectedDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is document password protected

**Returns:**
boolean

### PclDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/pcldocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PclDocumentInfo extends DocumentInfo
```

Contains Pcl document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PclDocumentInfo(Document pcl, FileType format, long size) |  |
##### PclDocumentInfo(Document pcl, FileType format, long size)
```
public PclDocumentInfo(Document pcl, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pcl | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### PdfDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/pdfdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PdfDocumentInfo extends DocumentInfo
```

Contains Pdf document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDocumentInfo(Document pdf, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets version |
| getTitle() | Gets title |
| getAuthor() | Gets author |
| isPasswordProtected() | Gets is encrypted |
| isLandscape() | Gets is page landscaped |
| getHeight() | Gets page height |
| getWidth() | Gets page width |
| getTableOfContents() | Gets Table of contents |
| setTableOfContents(List<TableOfContentsItem> tableOfContents) | Sets Table of contents |
##### PdfDocumentInfo(Document pdf, FileType format, long size)
```
public PdfDocumentInfo(Document pdf, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdf | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

##### getVersion()
```
public String getVersion()
```

Gets version

**Returns:**
java.lang.String - version
##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title
##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author
##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is encrypted

**Returns:**
boolean - true if encrypted
##### isLandscape()
```
public boolean isLandscape()
```

Gets is page landscaped

**Returns:**
boolean - true if page is landscaped
##### getHeight()
```
public double getHeight()
```

Gets page height

**Returns:**
double - page height
##### getWidth()
```
public double getWidth()
```

Gets page width

**Returns:**
double - page width
##### getTableOfContents()
```
public List<TableOfContentsItem> getTableOfContents()
```

Gets Table of contents

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.TableOfContentsItem> - Table of contents
##### setTableOfContents(List<TableOfContentsItem> tableOfContents)
```
public void setTableOfContents(List<TableOfContentsItem> tableOfContents)
```

Sets Table of contents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tableOfContents | java.util.List<com.groupdocs.conversion.contracts.documentinfo.TableOfContentsItem> | Table of contents |

### PersonalStorageDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/personalstoragedocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PersonalStorageDocumentInfo extends DocumentInfo
```

Contains personal storage document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| isPasswordProtected() | Is storage password protected |
| getRootFolderName() | Root folder name |
| getContentCount() | Get count of contents in the root folder |
| getFolders() | Folders in the storage |
##### PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size)
```
public PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storage | com.aspose.email.PersonalStorage |  |
| format | FileType |  |
| size | long |  |

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Is storage password protected

**Returns:**
boolean
##### getRootFolderName()
```
public String getRootFolderName()
```

Root folder name

**Returns:**
java.lang.String - Root folder name
##### getContentCount()
```
public int getContentCount()
```

Get count of contents in the root folder

**Returns:**
int - count of contents in the root folder
##### getFolders()
```
public List<PersonalStorageFolderInfo> getFolders()
```

Folders in the storage

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageFolderInfo> - Folders in the storage

### PersonalStorageFolderInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/personalstoragefolderinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class PersonalStorageFolderInfo extends ValueObject
```

Personal Storage Folder info
#### Constructors

| Constructor | Description |
| --- | --- |
| PersonalStorageFolderInfo(String name, List<PersonalStorageItemInfo> items) |  |
#### Fields

| Field | Description |
| --- | --- |
| items |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Name of the folder |
| getItemsCount() | Count of the items in the folder |
| getSubFolders() |  |
| getItems() |  |
| toString() | String representation of personal storage folder info |
##### PersonalStorageFolderInfo(String name, List<PersonalStorageItemInfo> items)
```
public PersonalStorageFolderInfo(String name, List<PersonalStorageItemInfo> items)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |
| items | java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageItemInfo> |  |

##### items
```
public List<PersonalStorageItemInfo> items
```

##### getName()
```
public String getName()
```

Name of the folder

**Returns:**
java.lang.String
##### getItemsCount()
```
public int getItemsCount()
```

Count of the items in the folder

**Returns:**
int
##### getSubFolders()
```
public List<PersonalStorageFolderInfo> getSubFolders()
```

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageFolderInfo>
##### getItems()
```
public List<PersonalStorageItemInfo> getItems()
```

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.PersonalStorageItemInfo>
##### toString()
```
public String toString()
```

String representation of personal storage folder info

**Returns:**
java.lang.String - String representation of personal storage folder info in format FolderName (ItemsCount)

### PresentationDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/presentationdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PresentationDocumentInfo extends DocumentInfo
```

Contains Presentation document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationDocumentInfo(Presentation presentation, FileType format, long size, boolean isPasswordProtected) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets title |
| setTitle(String title) | Sets title |
| getAuthor() | Gets author |
| setAuthor(String author) | Sets author |
| isPasswordProtected() | Gets is the document password protected |
##### PresentationDocumentInfo(Presentation presentation, FileType format, long size, boolean isPasswordProtected)
```
public PresentationDocumentInfo(Presentation presentation, FileType format, long size, boolean isPasswordProtected)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| presentation | com.aspose.slides.Presentation |  |
| format | FileType |  |
| size | long |  |
| isPasswordProtected | boolean |  |

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title
##### setTitle(String title)
```
public void setTitle(String title)
```

Sets title

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | title |

##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author
##### setAuthor(String author)
```
public void setAuthor(String author)
```

Sets author

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| author | java.lang.String | author |

##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is the document password protected

**Returns:**
boolean - `true` if document is password protected

### ProjectManagementDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/projectmanagementdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class ProjectManagementDocumentInfo extends DocumentInfo
```

Contains ProjectManagement document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementDocumentInfo(Project project, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTasksCount() | Gets task count |
| getStartDate() | Gets Project start date |
| getEndDate() | Gets Project end date |
##### ProjectManagementDocumentInfo(Project project, FileType format, long size)
```
public ProjectManagementDocumentInfo(Project project, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| project | com.aspose.tasks.Project |  |
| format | FileType |  |
| size | long |  |

##### getTasksCount()
```
public int getTasksCount()
```

Gets task count

**Returns:**
int - task count
##### getStartDate()
```
public Date getStartDate()
```

Gets Project start date

**Returns:**
java.util.Date - Project start date
##### getEndDate()
```
public Date getEndDate()
```

Gets Project end date

**Returns:**
java.util.Date - Project end date

### PsdDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/psddocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PsdDocumentInfo extends DocumentInfo
```

Contains Psd document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PsdDocumentInfo(Image image, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets bits per pixel |
| getHeight() | Gets height |
| getWidth() | Gets width |
##### PsdDocumentInfo(Image image, FileType format, long size)
```
public PsdDocumentInfo(Image image, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.psd.Image |  |
| format | FileType |  |
| size | long |  |

##### getBitsPerPixel()
```
public int getBitsPerPixel()
```

Gets bits per pixel

**Returns:**
int - bits per pixel
##### getHeight()
```
public int getHeight()
```

Gets height

**Returns:**
int - height
##### getWidth()
```
public int getWidth()
```

Gets width

**Returns:**
int - width

### PsDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/psdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PsDocumentInfo extends DocumentInfo
```

Contains Ps document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PsDocumentInfo(Document ps, FileType format, long size) |  |
##### PsDocumentInfo(Document ps, FileType format, long size)
```
public PsDocumentInfo(Document ps, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ps | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### PublisherDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/publisherdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class PublisherDocumentInfo extends DocumentInfo
```

Contains Publisher document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| PublisherDocumentInfo(FileType format, long size) |  |
##### PublisherDocumentInfo(FileType format, long size)
```
public PublisherDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### SpreadsheetDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/spreadsheetdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class SpreadsheetDocumentInfo extends DocumentInfo
```

Contains Spreadsheet document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetDocumentInfo(Workbook spreadsheet, boolean isPasswordProtected, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets title |
| getWorksheetsCount() | Gets worksheets count |
| getAuthor() | Gets author |
| isPasswordProtected() | Gets is document password protected |
| getWorksheets() | Worksheets names |
| setWorksheets(List<String> worksheets) |  |
##### SpreadsheetDocumentInfo(Workbook spreadsheet, boolean isPasswordProtected, FileType format, long size)
```
public SpreadsheetDocumentInfo(Workbook spreadsheet, boolean isPasswordProtected, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| spreadsheet | com.aspose.cells.Workbook |  |
| isPasswordProtected | boolean |  |
| format | FileType |  |
| size | long |  |

##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title
##### getWorksheetsCount()
```
public int getWorksheetsCount()
```

Gets worksheets count

**Returns:**
int - worksheets count
##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author
##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is document password protected

**Returns:**
boolean - true if document is password protected
##### getWorksheets()
```
public List<String> getWorksheets()
```

Worksheets names

**Returns:**
java.util.List<java.lang.String>
##### setWorksheets(List<String> worksheets)
```
public void setWorksheets(List<String> worksheets)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheets | java.util.List<java.lang.String> |  |

### SvgDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/svgdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class SvgDocumentInfo extends DocumentInfo
```

Contains Svg document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| SvgDocumentInfo(FileType format, long size) |  |
##### SvgDocumentInfo(FileType format, long size)
```
public SvgDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### TableOfContentsItem
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/tableofcontentsitem.md

**Inheritance:**
java.lang.Object
```
public class TableOfContentsItem
```

Contains Table of contents item metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| TableOfContentsItem(String title, int page) | Default constructor |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Bookmark title |
| getPage() | Bookmark page |
##### TableOfContentsItem(String title, int page)
```
public TableOfContentsItem(String title, int page)
```

Default constructor

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | title |
| page | int | page |

##### getTitle()
```
public String getTitle()
```

Bookmark title

**Returns:**
java.lang.String - Bookmark title
##### getPage()
```
public int getPage()
```

Bookmark page

**Returns:**
int - Bookmark page

### TexDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/texdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class TexDocumentInfo extends DocumentInfo
```

Contains Tex document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| TexDocumentInfo(Document tex, FileType format, long size) |  |
##### TexDocumentInfo(Document tex, FileType format, long size)
```
public TexDocumentInfo(Document tex, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tex | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### TsvDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/tsvdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.SpreadsheetDocumentInfo
```
public class TsvDocumentInfo extends SpreadsheetDocumentInfo
```

Contains Tsv document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| TsvDocumentInfo(Workbook tsv, FileType format, long size) |  |
##### TsvDocumentInfo(Workbook tsv, FileType format, long size)
```
public TsvDocumentInfo(Workbook tsv, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tsv | com.aspose.cells.Workbook |  |
| format | FileType |  |
| size | long |  |

### TxtDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/txtdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.WordProcessingDocumentInfo
```
public class TxtDocumentInfo extends WordProcessingDocumentInfo
```

Contains Txt document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| TxtDocumentInfo(Document txt, FileType format, long size) |  |
##### TxtDocumentInfo(Document txt, FileType format, long size)
```
public TxtDocumentInfo(Document txt, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| txt | com.aspose.words.Document |  |
| format | FileType |  |
| size | long |  |

### VcfDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/vcfdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class VcfDocumentInfo extends DocumentInfo
```

Contains Vcf document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| VcfDocumentInfo(List<VCardContact> vcf, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getContactsCount() |  |
##### VcfDocumentInfo(List<VCardContact> vcf, FileType format, long size)
```
public VcfDocumentInfo(List<VCardContact> vcf, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| vcf | java.util.List<com.aspose.email.VCardContact> |  |
| format | FileType |  |
| size | long |  |

##### getContactsCount()
```
public int getContactsCount()
```

**Returns:**
int

### VideoDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/videodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class VideoDocumentInfo extends DocumentInfo
```

Contains Video document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| VideoDocumentInfo(FileType format, long size) |  |
##### VideoDocumentInfo(FileType format, long size)
```
public VideoDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### WebDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/webdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class WebDocumentInfo extends DocumentInfo
```

Contains Web document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| WebDocumentInfo(System.IO.Stream document, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() |  |
##### WebDocumentInfo(System.IO.Stream document, FileType format, long size)
```
public WebDocumentInfo(System.IO.Stream document, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | com.aspose.ms.System.IO.Stream |  |
| format | FileType |  |
| size | long |  |

##### getEncoding()
```
public System.Text.Encoding getEncoding()
```

**Returns:**
com.aspose.ms.System.Text.Encoding

### WordProcessingDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/wordprocessingdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class WordProcessingDocumentInfo extends DocumentInfo
```

Contains Wordprocessing document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingDocumentInfo(Document wordprocessing, boolean isPasswordProtected, FileType format, long size) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWords() | Gets words count |
| getLines() | Gets lines count |
| getTitle() | Gets title |
| getAuthor() | Gets author |
| isPasswordProtected() | Gets is document password protected |
| getTableOfContents() | Table of contents |
##### WordProcessingDocumentInfo(Document wordprocessing, boolean isPasswordProtected, FileType format, long size)
```
public WordProcessingDocumentInfo(Document wordprocessing, boolean isPasswordProtected, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordprocessing | com.aspose.words.Document |  |
| isPasswordProtected | boolean |  |
| format | FileType |  |
| size | long |  |

##### getWords()
```
public int getWords()
```

Gets words count

**Returns:**
int - words count
##### getLines()
```
public int getLines()
```

Gets lines count

**Returns:**
int - lines count
##### getTitle()
```
public String getTitle()
```

Gets title

**Returns:**
java.lang.String - title
##### getAuthor()
```
public String getAuthor()
```

Gets author

**Returns:**
java.lang.String - author
##### isPasswordProtected()
```
public boolean isPasswordProtected()
```

Gets is document password protected

**Returns:**
boolean - `true` if document is password protected
##### getTableOfContents()
```
public List<TableOfContentsItem> getTableOfContents()
```

Table of contents

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.documentinfo.TableOfContentsItem> - Table of contents

### XmlDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/xmldocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo
```
public class XmlDocumentInfo extends DocumentInfo
```

Contains Xml document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlDocumentInfo(FileType format, long size) |  |
##### XmlDocumentInfo(FileType format, long size)
```
public XmlDocumentInfo(FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FileType |  |
| size | long |  |

### XpsDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/xpsdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class XpsDocumentInfo extends PdfDocumentInfo
```

Contains Xps document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XpsDocumentInfo(Document xps, FileType format, long size) |  |
##### XpsDocumentInfo(Document xps, FileType format, long size)
```
public XpsDocumentInfo(Document xps, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xps | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### XslFoDocumentInfo
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.documentinfo/xslfodocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.documentinfo.DocumentInfo, com.groupdocs.conversion.contracts.documentinfo.PdfDocumentInfo
```
public class XslFoDocumentInfo extends PdfDocumentInfo
```

Contains XslFo document metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XslFoDocumentInfo(Document xslfo, FileType format, long size) |  |
##### XslFoDocumentInfo(Document xslfo, FileType format, long size)
```
public XslFoDocumentInfo(Document xslfo, FileType format, long size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xslfo | com.aspose.pdf.Document |  |
| format | FileType |  |
| size | long |  |

### com.groupdocs.conversion.contracts
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts.md

The GroupDocs.Conversion.Contracts namespace provides members to instantiate and release output document, manage font substitutions etc.

#### Classes

| Class | Description |
| --- | --- |
| ConversionPair | Represents conversion pair |
| Enumeration | Generic enumeration class. |
| FontSubstitute | Describes substitution for missing font. |
| PossibleConversions | Represents a mapping what conversion pairs are supported for specific source file format |
| TargetConversion | Represents possible target conversion and a flag is it a primary or secondary |
| ValueObject | Abstract value object class. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ConvertOptionsProvider | Describes delegate to provide convert options for specific source document. |
| ConvertedDocumentStream | Describes delegate to receive converted document stream. |
| ConvertedPageStream | Describes delegate to receive converted page stream. |
| ConverterSettingsProvider | Supplier for ConverterSettings |
| DocumentStreamProvider | Supplier for InputStream |
| DocumentStreamsProvider | Supplier for InputStream array |
| SaveDocumentStream | Describes delegate for saving converted document into output stream. |
| SaveDocumentStreamForFileType | Describes delegate for saving converted document into stream. |
| SavePageStream | Describes delegate for saving converted document page into stream. |
| SavePageStreamForFileType | Describes delegate for saving converted document page into stream. |

### ConversionPair
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/conversionpair.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class ConversionPair extends ValueObject
```

Represents conversion pair
#### Fields

| Field | Description |
| --- | --- |
| NULL |  |
#### Methods

| Method | Description |
| --- | --- |
| createPrimary(FileType source, FileType target) | Creates primary conversion pair |
| createPrimary(List<? extends FileType> sources, List<? extends FileType> targets) | Creates primary conversion pairs |
| createPrimary(List<? extends FileType> sources, List<? extends FileType> targets, Pair<FileType,FileType>[] excludedPairs) |  |
| createSecondary(FileType source, FileType target) | Creates secondary conversion pair |
| createSecondary(Iterable<? extends FileType> sources, Iterable<? extends FileType> targets) | Creates secondary conversion pairs |
| getEqualityComponents() | Equality components |
| toString() | Conversion pair string representation |
| getSource() | Source file format |
| getTarget() | Target file format |
| isPrimary() | Primary conversion pair or not |
##### NULL
```
public static final ConversionPair NULL
```

##### createPrimary(FileType source, FileType target)
```
public static ConversionPair createPrimary(FileType source, FileType target)
```

Creates primary conversion pair

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | source |
| target | FileType | target |

**Returns:**
ConversionPair - ConversionPair
##### createPrimary(List<? extends FileType> sources, List<? extends FileType> targets)
```
public static List<ConversionPair> createPrimary(List<? extends FileType> sources, List<? extends FileType> targets)
```

Creates primary conversion pairs

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sources | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> | sources file type |
| targets | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> | targets file type |

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.ConversionPair> - primary conversion pairs
##### createPrimary(List<? extends FileType> sources, List<? extends FileType> targets, Pair<FileType,FileType>[] excludedPairs)
```
public static List<ConversionPair> createPrimary(List<? extends FileType> sources, List<? extends FileType> targets, Pair<FileType,FileType>[] excludedPairs)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sources | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> |  |
| targets | java.util.List<? extends com.groupdocs.conversion.filetypes.FileType> |  |
| excludedPairs | com.groupdocs.conversion.contracts.Pair<com.groupdocs.conversion.filetypes.FileType,com.groupdocs.conversion.filetypes.FileType>[] |  |

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.ConversionPair>
##### createSecondary(FileType source, FileType target)
```
public static ConversionPair createSecondary(FileType source, FileType target)
```

Creates secondary conversion pair

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | source file type |
| target | FileType | target file type |

**Returns:**
ConversionPair - secondary conversion pair
##### createSecondary(Iterable<? extends FileType> sources, Iterable<? extends FileType> targets)
```
public static List<ConversionPair> createSecondary(Iterable<? extends FileType> sources, Iterable<? extends FileType> targets)
```

Creates secondary conversion pairs

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sources | java.lang.Iterable<? extends com.groupdocs.conversion.filetypes.FileType> | sources file type |
| targets | java.lang.Iterable<? extends com.groupdocs.conversion.filetypes.FileType> | targets file type |

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.ConversionPair> - secondary conversion pairs
##### getEqualityComponents()
```
public System.Collections.Generic.IGenericEnumerable getEqualityComponents()
```

Equality components

**Returns:**
com.aspose.ms.System.Collections.Generic.IGenericEnumerable - equality components
##### toString()
```
public String toString()
```

Conversion pair string representation

**Returns:**
java.lang.String - string
##### getSource()
```
public FileType getSource()
```

Source file format

**Returns:**
FileType - source file format
##### getTarget()
```
public FileType getTarget()
```

Target file format

**Returns:**
FileType - target file format
##### isPrimary()
```
public boolean isPrimary()
```

Primary conversion pair or not

**Returns:**
boolean - true if primary, else if not

### ConvertedDocumentStream
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/converteddocumentstream.md

### ConvertedPageStream
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/convertedpagestream.md

### ConverterSettingsProvider
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/convertersettingsprovider.md

**All Implemented Interfaces:**
java.util.function.Supplier
```
public interface ConverterSettingsProvider extends Supplier<ConverterSettings>
```

Supplier for ConverterSettings

### ConvertOptionsProvider
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/convertoptionsprovider.md

### DocumentStreamProvider
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/documentstreamprovider.md

**All Implemented Interfaces:**
java.util.function.Supplier
```
public interface DocumentStreamProvider extends Supplier<InputStream>
```

Supplier for InputStream

### DocumentStreamsProvider
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/documentstreamsprovider.md

**All Implemented Interfaces:**
java.util.function.Supplier
```
public interface DocumentStreamsProvider extends Supplier<InputStream[]>
```

Supplier for InputStream array

### Enumeration
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/enumeration.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Comparable, java.io.Serializable, com.aspose.ms.System.IEquatable
```
public abstract class Enumeration implements Comparable, Serializable, System.IEquatable<Enumeration>
```

Generic enumeration class.

 TKey :
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a string that represents the current object. |
| <T>getAll(Class<T> typeOfT) | Returns all enumeration values. |
| equals(Object obj) | Determines whether two object instances are equal. |
| equals(Enumeration other) | Determines whether two object instances are equal. |
| hashCode() | Serves as the default hash function. |
| <T>fromValue(Class<T> typeOfT, String value) | Returns object by key. |
| <T>fromDisplayName(Class<T> typeOfT, String displayName) | Returns object by display name. |
| compareTo(Object obj) | Compares current object to other. |
| op_Equality(Enumeration left, Enumeration right) | Equality operator. |
| op_Inequality(Enumeration left, Enumeration right) | Inequality operator. |
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - String representation
##### <T>getAll(Class<T> typeOfT)
```
public static List <T>getAll(Class<T> typeOfT)
```

Returns all enumeration values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
java.util.List - Enumerable of the provided type

 T : Enumerated object type.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object. |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .
##### equals(Enumeration other)
```
public boolean equals(Enumeration other)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Enumeration | The object to compare with the current object. |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current object.
##### <T>fromValue(Class<T> typeOfT, String value)
```
public static T <T>fromValue(Class<T> typeOfT, String value)
```

Returns object by key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| value | java.lang.String | The value |

**Returns:**
T - The object
##### <T>fromDisplayName(Class<T> typeOfT, String displayName)
```
public static T <T>fromDisplayName(Class<T> typeOfT, String displayName)
```

Returns object by display name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| displayName | java.lang.String | The display name |

**Returns:**
T - The object
##### compareTo(Object obj)
```
public final int compareTo(Object obj)
```

Compares current object to other.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The other object |

**Returns:**
int - zero if equal
##### op_Equality(Enumeration left, Enumeration right)
```
public static boolean op_Equality(Enumeration left, Enumeration right)
```

Equality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Enumeration | The first object |
| right | Enumeration | The second object |

**Returns:**
boolean -  true  if objects are equal
##### op_Inequality(Enumeration left, Enumeration right)
```
public static boolean op_Inequality(Enumeration left, Enumeration right)
```

Inequality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Enumeration | The first object |
| right | Enumeration | The second object |

**Returns:**
boolean -  true  if objects are not equal

### FontSubstitute
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/fontsubstitute.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public class FontSubstitute extends ValueObject implements Serializable
```

Describes substitution for missing font.
#### Methods

| Method | Description |
| --- | --- |
| create(String originalFont, String substituteWith) | Instantiate new font substitution pair. |
| getOriginalFontName() | The original font name. |
| getSubstituteFontName() | The substitute font name. |
##### create(String originalFont, String substituteWith)
```
public static FontSubstitute create(String originalFont, String substituteWith)
```

Instantiate new font substitution pair.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originalFont | java.lang.String | Font from the source document. |
| substituteWith | java.lang.String | Font which will be used to replace originalFont. |

**Returns:**
FontSubstitute - substitution pair
##### getOriginalFontName()
```
public String getOriginalFontName()
```

The original font name.

**Returns:**
java.lang.String - the original font name.
##### getSubstituteFontName()
```
public String getSubstituteFontName()
```

The substitute font name.

**Returns:**
java.lang.String - the substitute font name.

### PossibleConversions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/possibleconversions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public final class PossibleConversions extends ValueObject
```

Represents a mapping what conversion pairs are supported for specific source file format
#### Constructors

| Constructor | Description |
| --- | --- |
| PossibleConversions(FileType source) | Creates possible conversion list for specified source file format |
#### Fields

| Field | Description |
| --- | --- |
| NULL |  |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() | Predefined load options which could be used to convert from current type |
| getAll() | All target file types and primary/secondary flag |
| getTargetConversion(FileType target) | Returns target conversion for specified target file type |
| getTargetConversion(String extension) |  |
| getPrimary() | Primary target file types |
| getSecondary() | Secondary target file types |
| add(ConversionPair pair) | Add conversion pair |
| forTarget(FileType target) | Find conversion pair in current list for target file type |
| getSource() | Source file formats |
##### PossibleConversions(FileType source)
```
public PossibleConversions(FileType source)
```

Creates possible conversion list for specified source file format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | FileType | source file type |

##### NULL
```
public static final PossibleConversions NULL
```

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Predefined load options which could be used to convert from current type

**Returns:**
LoadOptions - load options
##### getAll()
```
public Iterable<TargetConversion> getAll()
```

All target file types and primary/secondary flag

**Returns:**
java.lang.Iterable<com.groupdocs.conversion.contracts.TargetConversion> - Iterable of TargetConversion
##### getTargetConversion(FileType target)
```
public TargetConversion getTargetConversion(FileType target)
```

Returns target conversion for specified target file type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| target | FileType | target file type |

**Returns:**
TargetConversion - conversions
##### getTargetConversion(String extension)
```
public TargetConversion getTargetConversion(String extension)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String |  |

**Returns:**
TargetConversion
##### getPrimary()
```
public Iterable<FileType> getPrimary()
```

Primary target file types

**Returns:**
java.lang.Iterable<com.groupdocs.conversion.filetypes.FileType> - primary target file types
##### getSecondary()
```
public Iterable<FileType> getSecondary()
```

Secondary target file types

**Returns:**
java.lang.Iterable<com.groupdocs.conversion.filetypes.FileType> - secondary target file types
##### add(ConversionPair pair)
```
public void add(ConversionPair pair)
```

Add conversion pair

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pair | ConversionPair | conversion pair |

##### forTarget(FileType target)
```
public ConversionPair forTarget(FileType target)
```

Find conversion pair in current list for target file type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| target | FileType | target file type |

**Returns:**
ConversionPair - conversion pair
##### getSource()
```
public FileType getSource()
```

Source file formats

**Returns:**
FileType - file formats

### SaveDocumentStream
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/savedocumentstream.md

### SaveDocumentStreamForFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/savedocumentstreamforfiletype.md

### SavePageStream
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/savepagestream.md

### SavePageStreamForFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/savepagestreamforfiletype.md

### TargetConversion
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/targetconversion.md

**Inheritance:**
java.lang.Object
```
public final class TargetConversion
```

Represents possible target conversion and a flag is it a primary or secondary
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Target document format |
| isPrimary() | Is the conversion primary |
| getConvertOptions() | Predefined convert options which could be used to convert to current type |
##### getFormat()
```
public FileType getFormat()
```

Target document format

**Returns:**
FileType - Target document format
##### isPrimary()
```
public boolean isPrimary()
```

Is the conversion primary

**Returns:**
boolean - `true` if primary
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Predefined convert options which could be used to convert to current type

**Returns:**
ConvertOptions - convert options

### ValueObject
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.contracts/valueobject.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable, java.io.Serializable
```
public abstract class ValueObject implements System.IEquatable<ValueObject>, Serializable
```

Abstract value object class.
#### Constructors

| Constructor | Description |
| --- | --- |
| ValueObject() |  |
#### Methods

| Method | Description |
| --- | --- |
| equals(Object obj) | Determines whether two object instances are equal. |
| equals(ValueObject other) | Determines whether two object instances are equal. |
| hashCode() | Serves as the default hash function. |
| op_Equality(ValueObject a, ValueObject b) | Equality operator. |
| op_Inequality(ValueObject a, ValueObject b) | Inequality operator. |
##### ValueObject()
```
public ValueObject()
```

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current object. |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .
##### equals(ValueObject other)
```
public final boolean equals(ValueObject other)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ValueObject | The object to compare with the current object. |

**Returns:**
boolean -  true  if the specified object is equal to the current object; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current object.
##### op_Equality(ValueObject a, ValueObject b)
```
public static boolean op_Equality(ValueObject a, ValueObject b)
```

Equality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | ValueObject | The first object |
| b | ValueObject | The second object |

**Returns:**
boolean -  true  if objects are equal
##### op_Inequality(ValueObject a, ValueObject b)
```
public static boolean op_Inequality(ValueObject a, ValueObject b)
```

Inequality operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | ValueObject | The first object |
| b | ValueObject | The second object |

**Returns:**
boolean -  true  if objects are not equal

### com.groupdocs.conversion.filetypes
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes.md

The GroupDocs.Conversion.FileTypes namespace provides classes which represent supported file types.

#### Classes

| Class | Description |
| --- | --- |
| AudioFileType | Defines Audio documents Includes the following types: , , , , , , , , , Learn more about audio formats [here][].[here]: https://docs.fileformat.com/audio/ |
| CadFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. |
| DatabaseFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. |
| DiagramFileType | Defines Diagram documents. |
| EBookFileType | Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. |
| EmailFileType | Defines Email file formats that are used by email applications to store their various data including email messages, attachments, folders, address books etc. |
| FileType | File type base class |
| FontFileType | Defines Font documents. |
| ImageFileType | Defines image documents. |
| NoteFileType | Defines Note-taking formats. |
| PageDescriptionLanguageFileType | Defines Page description documents. |
| PdfFileType | Defines Pdf documents. |
| PresentationFileType | Defines Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. |
| ProjectManagementFileType | Defines Project file formats that are created by Project Management software such as Microsoft Project, Primavera P6 etc. |
| PublisherFileType | Defines Publisher documents. |
| SpreadsheetFileType | Defines Spreadsheet documents. |
| VideoFileType | Defines Video documents Includes the following types: , , , , , , , Learn more about video formats [here][].[here]: https://docs.fileformat.com/video/ |
| WebFileType | Defines Web documents. |
| WordProcessingFileType | Defines Word Processing files that contain user information in plain text or rich text format. |

### AudioFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/audiofiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public class AudioFileType extends FileType
```

Defines Audio documents Includes the following types: , , , , , , , , , Learn more about audio formats [here][].

[here]: https://docs.fileformat.com/audio/
#### Constructors

| Constructor | Description |
| --- | --- |
| AudioFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Mp3 | Files with .mp3 extension are digitally encoded file formats for audio files that are formally based on the MPEG-1 Audio Layer III or MPEG-2 Audio Layer III. |
| Aac | AAC (Advanced Audio Coding) refers to digital audio coding standard that represent audio files based on lossy audio compression. |
| Aiff | The AIFF (Audio Interchange File Format) is an uncompressed audio file format developed by Apple in 1998, but is based on EA IFF 85 Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/aiff/ |
| Flac | FLAC(Free Lossless Audio Codec) is a lossless compression audio coding format developed by Xiph.Org Foundation Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/flac/ |
| M4a | The M4A file format is an audio file created by using the AAC (Advanced Audio Coding) which is known as a lossy compression. |
| Wma | A file with .wma extension represents an audio file that is saved in the Advanced Systems Format (ASF) format. |
| Ac3 | A file with a .ac3 extension is an Audio Codec 3 file, introduced by Dolby Laboratories. |
| Ogg | OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension. |
| Wav | WAV, known for WAVE (Waveform Audio File Format), is a subset of Microsoft\\u2019s Resource Interchange File Format (RIFF) specification for storing digital audio files. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
##### AudioFileType()
```
public AudioFileType()
```

Serialization constructor

##### Mp3
```
public static final AudioFileType Mp3
```

Files with .mp3 extension are digitally encoded file formats for audio files that are formally based on the MPEG-1 Audio Layer III or MPEG-2 Audio Layer III. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/mp3/

##### Aac
```
public static final AudioFileType Aac
```

AAC (Advanced Audio Coding) refers to digital audio coding standard that represent audio files based on lossy audio compression. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/aac/

##### Aiff
```
public static final AudioFileType Aiff
```

The AIFF (Audio Interchange File Format) is an uncompressed audio file format developed by Apple in 1998, but is based on EA IFF 85 Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/aiff/

##### Flac
```
public static final AudioFileType Flac
```

FLAC(Free Lossless Audio Codec) is a lossless compression audio coding format developed by Xiph.Org Foundation Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/flac/

##### M4a
```
public static final AudioFileType M4a
```

The M4A file format is an audio file created by using the AAC (Advanced Audio Coding) which is known as a lossy compression. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/m4a/

##### Wma
```
public static final AudioFileType Wma
```

A file with .wma extension represents an audio file that is saved in the Advanced Systems Format (ASF) format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/wma/

##### Ac3
```
public static final AudioFileType Ac3
```

A file with a .ac3 extension is an Audio Codec 3 file, introduced by Dolby Laboratories. It is an audio format that can contain up to six channels of audio output. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/ac3/

##### Ogg
```
public static final AudioFileType Ogg
```

OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension. OGG files are used for storing audio data and can include artist and track information and metadata as well. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/ogg/

##### Wav
```
public static final AudioFileType Wav
```

WAV, known for WAVE (Waveform Audio File Format), is a subset of Microsoft\\u2019s Resource Interchange File Format (RIFF) specification for storing digital audio files. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/ogg/

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions

### CadFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/cadfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class CadFileType extends FileType implements Serializable
```

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. Includes the following types: Dgn, Dwf, Dwg, Dwt, Dxf, Ifc, Igs, Plt, Stl. Cf2. Dwfx. Learn more about CAD formats [here][].

[here]: https://wiki.fileformat.com/cad
#### Constructors

| Constructor | Description |
| --- | --- |
| CadFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Dxf | DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. |
| Dwg | DFiles with DWG extension represent proprietary binary files used for containing 2D and 3D design data. |
| Dgn | DGN, Design, files are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. |
| Dwf | Design Web Format (DWF) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. |
| Stl | STL, abbreviation for stereolithrography, is an interchangeable file format that represents 3-dimensional surface geometry. |
| Ifc | Files with IFC extension refer to Industry Foundation Classes (IFC) file format that establishes international standards to import and export building objects and their properties. |
| Plt | The PLT file format is a vector-based plotter file introduced by Autodesk, Inc. |
| Igs | Igs document format |
| Dwt | A DWT file is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files. |
| Dwfx | DWFX file is a 2D or 3D drawing created with Autodesk CAD software. |
| Cf2 | Common File Format File. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### CadFileType()
```
public CadFileType()
```

Serialization constructor

##### Dxf
```
public static final CadFileType Dxf
```

DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dxf

##### Dwg
```
public static final CadFileType Dwg
```

DFiles with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Like DXF, which are ASCII files, DWG represent the binary file format for CAD (Computer Aided Design) drawings. Learn more about this file format [here][]

[here]: https://wiki.fileformat.com/cad/dwg

##### Dgn
```
public static final CadFileType Dgn
```

DGN, Design, files are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dgn

##### Dwf
```
public static final CadFileType Dwf
```

Design Web Format (DWF) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. It contains graphics and text as part of design data and reduce the size of the file due to its compressed format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwf

##### Stl
```
public static final CadFileType Stl
```

STL, abbreviation for stereolithrography, is an interchangeable file format that represents 3-dimensional surface geometry. The file format finds its usage in several fields such as rapid prototyping, 3D printing and computer-aided manufacturing. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/stl

##### Ifc
```
public static final CadFileType Ifc
```

Files with IFC extension refer to Industry Foundation Classes (IFC) file format that establishes international standards to import and export building objects and their properties. This file format provides interoperability between different software applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/ifc

##### Plt
```
public static final CadFileType Plt
```

The PLT file format is a vector-based plotter file introduced by Autodesk, Inc. and contains information for a certain CAD file. Plotting details require accuracy and precision in production, and usage of PLT file guarantee this as all images are printed using lines instead of dots. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/plt

##### Igs
```
public static final CadFileType Igs
```

Igs document format

##### Dwt
```
public static final CadFileType Dwt
```

A DWT file is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwt

##### Dwfx
```
public static final CadFileType Dwfx
```

DWFX file is a 2D or 3D drawing created with Autodesk CAD software. It is saved in the DWFx format, which is similar to a . DWF file, but is formatted using Microsoft's XML Paper Specification (XPS).

##### Cf2
```
public static final CadFileType Cf2
```

Common File Format File. CAD file that contains 3D package designs or other model data; can be processed and cut by a CAD/CAM machine, such as a die cutting device.

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### DatabaseFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/databasefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class DatabaseFileType extends FileType implements Serializable
```

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. Includes the following types: Nsf, Log, Sql, Learn more about CAD formats [here][].

[here]: https://wiki.fileformat.com/cad
#### Constructors

| Constructor | Description |
| --- | --- |
| DatabaseFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Nsf | A file with .nsf (Notes Storage Facility) extension is a database file format used by the IBM Notes software, which was previously known as Lotus Notes. |
| Log | A file with .log extension contains the list of plain text with timestamp. |
| Sql | A file with .sql extension is a Structured Query Language (SQL) file that contains code to work with relational databases. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
##### DatabaseFileType()
```
public DatabaseFileType()
```

Serialization constructor

##### Nsf
```
public static final DatabaseFileType Nsf
```

A file with .nsf (Notes Storage Facility) extension is a database file format used by the IBM Notes software, which was previously known as Lotus Notes. It defines the schema to store different kind of objects such like emails, appointments, documents, forms and views. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/database/nsf

##### Log
```
public static final DatabaseFileType Log
```

A file with .log extension contains the list of plain text with timestamp. Usually, certain activity detail is logged by the softwares or operating systems to help the developers or users to track what was happening at a certain time period. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/database/log

##### Sql
```
public static final DatabaseFileType Sql
```

A file with .sql extension is a Structured Query Language (SQL) file that contains code to work with relational databases. It is used to write SQL statements for CRUD (Create, Read, Update, and Delete) operations on databases. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/database/sql

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions

### DiagramFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/diagramfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class DiagramFileType extends FileType implements Serializable
```

Defines Diagram documents. Includes the following types: Vdw, Vdx, Vsd, Vsdm, Vsdx, Vss, Vssm, Vssx, Vst, Vstm, Vstx, Vsx, Vtx.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Vsd | VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. |
| Vsdx | Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. |
| Vss | VSS are stencil files created with Microsoft Visio 2007 and earlier. |
| Vst | Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. |
| Vsx | Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. |
| Vtx | A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. |
| Vdw | VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing. |
| Vdx | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. |
| Vssx | Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. |
| Vstx | Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. |
| Vsdm | Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. |
| Vssm | Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. |
| Vstm | Files with VSTM extension are template files created with Microsoft Visio that support macros. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### DiagramFileType()
```
public DiagramFileType()
```

Serialization constructor

##### Vsd
```
public static final DiagramFileType Vsd
```

VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsd

##### Vsdx
```
public static final DiagramFileType Vsdx
```

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It was developed to replace the binary file format, .VSD, which is supported by earlier versions of Microsoft Visio. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsdx

##### Vss
```
public static final DiagramFileType Vss
```

VSS are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vss

##### Vst
```
public static final DiagramFileType Vst
```

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. These template files are in binary file format and contain the default layout and settings that are utilized for creation of new Visio drawings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vst

##### Vsx
```
public static final DiagramFileType Vsx
```

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and was supported till Visio 2013. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsx

##### Vtx
```
public static final DiagramFileType Vtx
```

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. The template is aimed to provide a file with basic settings that can be used to create multiple Visio files of the same settings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vtx

##### Vdw
```
public static final DiagramFileType Vdw
```

VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/vdw

##### Vdx
```
public static final DiagramFileType Vdx
```

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. A Visio drawing XML file is created in Visio software, which is developed by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vdx

##### Vssx
```
public static final DiagramFileType Vssx
```

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representation of a variety of drawing elements such as collection of shapes, connectors, flowcharts, network layout, UML diagrams, Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vssx

##### Vstx
```
public static final DiagramFileType Vstx
```

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide starting point for creating Visio drawings, saved as .VSDX files, with default layout and settings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vstx

##### Vsdm
```
public static final DiagramFileType Vsdm
```

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsdm

##### Vssm
```
public static final DiagramFileType Vssm
```

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. A VSSM file when opened allows to run the macros to achieve desired formatting and placement of shapes in a diagram. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vssm

##### Vstm
```
public static final DiagramFileType Vstm
```

Files with VSTM extension are template files created with Microsoft Visio that support macros. Unlike VSDX files, files created from VSTM templates can run macros that are developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vstm

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static final FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### EBookFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/ebookfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EBookFileType extends FileType implements Serializable
```

Defines CAD documents (Computer Aided Design) that are used for a 3D graphics file formats and may contain 2D or 3D designs. Includes the following types: Epub, Mobi, Azw3, Learn more about CAD formats [here][].

[here]: https://wiki.fileformat.com/cad
#### Constructors

| Constructor | Description |
| --- | --- |
| EBookFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Epub | EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. |
| Mobi | The MOBI file format is one of the most widely used ebook file format. |
| Azw3 | AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### EBookFileType()
```
public EBookFileType()
```

Serialization constructor

##### Epub
```
public static final EBookFileType Epub
```

EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. The format has been so common by now that it is supported by many e-readers and software applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/ebook/epub

##### Mobi
```
public static final EBookFileType Mobi
```

The MOBI file format is one of the most widely used ebook file format. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as proprietary format for Mobipocket Reader. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/ebook/mobi

##### Azw3
```
public static final EBookFileType Azw3
```

AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. The format is an enhancement to older AZW files and is used on Kindle Fire devices only with backward compatibility for the ancestor file format i.e. MOBI and AZW. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/ebook/azw3/

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### EmailFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/emailfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EmailFileType extends FileType implements Serializable
```

Defines Email file formats that are used by email applications to store their various data including email messages, attachments, folders, address books etc. Includes the following file types: Eml, Emlx, Msg, Vcf. Pst. Ost. Olm. Learn more about Email formats [here][].

[here]: https://wiki.fileformat.com/email
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Msg | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. |
| Eml | EML file format represents email messages saved using Outlook and other relevant applications. |
| Emlx | The EMLX file format is implemented and developed by Apple. |
| Vcf | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. |
| Mbox | MBox file format is a generic term that represents a container for collection of electronic mail messages. |
| Pst | Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. |
| Ost | OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. |
| Olm | A file with .olm extension is a Microsoft Outlook file for Mac Operating System. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
##### EmailFileType()
```
public EmailFileType()
```

Serialization constructor

##### Msg
```
public static final EmailFileType Msg
```

MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/msg

##### Eml
```
public static final EmailFileType Eml
```

EML file format represents email messages saved using Outlook and other relevant applications. Almost all emailing clients support this file format for its compliance with RFC-822 Internet Message Format Standard. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/eml

##### Emlx
```
public static final EmailFileType Emlx
```

The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/emlx

##### Vcf
```
public static final EmailFileType Vcf
```

VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/vcf

##### Mbox
```
public static final EmailFileType Mbox
```

MBox file format is a generic term that represents a container for collection of electronic mail messages. The messages are stored inside the container along with their attachments. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/email/mbox/

##### Pst
```
public static final EmailFileType Pst
```

Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/pst

##### Ost
```
public static final EmailFileType Ost
```

OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/ost

##### Olm
```
public static final EmailFileType Olm
```

A file with .olm extension is a Microsoft Outlook file for Mac Operating System. An OLM file stores email messages, journals, calendar data, and other types of application data. These are similar to PST files used by Outlook on Windows Operating System. However, OLM files created by Outlook for Mac can\\u2019t be opened in Outlook for Windows. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/olm

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions

### FileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/filetype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration
```
public class FileType extends Enumeration
```

File type base class
#### Constructors

| Constructor | Description |
| --- | --- |
| FileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Unknown file type |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | The file format |
| getExtension() | The file extension |
| getFamily() | The file family |
| getDescription() | Description of the file type |
| fromFilename(String fileName) | Returns FileType for specified fileName |
| fromExtension(String fileExtension) | Gets FileType for provided fileExtension |
| fromStream(InputStream inputStream) | Returns FileType for provided document stream |
| <T>getAllTypes(Class<T> typeOfT) | Returns all enumeration values. |
| <T>getAllTypes(Class<T> typeOfT, FileType[] excluded) |  |
| <T>getAllTypes(Class<T> typeOfT, FileType[][] excluded) |  |
| toString() | String representation |
| getLoadOptions() | Prepared default load options for the source file type |
| getConvertOptions() | Prepared default convert options for the file type |
| isObsolete() |  |
| equals(Enumeration other) |  |
| equals(Object obj) |  |
| hashCode() |  |
##### FileType()
```
public FileType()
```

Serialization constructor

##### Unknown
```
public static final FileType Unknown
```

Unknown file type

##### getFileFormat()
```
public final String getFileFormat()
```

The file format

**Returns:**
java.lang.String
##### getExtension()
```
public final String getExtension()
```

The file extension

**Returns:**
java.lang.String
##### getFamily()
```
public String getFamily()
```

The file family

**Returns:**
java.lang.String - The file family
##### getDescription()
```
public final String getDescription()
```

Description of the file type

**Returns:**
java.lang.String - description
##### fromFilename(String fileName)
```
public static FileType fromFilename(String fileName)
```

Returns FileType for specified fileName

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The file name |

**Returns:**
FileType - The file type of specified file name
##### fromExtension(String fileExtension)
```
public static FileType fromExtension(String fileExtension)
```

Gets FileType for provided fileExtension

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | java.lang.String | file extension |

**Returns:**
FileType - file type
##### fromStream(InputStream inputStream)
```
public static FileType fromStream(InputStream inputStream)
```

Returns FileType for provided document stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputStream | java.io.InputStream | TStream which will be probed |

**Returns:**
FileType - The file type of provided stream
##### <T>getAllTypes(Class<T> typeOfT)
```
public static List<FileType> <T>getAllTypes(Class<T> typeOfT)
```

Returns all enumeration values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
java.util.List<com.groupdocs.conversion.filetypes.FileType> - Enumerable of file types

 T : Enumerated object type.
##### <T>getAllTypes(Class<T> typeOfT, FileType[] excluded)
```
public static List<FileType> <T>getAllTypes(Class<T> typeOfT, FileType[] excluded)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| excluded | FileType\[\] |  |

**Returns:**
java.util.List<com.groupdocs.conversion.filetypes.FileType>
##### <T>getAllTypes(Class<T> typeOfT, FileType[][] excluded)
```
public static List<FileType> <T>getAllTypes(Class<T> typeOfT, FileType[][] excluded)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| excluded | FileType\[\] |  |

**Returns:**
java.util.List<com.groupdocs.conversion.filetypes.FileType>
##### toString()
```
public String toString()
```

String representation

**Returns:**
java.lang.String - String representation of file type
##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions - NULL if there is not file type specific load options
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions - NULL if the conversion to the type not supported
##### isObsolete()
```
public boolean isObsolete()
```

**Returns:**
boolean
##### equals(Enumeration other)
```
public boolean equals(Enumeration other)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Enumeration |  |

**Returns:**
boolean
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether two object instances are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int

### FontFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/fontfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class FontFileType extends FileType implements Serializable
```

Defines Font documents. Includes the following types: Ttf, Eot, Otf, Cff, Type1, Woff, Woff2, Learn more about Font formats [here][].

[here]: https://wiki.fileformat.com/font
#### Constructors

| Constructor | Description |
| --- | --- |
| FontFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Ttf | A file with .ttf extension represents font files based on the TrueType specifications font technology. |
| Eot | A file with .eot extension is an OpenType font that is embedded in a document. |
| Otf | A file with .otf extension refers to OpenType font format. |
| Cff | A file with .cff extension is a Compact Font Format and is also known as a PostScript Type 1, or CIDFont. |
| Type1 | Type 1 fonts is a deprecated Adobe technology which was widely used in the desktop based publishing software and printers that could use PostScript. |
| Woff | A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). |
| Woff2 | A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### FontFileType()
```
public FontFileType()
```

Serialization constructor

##### Ttf
```
public static final FontFileType Ttf
```

A file with .ttf extension represents font files based on the TrueType specifications font technology. It was initially designed and launched by Apple Computer, Inc for Mac OS and was later adopted by Microsoft for Windows OS. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/ttf/

##### Eot
```
public static final FontFileType Eot
```

A file with .eot extension is an OpenType font that is embedded in a document. These are mostly used in web files such as a Web page. It was created by Microsoft and is supported by Microsoft Products including PowerPoint presentation .pps file. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/eot/

##### Otf
```
public static final FontFileType Otf
```

A file with .otf extension refers to OpenType font format. OTF font format is more scalable and extends the existing features of TTF formats for digital typography. Developed by Microsoft and Adobe, OTF combines the features of PostScript and TrueType font formats. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/otf/

##### Cff
```
public static final FontFileType Cff
```

A file with .cff extension is a Compact Font Format and is also known as a PostScript Type 1, or CIDFont. CFF acts as a container to store multiple fonts together in a single unit known as a FontSet. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/cff/

##### Type1
```
public static final FontFileType Type1
```

Type 1 fonts is a deprecated Adobe technology which was widely used in the desktop based publishing software and printers that could use PostScript. Although Type 1 fonts are not supported in many modern platforms, web browsers and mobile operating systems, but these are still supported in some of the operating systems. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/type1/

##### Woff
```
public static final FontFileType Woff
```

A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/woff/

##### Woff2
```
public static final FontFileType Woff2
```

A file with .woff extension is a web font file based on the Web Open Font Format (WOFF). It has format-specific compressed container based on either TrueType (.TTF) or OpenType (.OTT) font types. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/woff/

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### ImageFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/imagefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class ImageFileType extends FileType implements Serializable
```

Defines image documents. Includes the following file types: Ai, Bmp, Cdr, Cmx, Dcm, Dib, DjVu, Dng, Emf, Emz, Gif, Ico, J2c, J2k, Jls, Jp2, Jpc, Jpeg, Jpf, Jpg, Jpm, Jpx, Odg, Png, Psd, Svg, Svgz, Tga, Tif, Tiff, Webp, Wmf, Wmz. Learn more about Image formats [here][].

[here]: https://wiki.fileformat.com/image
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Tiff | TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| Tif | TTIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| Jpg | A JPG is a type of image format that is saved using the method of lossy compression. |
| Jpeg | A JPEG is a type of image format that is saved using the method of lossy compression. |
| Png | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. |
| Gif | A GIF or Graphical Interchange Format is a type of highly compressed image. |
| Bmp | BMP represent Bitmap Image files that are used to store bitmap digital images. |
| Ico | Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows. |
| Psd | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. |
| Wmf | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. |
| Emf | Enhanced metafile format (EMF) stores graphical images device-independently. |
| Dcm | Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. |
| Dicom | Files with .DICOM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. |
| Webp | WWebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. |
| Dng | DNG is a digital camera image format used for the storage of raw files. |
| Jp2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. |
| Odg | The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. |
| J2c | J2c document format |
| J2k | J2K file is an image that is compressed using the wavelet compression instead of DCT compression. |
| Jpx | Jpx document format |
| Jpf | Jpf document format |
| Jpm | Jpm document format |
| Cdr | A CDR file is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. |
| Cmx | Files with CMX extension are Corel Exchange image file format that is used as presentation by CorelSuite applications. |
| Dib | DDIB (Device Independent Bitmap) file is a raster image file that is similar in structure to the standard Bitmap files (BMP) but has a different header. |
| Jpc | Jpc document format |
| Jls | Jls document format |
| DjVu | DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. |
| Otg | An OTG file is a drawing template that is created using the OpenDocument standard that follows the OASIS Office Applications 1.0 specification. |
| Ai | AI, Adobe Illustrator Artwork, represents single-page vector-based drawings in either the EPS or PDF formats. |
| Emz | n EMZ file is actually a compressed version of a Microsoft EMF file. |
| Wmz | An WMZ file is actually a compressed version of a Microsoft WMF file. |
| Svgz | An SVGZ file is actually a compressed version of a SVG file. |
| Tga | A file with .tga extension is a raster graphic format and was created by Truevision Inc. |
| Psb | Adobe photoshop saves files in two formats. |
| Fodg | FODG is a uncompressed XML-format file used for storing OpenDocument text data. |
| Heic |  |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| isVectorImage(FileType fileType) |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### ImageFileType()
```
public ImageFileType()
```

Serialization constructor

##### Tiff
```
public static final ImageFileType Tiff
```

TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff

##### Tif
```
public static final ImageFileType Tif
```

TTIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff

##### Jpg
```
public static final ImageFileType Jpg
```

A JPG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg

##### Jpeg
```
public static final ImageFileType Jpeg
```

A JPEG is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg

##### Png
```
public static final ImageFileType Png
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/png

##### Gif
```
public static final ImageFileType Gif
```

A GIF or Graphical Interchange Format is a type of highly compressed image. For each image GIF typically allow up to 8 bits per pixel and up to 256 colours are allowed across the image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/gif

##### Bmp
```
public static final ImageFileType Bmp
```

BMP represent Bitmap Image files that are used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/bmp

##### Ico
```
public static final ImageFileType Ico
```

Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/ico

##### Psd
```
public static final ImageFileType Psd
```

PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/psd

##### Wmf
```
public static final ImageFileType Wmf
```

Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/wmf

##### Emf
```
public static final ImageFileType Emf
```

Enhanced metafile format (EMF) stores graphical images device-independently. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/emf

##### Dcm
```
public static final ImageFileType Dcm
```

Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dcm

##### Dicom
```
public static final ImageFileType Dicom
```

Files with .DICOM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dicom

##### Webp
```
public static final ImageFileType Webp
```

WWebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/webp

##### Dng
```
public static final ImageFileType Dng
```

DNG is a digital camera image format used for the storage of raw files. It has been developed by Adobe in September 2004. It was basically developed for digital photography. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dng

##### Jp2
```
public static final ImageFileType Jp2
```

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. /// Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jp2

##### Odg
```
public static final ImageFileType Odg
```

The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/odg

##### J2c
```
public static final ImageFileType J2c
```

J2c document format

##### J2k
```
public static final ImageFileType J2k
```

J2K file is an image that is compressed using the wavelet compression instead of DCT compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2k

##### Jpx
```
public static final ImageFileType Jpx
```

Jpx document format

##### Jpf
```
public static final ImageFileType Jpf
```

Jpf document format

##### Jpm
```
public static final ImageFileType Jpm
```

Jpm document format

##### Cdr
```
public static final ImageFileType Cdr
```

A CDR file is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. Such a drawing file contains text, lines, shapes, images, colours and effects for vector representation of image contents. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/cdr

##### Cmx
```
public static final ImageFileType Cmx
```

Files with CMX extension are Corel Exchange image file format that is used as presentation by CorelSuite applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/cmx

##### Dib
```
public static final ImageFileType Dib
```

DDIB (Device Independent Bitmap) file is a raster image file that is similar in structure to the standard Bitmap files (BMP) but has a different header. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dib

##### Jpc
```
public static final ImageFileType Jpc
```

Jpc document format

##### Jls
```
public static final ImageFileType Jls
```

Jls document format

##### DjVu
```
public static final ImageFileType DjVu
```

DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/djvu

##### Otg
```
public static final ImageFileType Otg
```

An OTG file is a drawing template that is created using the OpenDocument standard that follows the OASIS Office Applications 1.0 specification. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/otg

##### Ai
```
public static final ImageFileType Ai
```

AI, Adobe Illustrator Artwork, represents single-page vector-based drawings in either the EPS or PDF formats.

##### Emz
```
public static final ImageFileType Emz
```

n EMZ file is actually a compressed version of a Microsoft EMF file. This allows for easier distribution of the file online. When an EMF file is compressed using the .GZIP compression algorithm, it is then given the .emz file extension.

##### Wmz
```
public static final ImageFileType Wmz
```

An WMZ file is actually a compressed version of a Microsoft WMF file. This allows for easier distribution of the file online. When an EWMFMF file is compressed using the .GZIP compression algorithm, it is then given the .wmz file extension.

##### Svgz
```
public static final ImageFileType Svgz
```

An SVGZ file is actually a compressed version of a SVG file. This allows for easier distribution of the file online. When an SVG file is compressed using the .GZIP compression algorithm, it is then given the .svgz file extension.

##### Tga
```
public static final ImageFileType Tga
```

A file with .tga extension is a raster graphic format and was created by Truevision Inc. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/tga

##### Psb
```
public static final ImageFileType Psb
```

Adobe photoshop saves files in two formats. Files having 30,000 by 30,000 pixels in size are saved with PSD extension and files larger than PSD upto 300,000 by 300,000 pixels are saved with PSB extension known as \\u201cPhotoshop Big\\u201d. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/psb

##### Fodg
```
public static final ImageFileType Fodg
```

FODG is a uncompressed XML-format file used for storing OpenDocument text data. FODG extension is associated with open source office productivity suites Libre Office and OpenOffice.org.

##### Heic
```
public static final ImageFileType Heic
```

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### isVectorImage(FileType fileType)
```
public static boolean isVectorImage(FileType fileType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType |  |

**Returns:**
boolean
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### NoteFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/notefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public final class NoteFileType extends FileType
```

Defines Note-taking formats. Includes the following file types: One. Learn more about Note-taking formats [here][].

[here]: https://wiki.fileformat.com/note-taking
#### Constructors

| Constructor | Description |
| --- | --- |
| NoteFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| One | File represented by .ONE extension are created by Microsoft OneNote application. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
##### NoteFileType()
```
public NoteFileType()
```

Serialization constructor

##### One
```
public static final NoteFileType One
```

File represented by .ONE extension are created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/note-taking/one

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions

### PageDescriptionLanguageFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PageDescriptionLanguageFileType extends FileType implements Serializable
```

Defines Page description documents. Includes the following types: Svg, Eps, Cgm, Xps, Tex, Ps, Pcl, Oxps,
#### Constructors

| Constructor | Description |
| --- | --- |
| PageDescriptionLanguageFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Svg | An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. |
| Eps | Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page. |
| Cgm | Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. |
| Xps | An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. |
| Tex | TeX is a language that comprises of programming as well as mark-up features, used to typeset documents. |
| Ps | PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. |
| Pcl | PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP). |
| Oxps | The file format OXPS is known as Open XML Paper Specification. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### PageDescriptionLanguageFileType()
```
public PageDescriptionLanguageFileType()
```

Serialization constructor

##### Svg
```
public static final PageDescriptionLanguageFileType Svg
```

An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/svg

##### Eps
```
public static final PageDescriptionLanguageFileType Eps
```

Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/eps

##### Cgm
```
public static final PageDescriptionLanguageFileType Cgm
```

Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. CGM uses object-oriented approach and many function provisions for image production. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/cgm

##### Xps
```
public static final PageDescriptionLanguageFileType Xps
```

An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement of EMF file format and is similar to PDF file format, but uses XML in layout, appearance, and printing information of a document. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/xps

##### Tex
```
public static final PageDescriptionLanguageFileType Tex
```

TeX is a language that comprises of programming as well as mark-up features, used to typeset documents. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/tex

##### Ps
```
public static final PageDescriptionLanguageFileType Ps
```

PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. The main focus of PostScript (PS) is to facilitate the two-dimensional graphic design. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/ps

##### Pcl
```
public static final PageDescriptionLanguageFileType Pcl
```

PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/pcl

##### Oxps
```
public static final PageDescriptionLanguageFileType Oxps
```

The file format OXPS is known as Open XML Paper Specification. It\\u2019s a page description language and document format. Microsoft is the developer of this format. OXPS file format is very much familiar to these PDF files. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/page-description-language/oxps

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### PdfFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/pdffiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfFileType extends FileType implements Serializable
```

Defines Pdf documents. Includes the following file types: Pdf,
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Pdf | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### PdfFileType()
```
public PdfFileType()
```

Serialization constructor

##### Pdf
```
public static final PdfFileType Pdf
```

Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/view/pdf

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static final FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### PresentationFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/presentationfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PresentationFileType extends FileType implements Serializable
```

Defines Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. Includes the following file types: Odp, Otp, Pot, Potm, Potx, Pps, Ppsm, Ppsx, Ppt, Pptm, Pptx. Learn more about Presentation formats [here][].

[here]: https://wiki.fileformat.com/presentation
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Ppt | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| Pps | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. |
| Pptx | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. |
| Ppsx | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| Odp | Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard. |
| Otp | Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format. |
| Potx | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. |
| Pot | Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. |
| Potm | Files with POTM extension are Microsoft PowerPoint template files with support for Macros. |
| Pptm | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. |
| Ppsm | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. |
| Fodp | Files with FODP extension represent OpenDocument Flat XML Presentation. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### PresentationFileType()
```
public PresentationFileType()
```

Serialization constructor

##### Ppt
```
public static final PresentationFileType Ppt
```

A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/ppt

##### Pps
```
public static final PresentationFileType Pps
```

PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pps

##### Pptx
```
public static final PresentationFileType Pptx
```

Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pptx

##### Ppsx
```
public static final PresentationFileType Ppsx
```

PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/ppsx

##### Odp
```
public static final PresentationFileType Odp
```

Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/odp

##### Otp
```
public static final PresentationFileType Otp
```

Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/otp

##### Potx
```
public static final PresentationFileType Potx
```

Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/potx

##### Pot
```
public static final PresentationFileType Pot
```

Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pot

##### Potm
```
public static final PresentationFileType Potm
```

Files with POTM extension are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/potm

##### Pptm
```
public static final PresentationFileType Pptm
```

Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pptm

##### Ppsm
```
public static final PresentationFileType Ppsm
```

Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/ppsm

##### Fodp
```
public static final PresentationFileType Fodp
```

Files with FODP extension represent OpenDocument Flat XML Presentation. Presentation file saved in the OpenDocument format, but saved using a flat XML format instead of the .ZIP container used by standard .ODP files

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### ProjectManagementFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/projectmanagementfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public final class ProjectManagementFileType extends FileType
```

Defines Project file formats that are created by Project Management software such as Microsoft Project, Primavera P6 etc. A project file is a collection of tasks, resources, and their scheduling to get a measurable output in the form or a product or a service. Project management documents. Includes the following file types: Mpp, Mpt, Mpx. Learn more about Project Management formats [here][].

[here]: https://wiki.fileformat.com/project-management
#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Mpt | Microsoft Project template files, contain basic information and structure along with document settings for creating .MPP files. |
| Mpp | MPP is Microsoft Project data file that stores information related to project management in an integrated manner. |
| Mpx | Microsoft Exchange File Format, is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating. |
| Xer | The XER file format is a proprietary project file format used by Primavera P6 project planning and management application. |
#### Methods

| Method | Description |
| --- | --- |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### ProjectManagementFileType()
```
public ProjectManagementFileType()
```

Serialization constructor

##### Mpt
```
public static final ProjectManagementFileType Mpt
```

Microsoft Project template files, contain basic information and structure along with document settings for creating .MPP files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpt

##### Mpp
```
public static final ProjectManagementFileType Mpp
```

MPP is Microsoft Project data file that stores information related to project management in an integrated manner. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpp

##### Mpx
```
public static final ProjectManagementFileType Mpx
```

Microsoft Exchange File Format, is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpx

##### Xer
```
public static final ProjectManagementFileType Xer
```

The XER file format is a proprietary project file format used by Primavera P6 project planning and management application. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/project-management/xer

##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### PublisherFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/publisherfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PublisherFileType extends FileType implements Serializable
```

Defines Publisher documents. Includes the following types: Pub, Learn more about Font formats [here][].

[here]: https://wiki.fileformat.com/publisher
#### Constructors

| Constructor | Description |
| --- | --- |
| PublisherFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Pub | A PUB file is a Microsoft Publisher document file format. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### PublisherFileType()
```
public PublisherFileType()
```

Serialization constructor

##### Pub
```
public static final PublisherFileType Pub
```

A PUB file is a Microsoft Publisher document file format. It is used to create several types of design layout documents such as newsletters, flyers, brochures, postcards, etc. PUB files can contain text, raster and vector images. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/publisher/pub/

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### SpreadsheetFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/spreadsheetfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class SpreadsheetFileType extends FileType implements Serializable
```

Defines Spreadsheet documents. Includes the following file types: Csv, Fods, Ods, Ots, Tsv, Xlam, Xls, Xlsb, Xlsm, Xlsx, Xlt, Xltm, Xltx. Learn more about Spreadsheet formats [here][].

[here]: https://wiki.fileformat.com/spreadsheet
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Xls | XLS represents Excel Binary File Format. |
| Xlsx | XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. |
| Xlsm | XLSM is a type of Spreadsheet files that support macros. |
| Xlsb | XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| Ods | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. |
| Ots | A file with .ots extension is an OpenDocument Spreadsheet Template file that is created with the Calc application software included in Apache OpenOffice. |
| Xltx | XLTX file represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. |
| Xlt | Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. |
| Xltm | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. |
| Tsv | A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format. |
| Xlam | XLAM is an Macro-Enabled Add-In file that is used to add new functions to spreadsheets. |
| Csv | Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values. |
| Fods | A file with .fods extension is a type of OpenDocument Spreadsheet document format that stores data in rows and columns. |
| Dif | DIF stands for Data Interchange Format that is used to import/export spreadsheets data between different applications. |
| Sxc | The file format SXC(Sun XML Calc) belongs to an office suite called OpenOffice.org. |
| Numbers | The files with .numbers extension are classified as spreadsheet file type, that\\u2019s why they are similar to the .xlsx files; but the Numbers files are created by using Apple iWork Numbers spreadsheet software. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### SpreadsheetFileType()
```
public SpreadsheetFileType()
```

Serialization constructor

##### Xls
```
public static final SpreadsheetFileType Xls
```

XLS represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xls

##### Xlsx
```
public static final SpreadsheetFileType Xlsx
```

XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlsx

##### Xlsm
```
public static final SpreadsheetFileType Xlsm
```

XLSM is a type of Spreadsheet files that support macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlsm

##### Xlsb
```
public static final SpreadsheetFileType Xlsb
```

XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlsb

##### Ods
```
public static final SpreadsheetFileType Ods
```

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ods

##### Ots
```
public static final SpreadsheetFileType Ots
```

A file with .ots extension is an OpenDocument Spreadsheet Template file that is created with the Calc application software included in Apache OpenOffice. Calc application software is the similar to Excel available in Microsoft Office. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ots

##### Xltx
```
public static final SpreadsheetFileType Xltx
```

XLTX file represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files that exhibit the same settings as specified in the XLTX file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xltx

##### Xlt
```
public static final SpreadsheetFileType Xlt
```

Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening these. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlt

##### Xltm
```
public static final SpreadsheetFileType Xltm
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure other than that the later doesn't support creating template files with macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xltm

##### Tsv
```
public static final SpreadsheetFileType Tsv
```

A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/tsv

##### Xlam
```
public static final SpreadsheetFileType Xlam
```

XLAM is an Macro-Enabled Add-In file that is used to add new functions to spreadsheets. An Add-In is a supplemental program that runs additional code and provides additional functionality for spreadsheets. Learn more about this file format [here][]

[here]: https://docs.fileformat.com/spreadsheet/xlam/

##### Csv
```
public static final SpreadsheetFileType Csv
```

Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/csv

##### Fods
```
public static final SpreadsheetFileType Fods
```

A file with .fods extension is a type of OpenDocument Spreadsheet document format that stores data in rows and columns. The format is specified as part of ODF 1.2 specifications published and maintained by OASIS. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/fods

##### Dif
```
public static final SpreadsheetFileType Dif
```

DIF stands for Data Interchange Format that is used to import/export spreadsheets data between different applications. These include Microsoft Excel, OpenOffice Calc, StarCalc and many others. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/dif

##### Sxc
```
public static final SpreadsheetFileType Sxc
```

The file format SXC(Sun XML Calc) belongs to an office suite called OpenOffice.org. This format generally deals with the spreadsheet needs of users as it is an XML based spreadsheet file format. SXC format supports formulas, functions, macros and charts along with DataPilot. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/sxc

##### Numbers
```
public static final SpreadsheetFileType Numbers
```

The files with .numbers extension are classified as spreadsheet file type, that\\u2019s why they are similar to the .xlsx files; but the Numbers files are created by using Apple iWork Numbers spreadsheet software. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/numbers

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static final FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static final FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### VideoFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/videofiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType
```
public class VideoFileType extends FileType
```

Defines Video documents Includes the following types: , , , , , , , Learn more about video formats [here][].

[here]: https://docs.fileformat.com/video/
#### Constructors

| Constructor | Description |
| --- | --- |
| VideoFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Mp4 | MP4(short for MPEG-4 Part 14) is a file format based on ISO/IEC 14496-12:2004 that is based on QuickTime File Format but formally specifies support for Initial Object Descriptors (IOD) and other MPEG features. |
| Avi | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. |
| Flv | FLV (Flash Video) is a container file format with the .flv extension. |
| Mkv | MKV (Matroska Video) is a multimedia container similar to MOV and AVI format but it supports more than one audio and subtitle track in the same file. |
| Mov | MOV or QuickTime file format is a multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. |
| Webm | A file with a .webm extension is a video file based on the open, royalty-free WebM file format. |
| Wmv | Windows Media Video is the compressed video format developed by Microsoft. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
##### VideoFileType()
```
public VideoFileType()
```

Serialization constructor

##### Mp4
```
public static final VideoFileType Mp4
```

MP4(short for MPEG-4 Part 14) is a file format based on ISO/IEC 14496-12:2004 that is based on QuickTime File Format but formally specifies support for Initial Object Descriptors (IOD) and other MPEG features. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/mp4/

##### Avi
```
public static final VideoFileType Avi
```

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. It holds the audio and video data created and compressed using several codecs (Coders/Decoders) such as XVid and DivX. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/avi/

##### Flv
```
public static final VideoFileType Flv
```

FLV (Flash Video) is a container file format with the .flv extension. FLV is used to deliver audio/video content over the internet by using the Adobe Flash Player or Adobe Air. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/flv/

##### Mkv
```
public static final VideoFileType Mkv
```

MKV (Matroska Video) is a multimedia container similar to MOV and AVI format but it supports more than one audio and subtitle track in the same file. An MKV file is the Matroska multimedia container format used for video. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/mkv/

##### Mov
```
public static final VideoFileType Mov
```

MOV or QuickTime file format is a multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. Video, Audio, text, etc. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/mov/

##### Webm
```
public static final VideoFileType Webm
```

A file with a .webm extension is a video file based on the open, royalty-free WebM file format. It has been designed for sharing video on the web and defines the file container structure including video and audio formats. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/webm//

##### Wmv
```
public static final VideoFileType Wmv
```

Windows Media Video is the compressed video format developed by Microsoft. After the standardization by the Society of Motion Picture and Television Engineers (SMPTE), WMV is now considered to be an open standard format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/wmv/

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions

### WebFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/webfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class WebFileType extends FileType implements Serializable
```

Defines Web documents. Includes the following types: Xml, Json, Html, Htm, Mht, Mhtml, Chm, Learn more about web formats [here][].

[here]: https://wiki.fileformat.com/web
#### Constructors

| Constructor | Description |
| --- | --- |
| WebFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Xml | XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects. |
| Json | JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. |
| Html | HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers. |
| Htm | HTM (Hyper Text Markup Language) is the extension for web pages created for display in browsers. |
| Mht | Files with MHTML extension represent a web page archive format that can be created by a number of different applications. |
| Mhtml | Files with MHTML extension represent a web page archive format that can be created by a number of different applications. |
| Chm | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedTargetTypes() |  |
##### WebFileType()
```
public WebFileType()
```

Serialization constructor

##### Xml
```
public static final WebFileType Xml
```

XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/xml

##### Json
```
public static final WebFileType Json
```

JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/json

##### Html
```
public static final WebFileType Html
```

HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/html

##### Htm
```
public static final WebFileType Htm
```

HTM (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/html

##### Mht
```
public static final WebFileType Mht
```

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/mhtml

##### Mhtml
```
public static final WebFileType Mhtml
```

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. The format is known as archive format because it saves the web HTML code and associated resources in a single file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/mhtml

##### Chm
```
public static final WebFileType Chm
```

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. It provides an index for quick accessing the topics and navigation to different parts of the help document. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/chm

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### WordProcessingFileType
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.filetypes/wordprocessingfiletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration, com.groupdocs.conversion.filetypes.FileType

**All Implemented Interfaces:**
java.io.Serializable
```
public final class WordProcessingFileType extends FileType implements Serializable
```

Defines Word Processing files that contain user information in plain text or rich text format. A plain text file format contains unformatted text and no font or page settings etc. can be applied. In contrast, a rich text file format allows formatting options such as setting fonts type, styles (bold, italic, underline, etc.), page margins, headings, bullets and numbers, and several other formatting features. Includes the following file types: Doc, Docm, Docx, Dot, Dotm, Dotx, Odt, Ott, Rtf, Txt, Md, Learn more about Word Processing formats [here][].

[here]: https://wiki.fileformat.com/word-processing
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingFileType() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Doc | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| Docm | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| Docx | DOCX is a well-known format for Microsoft Word documents. |
| Dot | Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. |
| Dotm | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. |
| Dotx | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| Rtf | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. |
| Odt | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| Ott | Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. |
| Txt | A file with .TXT extension represents a text document that contains plain text in the form of lines. |
| Md | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. |
| Ml | Ml file |
#### Methods

| Method | Description |
| --- | --- |
| getLoadOptions() |  |
| getConvertOptions() |  |
| getExcludedSourceTypes() |  |
| getExcludedTargetTypes() |  |
##### WordProcessingFileType()
```
public WordProcessingFileType()
```

Serialization constructor

##### Doc
```
public static final WordProcessingFileType Doc
```

Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/doc

##### Docm
```
public static final WordProcessingFileType Docm
```

DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/docm

##### Docx
```
public static final WordProcessingFileType Docx
```

DOCX is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/docx

##### Dot
```
public static final WordProcessingFileType Dot
```

Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dot

##### Dotm
```
public static final WordProcessingFileType Dotm
```

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dotm

##### Dotx
```
public static final WordProcessingFileType Dotx
```

Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dotx

##### Rtf
```
public static final WordProcessingFileType Rtf
```

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/rtf

##### Odt
```
public static final WordProcessingFileType Odt
```

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/odt

##### Ott
```
public static final WordProcessingFileType Ott
```

Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/ott

##### Txt
```
public static final WordProcessingFileType Txt
```

A file with .TXT extension represents a text document that contains plain text in the form of lines. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/txt

##### Md
```
public static final WordProcessingFileType Md
```

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. MD files are saved in plain text format that uses Markdown language which also includes inline text symbols, defining how a text can be formatted such as indentations, table formatting, fonts, and headers. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/md

##### Ml
```
public static final WordProcessingFileType Ml
```

Ml file

##### getLoadOptions()
```
public LoadOptions getLoadOptions()
```

Prepared default load options for the source file type

**Returns:**
LoadOptions
##### getConvertOptions()
```
public ConvertOptions<WordProcessingFileType> getConvertOptions()
```

Prepared default convert options for the file type

**Returns:**
ConvertOptions
##### getExcludedSourceTypes()
```
public static FileType[] getExcludedSourceTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]
##### getExcludedTargetTypes()
```
public static FileType[] getExcludedTargetTypes()
```

**Returns:**
com.groupdocs.conversion.filetypes.FileType[]

### com.groupdocs.conversion.licensing
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.licensing.md

The GroupDocs.Conversion.Legacy.Licensing namespace provides classes for applying of the license

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |
| Metered | Provides methods for applying  [Metered][]  license.[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered |

### License
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Provides methods to license the component. Learn more about licensing  [here][] .

**Learn more**More about licensing: [GroupDocs Licensing FAQ][here]More about GroupDocs.Conversion licensing: [Evaluation Limitations and Licensing][]

[here]: https://purchase.groupdocs.com/faqs/licensing
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/display/conversionnet/Evaluation+Limitations+and+Licensing+of+GroupDocs.Conversion
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| isLicensed() | Returns true if a valid license has been applied; false if the component is running in evaluation mode. |
| setLicense(InputStream licenseStream) |  |
| setLicense(System.IO.Stream licenseStream) | Licenses the component. |
| setLicense(String licensePath) | Licenses the component. |
| resetLicense() |  |
##### License()
```
public License()
```

##### isLicensed()
```
public boolean isLicensed()
```

Returns true if a valid license has been applied; false if the component is running in evaluation mode.

**Returns:**
boolean
##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream |  |

##### setLicense(System.IO.Stream licenseStream)
```
public final void setLicense(System.IO.Stream licenseStream)
```

Licenses the component.

> ```
> The following example demonstrates how to set a license
>  passing Stream of the license file.
>
>  using (FileStream licenseStream = new FileStream("LicenseFile.lic", FileMode.Open))
>  {
>      GroupDocs.Conversion.License lic = new GroupDocs.Conversion.License();
>      lic.SetLicense(licenseStream);
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | com.aspose.ms.System.IO.Stream | The license stream. |

##### setLicense(String licensePath)
```
public void setLicense(String licensePath)
```

Licenses the component.

> ```
> The following example demonstrates how to set a license
>  passing a path to the license file.
>
>  string licensePath = "GroupDocs.Conversion.lic";
>  GroupDocs.Conversion.License lic = new GroupDocs.Conversion.License();
>  lic.SetLicense(licensePath);
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path. |

##### resetLicense()
```
public static void resetLicense()
```

### Metered
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.licensing/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying  [Metered][]  license. **Learn more**More about Metered licensing: [Metered Licensing FAQ][Metered]More about GroupDocs.Conversion licensing: [Evaluation Limitations and Licensing][]

[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/display/conversionnet/Evaluation+Limitations+and+Licensing+of+GroupDocs.Conversion
#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() |  |
#### Methods

| Method | Description |
| --- | --- |
| setMeteredKey(String publicKey, String privateKey) | Activates product with Metered keys. |
| getConsumptionQuantity() | Retrieves amount of MBs processed. |
| getConsumptionCredit() | Retrieves count of credits consumed. |
| increaseBytesCount(long bytesCount) |  |
| consumeCreditsBySize(long bytesCount) |  |
##### Metered()
```
public Metered()
```

##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Activates product with Metered keys.

> ```
> Following example demonstrates how to activate product with Metered keys.
>
>  string publicKey = "Public Key";
>  string privateKey = "Private Key";
>  Metered metered = new Metered();
>  metered.SetMeteredKey(publicKey, privateKey);
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | The public key. |
| privateKey | java.lang.String | The private key. |

##### getConsumptionQuantity()
```
public static BigDecimal getConsumptionQuantity()
```

Retrieves amount of MBs processed.

> ```
> Following example demonstrates how to retrieve amount of MBs processed.
>
>   string publicKey = "Public Key";
>   string privateKey = "Private Key";
>
>   Metered metered = new Metered();
>   metered.SetMeteredKey(publicKey, privateKey);
>   decimal mbProcessed = Metered.GetConsumptionQuantity();
> ```

**Returns:**
java.math.BigDecimal
##### getConsumptionCredit()
```
public static BigDecimal getConsumptionCredit()
```

Retrieves count of credits consumed.

> ```
> Following example demonstrates how to retrieve count of credits consumed.
>
>   string publicKey = "Public Key";
>   string privateKey = "Private Key";
>
>   Metered metered = new Metered();
>   metered.SetMeteredKey(publicKey, privateKey);
>   decimal creditsConsumed = Metered.GetConsumptionCredit();
> ```

**Returns:**
java.math.BigDecimal
##### increaseBytesCount(long bytesCount)
```
public static void increaseBytesCount(long bytesCount)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bytesCount | long |  |

##### consumeCreditsBySize(long bytesCount)
```
public static void consumeCreditsBySize(long bytesCount)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bytesCount | long |  |

### com.groupdocs.conversion.logging
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.logging.md

The GroupDocs.Conversion.Logging namespace provides classes for customizing logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Console logger implementation. |

### ConsoleLogger
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.logging/consolelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.conversion.logging.ILogger
```
public final class ConsoleLogger implements ILogger
```

Console logger implementation.
#### Constructors

| Constructor | Description |
| --- | --- |
| ConsoleLogger() |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message) | Writes trace log message; Trace log messages provides generally useful information about application flow. |
| warning(String message) | Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow. |
| error(String message, Exception exception) | Writes error log message; Error log messages provides information about unrecoverable events in application flow. |
##### ConsoleLogger()
```
public ConsoleLogger()
```

##### trace(String message)
```
public void trace(String message)
```

Writes trace log message; Trace log messages provides generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |

##### warning(String message)
```
public void warning(String message)
```

Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning message. |

##### error(String message, Exception exception)
```
public void error(String message, Exception exception)
```

Writes error log message; Error log messages provides information about unrecoverable events in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message. |
| exception | java.lang.Exception | The exception. |

### com.groupdocs.conversion.options.convert
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert.md

The GroupDocs.Conversion.Options.Convert namespace provides classes to specify additional options for document conversion process.

#### Classes

| Class | Description |
| --- | --- |
| CadConvertOptions | Options for conversion to Cad type. |
| CommonConvertOptions<TFileType> | abstract generic common conversion options class. |
| ConvertOptions<TFileType> | The general conversion options class. |
| DiagramConvertOptions | Options for conversion to Diagram file type. |
| EBookConvertOptions | Options for conversion to EBook file type. |
| EmailConvertOptions | Options for conversion to Email file type. |
| Font | Font settings |
| FontConvertOptions | Options for conversion to EBook file type. |
| ImageConvertOptions | Options for conversion to Image file type. |
| ImageFlipModes | Describes image flip modes. |
| JpegOptions | Options for conversion to Jpeg file type. |
| JpgColorModes | Describes Jpg color modes enumeration. |
| JpgCompressionMethods | Describes Jpg compression modes |
| NoConvertOptions | Special convert option class, which instructs converter to copy source document without any processing |
| PageDescriptionLanguageConvertOptions | Options for conversion to page descriptions language file type. |
| PdfConvertOptions | Options for conversion to Pdf file type. |
| PdfDirection | Describes Pdf text direction. |
| PdfFormats | Describes Pdf formats enumeration. |
| PdfFormattingOptions | Defines Pdf formatting options. |
| PdfOptimizationOptions | Defines Pdf optimization options. |
| PdfOptions | Options for conversion to Pdf file type. |
| PdfPageLayout | Describes Pdf page layout. |
| PdfPageMode | Describes Pdf page mode |
| PresentationConvertOptions | Describes options for conversion to Presentation file type. |
| ProjectManagementConvertOptions | Options for conversion to Project management file type. |
| PsdColorModes | Defines Psd color modes enumeration. |
| PsdCompressionMethods | Describes Psd compression methods. |
| PsdOptions | Options for converting to Psd file type. |
| Rotation | Describes page rotation enumeration |
| RtfOptions | Options for conversion to RTF file type. |
| SpreadsheetConvertOptions | Options for conversion to Spreadsheet file type. |
| TiffCompressionMethods | Describes Tiff compression methods enumeration. |
| TiffOptions | Options for conversion to TIFF file type. |
| WatermarkImageOptions | Options for settings watermark to the converted document |
| WatermarkOptions | Options for settings watermark to the converted document |
| WatermarkTextOptions | Options for settings text watermark to the converted document |
| WebConvertOptions | Options for conversion to Web file type. |
| WebpOptions | Options for conversion to Webp file type. |
| WordProcessingConvertOptions | Options for conversion to WordProcessing file type. |

#### Enumerations

| Enum | Description |
| --- | --- |
| PageOrientation |  |
| PageSize |  |
| PdfRecognitionMode |  |

### CadConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/cadconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IPagedConvertOptions
```
public class CadConvertOptions extends ConvertOptions<CadFileType> implements IPagedConvertOptions
```

Options for conversion to Cad type.
#### Constructors

| Constructor | Description |
| --- | --- |
| CadConvertOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() |  |
| setPageNumber(int pageNumber) |  |
| getPagesCount() |  |
| setPagesCount(int pagesCount) |  |
##### CadConvertOptions()
```
public CadConvertOptions()
```

Initializes new instance of  class.

##### getPageNumber()
```
public Integer getPageNumber()
```

Gets the page number to start conversion from.

**Returns:**
java.lang.Integer
##### setPageNumber(int pageNumber)
```
public void setPageNumber(int pageNumber)
```

Sets the page number to start conversion from.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |

##### getPagesCount()
```
public Integer getPagesCount()
```

Gets number of pages to convert starting from PageNumber.

**Returns:**
java.lang.Integer
##### setPagesCount(int pagesCount)
```
public void setPagesCount(int pagesCount)
```

Sets number of pages to convert starting from PageNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagesCount | int |  |

### CommonConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/commonconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IWatermarkedConvertOptions, com.groupdocs.conversion.options.convert.IPagedConvertOptions, com.groupdocs.conversion.options.convert.IPageRangedConvertOptions
```
public abstract class CommonConvertOptions<TFileType> extends ConvertOptions<TFileType> implements IWatermarkedConvertOptions, IPagedConvertOptions, IPageRangedConvertOptions
```

abstract generic common conversion options class.
#### Methods

| Method | Description |
| --- | --- |
| getWatermark() |  |
| setWatermark(WatermarkOptions watermark) |  |
| getPageNumber() |  |
| setPageNumber(int pageNumber) |  |
| getPagesCount() |  |
| setPagesCount(int pagesCount) |  |
| getPages() |  |
| setPages(List<Integer> pages) |  |
##### getWatermark()
```
public WatermarkOptions getWatermark()
```

Gets watermark specific options

**Returns:**
WatermarkOptions
##### setWatermark(WatermarkOptions watermark)
```
public void setWatermark(WatermarkOptions watermark)
```

Sets watermark specific options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | WatermarkOptions |  |

##### getPageNumber()
```
public Integer getPageNumber()
```

Gets the page number to start conversion from.

**Returns:**
java.lang.Integer
##### setPageNumber(int pageNumber)
```
public void setPageNumber(int pageNumber)
```

Sets the page number to start conversion from.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |

##### getPagesCount()
```
public Integer getPagesCount()
```

Gets number of pages to convert starting from PageNumber.

**Returns:**
java.lang.Integer
##### setPagesCount(int pagesCount)
```
public void setPagesCount(int pagesCount)
```

Sets number of pages to convert starting from PageNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagesCount | int |  |

##### getPages()
```
public List<Integer> getPages()
```

Gets The list of page indexes to be converted. Should be specified to convert specific pages.

**Returns:**
java.util.List<java.lang.Integer>
##### setPages(List<Integer> pages)
```
public void setPages(List<Integer> pages)
```

Sets the list of page indexes to be converted. Should be specified to convert specific pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pages | java.util.List<java.lang.Integer> |  |

### ConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/convertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.convert.IConvertOptions, java.lang.Cloneable
```
public abstract class ConvertOptions<TFileType> extends ValueObject implements Serializable, IConvertOptions, Cloneable
```

The general conversion options class.
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | \{@inheritDoc\} |
| setFormat(FileType value) | The desired file type the input document should be converted to. |
| deepClone() | Clones current options instance. |
| getFormat_ConvertOptions_New() | The desired file type the input document should be converted to. |
| setFormat_ConvertOptions_New(TFileType value) | The desired file type the input document should be converted to. |
##### getFormat()
```
public FileType getFormat()
```

Gets the desired file type the input document should be converted to.

**Returns:**
FileType
##### setFormat(FileType value)
```
public void setFormat(FileType value)
```

The desired file type the input document should be converted to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### deepClone()
```
public final Object deepClone()
```

Clones current options instance.

**Returns:**
java.lang.Object -
##### getFormat_ConvertOptions_New()
```
public final TFileType getFormat_ConvertOptions_New()
```

The desired file type the input document should be converted to.

**Returns:**
TFileType
##### setFormat_ConvertOptions_New(TFileType value)
```
public final void setFormat_ConvertOptions_New(TFileType value)
```

The desired file type the input document should be converted to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TFileType |  |

### DiagramConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/diagramconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
```
public class DiagramConvertOptions extends CommonConvertOptions<DiagramFileType>
```

Options for conversion to Diagram file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramConvertOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| isAutoFitPageToDrawingContent() | Defines whether need enlarge page to fit drawing content or not |
| setAutoFitPageToDrawingContent(boolean autoFitPageToDrawingContent) | Sets need enlarge page flag |
##### DiagramConvertOptions()
```
public DiagramConvertOptions()
```

Initializes new instance of  class.

##### isAutoFitPageToDrawingContent()
```
public boolean isAutoFitPageToDrawingContent()
```

Defines whether need enlarge page to fit drawing content or not

**Returns:**
boolean - need enlarge page flag
##### setAutoFitPageToDrawingContent(boolean autoFitPageToDrawingContent)
```
public void setAutoFitPageToDrawingContent(boolean autoFitPageToDrawingContent)
```

Sets need enlarge page flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoFitPageToDrawingContent | boolean | need enlarge page flag |

### EBookConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/ebookconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions
```
public class EBookConvertOptions extends CommonConvertOptions<EBookFileType> implements IPageSizeConvertOptions, IPageOrientationConvertOptions
```

Options for conversion to EBook file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| EBookConvertOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageSize() |  |
| setPageSize(PageSize pageSize) |  |
| getPageWidth() |  |
| setPageWidth(float pageWidth) |  |
| getPageHeight() |  |
| setPageHeight(float pageHeight) |  |
| getPageOrientation() |  |
| setPageOrientation(PageOrientation pageOrientation) |  |
##### EBookConvertOptions()
```
public EBookConvertOptions()
```

Initializes new instance of  class.

##### getPageSize()
```
public PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public float getPageWidth()
```

Specified page width in points if  is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public float getPageHeight()
```

Specified page height in points if  is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

##### getPageOrientation()
```
public PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

### EmailConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/emailconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public class EmailConvertOptions extends ConvertOptions<EmailFileType> implements Serializable
```

Options for conversion to Email file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailConvertOptions() | Initializes new instance of  class. |
##### EmailConvertOptions()
```
public EmailConvertOptions()
```

Initializes new instance of  class.

### Font
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/font.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
```
public class Font extends ValueObject
```

Font settings
#### Constructors

| Constructor | Description |
| --- | --- |
| Font(String fontFamilyName, float size) | creates new Font instance |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Fets font family name |
| getSize() | Gets font size |
| isBold() | Font bold flag |
| setBold(boolean bold) | Sets Font bold flag |
| isItalic() | Font italic flag |
| setItalic(boolean italic) | Sets font italic flag |
| isUnderline() | Gets Font underline |
| setUnderline(boolean underline) | Sets Font underline |
| getDefault() |  |
| clone(float newSize) |  |
##### Font(String fontFamilyName, float size)
```
public Font(String fontFamilyName, float size)
```

creates new Font instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | java.lang.String | Font name |
| size | float | Font size |

##### getFamilyName()
```
public String getFamilyName()
```

Fets font family name

**Returns:**
java.lang.String - Font family name
##### getSize()
```
public float getSize()
```

Gets font size

**Returns:**
float - Font size
##### isBold()
```
public boolean isBold()
```

Font bold flag

**Returns:**
boolean - true if bold
##### setBold(boolean bold)
```
public void setBold(boolean bold)
```

Sets Font bold flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bold | boolean | true if bold |

##### isItalic()
```
public boolean isItalic()
```

Font italic flag

**Returns:**
boolean - true if Italic
##### setItalic(boolean italic)
```
public void setItalic(boolean italic)
```

Sets font italic flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| italic | boolean | true if Italic |

##### isUnderline()
```
public boolean isUnderline()
```

Gets Font underline

**Returns:**
boolean - true if Font is underline
##### setUnderline(boolean underline)
```
public void setUnderline(boolean underline)
```

Sets Font underline

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| underline | boolean | Font underline flag |

##### getDefault()
```
public static Font getDefault()
```

**Returns:**
Font
##### clone(float newSize)
```
public Font clone(float newSize)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newSize | float |  |

**Returns:**
Font

### FontConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/fontconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions
```
public class FontConvertOptions extends ConvertOptions<FontFileType>
```

Options for conversion to EBook file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontConvertOptions() | Initializes new instance of  class. |
##### FontConvertOptions()
```
public FontConvertOptions()
```

Initializes new instance of  class.

### ImageConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/imageconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class ImageConvertOptions extends CommonConvertOptions<ImageFileType> implements Serializable
```

Options for conversion to Image file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageConvertOptions() | Initializes new instance of ImageConvertOptions class. |
#### Fields

| Field | Description |
| --- | --- |
| DEFAULT_DPI |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Desired image width after conversion. |
| setWidth(int value) | Desired image width after conversion. |
| getHeight() | Desired image height after conversion. |
| setHeight(int value) | Desired image height after conversion. |
| getUsePdf() | If  true , the input firstly is converted to PDF and after that to desired format. |
| setUsePdf(boolean value) | If  true , the input firstly is converted to PDF and after that to desired format. |
| getHorizontalResolution() | Desired image horizontal resolution after conversion. |
| setHorizontalResolution(int value) | Desired image horizontal resolution after conversion. |
| getVerticalResolution() | Desired image vertical resolution after conversion. |
| setVerticalResolution(int value) | Desired image vertical resolution after conversion. |
| getTiffOptions() | Tiff specific convert options. |
| setTiffOptions(TiffOptions value) | Tiff specific convert options. |
| getPsdOptions() | Psd specific convert options. |
| setPsdOptions(PsdOptions value) | Psd specific convert options. |
| getWebpOptions() | Webp specific convert options. |
| setWebpOptions(WebpOptions value) | Webp specific convert options. |
| getGrayscale() | Indicates whether to convert into grayscale image. |
| setGrayscale(boolean value) | Indicates whether to convert into grayscale image. |
| getRotateAngle() | Image rotation angle. |
| setRotateAngle(int value) | Image rotation angle. |
| getJpegOptions() | Jpeg specific convert options. |
| setJpegOptions(JpegOptions value) | Jpeg specific convert options. |
| getFlipMode() | Image flip mode. |
| setFlipMode(ImageFlipModes value) | Image flip mode. |
| getBrightness() | Adjusts image brightness. |
| setBrightness(int value) | Adjusts image brightness. |
| getContrast() | Adjusts image contrast. |
| setContrast(int value) | Adjusts image contrast. |
| getGamma() | Adjusts image gamma. |
| setGamma(double value) | Adjusts image gamma. |
| setGamma(float value) | Adjusts image gamma. |
| getBackgroundColor() | Gets background color |
| setBackgroundColor(System.Drawing.Color backgroundColor) | Sets background color where supported by the source format |
##### ImageConvertOptions()
```
public ImageConvertOptions()
```

Initializes new instance of ImageConvertOptions class.

##### DEFAULT_DPI
```
public static final int DEFAULT_DPI
```

##### getWidth()
```
public final int getWidth()
```

Desired image width after conversion.

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Desired image width after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Desired image height after conversion.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Desired image height after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getUsePdf()
```
public final boolean getUsePdf()
```

If  true , the input firstly is converted to PDF and after that to desired format.

**Returns:**
boolean
##### setUsePdf(boolean value)
```
public final void setUsePdf(boolean value)
```

If  true , the input firstly is converted to PDF and after that to desired format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHorizontalResolution()
```
public final int getHorizontalResolution()
```

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Returns:**
int
##### setHorizontalResolution(int value)
```
public final void setHorizontalResolution(int value)
```

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVerticalResolution()
```
public final int getVerticalResolution()
```

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Returns:**
int
##### setVerticalResolution(int value)
```
public final void setVerticalResolution(int value)
```

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTiffOptions()
```
public final TiffOptions getTiffOptions()
```

Tiff specific convert options.

**Returns:**
TiffOptions
##### setTiffOptions(TiffOptions value)
```
public final void setTiffOptions(TiffOptions value)
```

Tiff specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffOptions |  |

##### getPsdOptions()
```
public final PsdOptions getPsdOptions()
```

Psd specific convert options.

**Returns:**
PsdOptions
##### setPsdOptions(PsdOptions value)
```
public final void setPsdOptions(PsdOptions value)
```

Psd specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PsdOptions |  |

##### getWebpOptions()
```
public final WebpOptions getWebpOptions()
```

Webp specific convert options.

**Returns:**
WebpOptions
##### setWebpOptions(WebpOptions value)
```
public final void setWebpOptions(WebpOptions value)
```

Webp specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WebpOptions |  |

##### getGrayscale()
```
public final boolean getGrayscale()
```

Indicates whether to convert into grayscale image.

**Returns:**
boolean
##### setGrayscale(boolean value)
```
public final void setGrayscale(boolean value)
```

Indicates whether to convert into grayscale image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRotateAngle()
```
public final int getRotateAngle()
```

Image rotation angle.

**Returns:**
int
##### setRotateAngle(int value)
```
public final void setRotateAngle(int value)
```

Image rotation angle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getJpegOptions()
```
public final JpegOptions getJpegOptions()
```

Jpeg specific convert options.

**Returns:**
JpegOptions
##### setJpegOptions(JpegOptions value)
```
public final void setJpegOptions(JpegOptions value)
```

Jpeg specific convert options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | JpegOptions |  |

##### getFlipMode()
```
public final ImageFlipModes getFlipMode()
```

Image flip mode.

**Returns:**
ImageFlipModes
##### setFlipMode(ImageFlipModes value)
```
public final void setFlipMode(ImageFlipModes value)
```

Image flip mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ImageFlipModes |  |

##### getBrightness()
```
public final int getBrightness()
```

Adjusts image brightness.

**Returns:**
int
##### setBrightness(int value)
```
public final void setBrightness(int value)
```

Adjusts image brightness.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getContrast()
```
public final int getContrast()
```

Adjusts image contrast.

**Returns:**
int
##### setContrast(int value)
```
public final void setContrast(int value)
```

Adjusts image contrast.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getGamma()
```
public final double getGamma()
```

Adjusts image gamma.

**Returns:**
double
##### setGamma(double value)
```
public final void setGamma(double value)
```

Adjusts image gamma.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### setGamma(float value)
```
public final void setGamma(float value)
```

Adjusts image gamma.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getBackgroundColor()
```
public System.Drawing.Color getBackgroundColor()
```

Gets background color

**Returns:**
com.aspose.ms.System.Drawing.Color - background color
##### setBackgroundColor(System.Drawing.Color backgroundColor)
```
public void setBackgroundColor(System.Drawing.Color backgroundColor)
```

Sets background color where supported by the source format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | com.aspose.ms.System.Drawing.Color | background color |

### ImageFlipModes
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/imageflipmodes.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class ImageFlipModes extends Enumeration implements Serializable
```

Describes image flip modes.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageFlipModes() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| None | No flipping. |
| FlipX | Horizontal flip. |
| FlipY | Flip vertical. |
| FlipXY | Flip horizontal and vertical. |
##### ImageFlipModes()
```
public ImageFlipModes()
```

Serialization constructor

##### None
```
public static final ImageFlipModes None
```

No flipping.

##### FlipX
```
public static final ImageFlipModes FlipX
```

Horizontal flip.

##### FlipY
```
public static final ImageFlipModes FlipY
```

Flip vertical.

##### FlipXY
```
public static final ImageFlipModes FlipXY
```

Flip horizontal and vertical.

### JpegOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/jpegoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class JpegOptions extends ValueObject implements Serializable
```

Options for conversion to Jpeg file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| JpegOptions() | Initializes new instance of JpegOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getQuality() | Desired image quality. |
| setQuality(int value) | Desired image quality. |
| getColorMode() | Jpg color mode. |
| setColorMode(JpgColorModes value) | Jpg color mode. |
| getCompression() | Jpg compression method. |
| setCompression(JpgCompressionMethods value) | Jpg compression method. |
##### JpegOptions()
```
public JpegOptions()
```

Initializes new instance of JpegOptions class.

##### getQuality()
```
public final int getQuality()
```

Desired image quality. The value must be between 0 and 100. The default value is 100.

**Returns:**
int
##### setQuality(int value)
```
public final void setQuality(int value)
```

Desired image quality. The value must be between 0 and 100. The default value is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getColorMode()
```
public final JpgColorModes getColorMode()
```

Jpg color mode.

**Returns:**
JpgColorModes
##### setColorMode(JpgColorModes value)
```
public final void setColorMode(JpgColorModes value)
```

Jpg color mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | JpgColorModes |  |

##### getCompression()
```
public final JpgCompressionMethods getCompression()
```

Jpg compression method.

**Returns:**
JpgCompressionMethods
##### setCompression(JpgCompressionMethods value)
```
public final void setCompression(JpgCompressionMethods value)
```

Jpg compression method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | JpgCompressionMethods |  |

### JpgColorModes
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/jpgcolormodes.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class JpgColorModes extends Enumeration implements Serializable
```

Describes Jpg color modes enumeration.
#### Constructors

| Constructor | Description |
| --- | --- |
| JpgColorModes() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| YCbCr | YCbCr image. |
| Rgb | RGB. |
| Cmyk | CMYK. |
| Ycck | Ycck. |
| Grayscale | Grayscale. |
##### JpgColorModes()
```
public JpgColorModes()
```

Serialization constructor

##### YCbCr
```
public static final JpgColorModes YCbCr
```

YCbCr image. Standard option for jpeg images.

##### Rgb
```
public static final JpgColorModes Rgb
```

RGB.

##### Cmyk
```
public static final JpgColorModes Cmyk
```

CMYK.

##### Ycck
```
public static final JpgColorModes Ycck
```

Ycck.

##### Grayscale
```
public static final JpgColorModes Grayscale
```

Grayscale.

### JpgCompressionMethods
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/jpgcompressionmethods.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class JpgCompressionMethods extends Enumeration implements Serializable
```

Describes Jpg compression modes
#### Constructors

| Constructor | Description |
| --- | --- |
| JpgCompressionMethods() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Baseline | The baseline compression. |
| Progressive | Progressive compression. |
| Lossless | Lossless compression. |
| JpegLs | JpegLs compression. |
##### JpgCompressionMethods()
```
public JpgCompressionMethods()
```

Serialization constructor

##### Baseline
```
public static final JpgCompressionMethods Baseline
```

The baseline compression.

##### Progressive
```
public static final JpgCompressionMethods Progressive
```

Progressive compression.

##### Lossless
```
public static final JpgCompressionMethods Lossless
```

Lossless compression.

##### JpegLs
```
public static final JpgCompressionMethods JpegLs
```

JpegLs compression.

### NoConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/noconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions
```
public class NoConvertOptions extends ConvertOptions<FileType>
```

Special convert option class, which instructs converter to copy source document without any processing
#### Constructors

| Constructor | Description |
| --- | --- |
| NoConvertOptions() |  |
##### NoConvertOptions()
```
public NoConvertOptions()
```

### PageDescriptionLanguageConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
```
public class PageDescriptionLanguageConvertOptions extends CommonConvertOptions<PageDescriptionLanguageFileType>
```

Options for conversion to page descriptions language file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageDescriptionLanguageConvertOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Desired page width after conversion. |
| setWidth(int width) |  |
| getHeight() | Desired page height after conversion. |
| setHeight(int height) |  |
##### PageDescriptionLanguageConvertOptions()
```
public PageDescriptionLanguageConvertOptions()
```

Initializes new instance of  class.

##### getWidth()
```
public int getWidth()
```

Desired page width after conversion.

**Returns:**
int
##### setWidth(int width)
```
public void setWidth(int width)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int |  |

##### getHeight()
```
public int getHeight()
```

Desired page height after conversion.

**Returns:**
int
##### setHeight(int height)
```
public void setHeight(int height)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int |  |

### PageOrientation
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pageorientation.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PageOrientation extends Enum<PageOrientation>
```
#### Fields

| Field | Description |
| --- | --- |
| LANDSCAPE |  |
| PORTRAIT |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getKey() |  |
| getName() |  |
##### LANDSCAPE
```
public static final PageOrientation LANDSCAPE
```

##### PORTRAIT
```
public static final PageOrientation PORTRAIT
```

##### values()
```
public static PageOrientation[] values()
```

**Returns:**
com.groupdocs.conversion.options.convert.PageOrientation[]
##### valueOf(String name)
```
public static PageOrientation valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageOrientation
##### getKey()
```
public String getKey()
```

**Returns:**
java.lang.String
##### getName()
```
public String getName()
```

**Returns:**
java.lang.String

### PageSize
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pagesize.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.conversion.options.convert.IPageSize
```
public enum PageSize extends Enum<PageSize> implements IPageSize
```
#### Fields

| Field | Description |
| --- | --- |
| A3 |  |
| A4 |  |
| A5 |  |
| B4 |  |
| B5 |  |
| CUSTOM |  |
| ENVELOPE_DL |  |
| EXECUTIVE |  |
| FOLIO |  |
| LEDGER |  |
| LEGAL |  |
| LETTER |  |
| PAPER_10_X_14 |  |
| PAPER_11_X_17 |  |
| QUARTO |  |
| STATEMENT |  |
| TABLOID |  |
| UNSET |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| createCustom(float width, float height) |  |
| getKey() |  |
| getName() |  |
| getWidth() |  |
| getHeight() |  |
| pointsToPixels(float points, int dpi) |  |
| pixelsToPoints(int pixels, int dpi) |  |
##### A3
```
public static final PageSize A3
```

##### A4
```
public static final PageSize A4
```

##### A5
```
public static final PageSize A5
```

##### B4
```
public static final PageSize B4
```

##### B5
```
public static final PageSize B5
```

##### CUSTOM
```
public static final PageSize CUSTOM
```

##### ENVELOPE_DL
```
public static final PageSize ENVELOPE_DL
```

##### EXECUTIVE
```
public static final PageSize EXECUTIVE
```

##### FOLIO
```
public static final PageSize FOLIO
```

##### LEDGER
```
public static final PageSize LEDGER
```

##### LEGAL
```
public static final PageSize LEGAL
```

##### LETTER
```
public static final PageSize LETTER
```

##### PAPER_10_X_14
```
public static final PageSize PAPER_10_X_14
```

##### PAPER_11_X_17
```
public static final PageSize PAPER_11_X_17
```

##### QUARTO
```
public static final PageSize QUARTO
```

##### STATEMENT
```
public static final PageSize STATEMENT
```

##### TABLOID
```
public static final PageSize TABLOID
```

##### UNSET
```
public static final PageSize UNSET
```

##### values()
```
public static PageSize[] values()
```

**Returns:**
com.groupdocs.conversion.options.convert.PageSize[]
##### valueOf(String name)
```
public static PageSize valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageSize
##### createCustom(float width, float height)
```
public static PageSize.PageSizeCustom createCustom(float width, float height)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | float |  |
| height | float |  |

**Returns:**
PageSizeCustom
##### getKey()
```
public String getKey()
```

**Returns:**
java.lang.String
##### getName()
```
public String getName()
```

**Returns:**
java.lang.String
##### getWidth()
```
public float getWidth()
```

**Returns:**
float
##### getHeight()
```
public float getHeight()
```

**Returns:**
float
##### pointsToPixels(float points, int dpi)
```
public static int pointsToPixels(float points, int dpi)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| points | float |  |
| dpi | int |  |

**Returns:**
int
##### pixelsToPoints(int pixels, int dpi)
```
public static float pixelsToPoints(int pixels, int dpi)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pixels | int |  |
| dpi | int |  |

**Returns:**
float

### PdfConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.convert.IPageMarginConvertOptions, com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions
```
public class PdfConvertOptions extends CommonConvertOptions<PdfFileType> implements Serializable, IPageMarginConvertOptions, IPageSizeConvertOptions, IPageOrientationConvertOptions
```

Options for conversion to Pdf file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfConvertOptions() | Initializes new instance of PdfConvertOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getDpi() | Desired page DPI after conversion. |
| setDpi(int value) | Desired page DPI after conversion. |
| getPassword() | Set this property if you want to protect the converted document with a password. |
| setPassword(String value) | Set this property if you want to protect the converted document with a password. |
| getMarginTop() | Desired page top margin in pixels after conversion. |
| setMarginTop(int value) | Desired page top margin in pixels after conversion. |
| getMarginBottom() | Desired page bottom margin in pixels after conversion. |
| setMarginBottom(int value) | Desired page bottom margin in pixels after conversion. |
| getMarginLeft() | Desired page left margin in pixels after conversion. |
| setMarginLeft(int value) | Desired page left margin in pixels after conversion. |
| getMarginRight() | Desired page right margin in pixels after conversion. |
| setMarginRight(int value) | Desired page right margin in pixels after conversion. |
| getPdfOptions() | Pdf specific convert options |
| setPdfOptions(PdfOptions value) | Pdf specific convert options |
| getRotate() | Page rotation |
| setRotate(Rotation value) | Page rotation |
| getPageOrientation() |  |
| setPageOrientation(PageOrientation pageOrientation) |  |
| getPageSize() |  |
| setPageSize(PageSize pageSize) |  |
| getPageWidth() |  |
| setPageWidth(float pageWidth) |  |
| getPageHeight() |  |
| setPageHeight(float pageHeight) |  |
##### PdfConvertOptions()
```
public PdfConvertOptions()
```

Initializes new instance of PdfConvertOptions class.

##### getDpi()
```
public final int getDpi()
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Returns:**
int
##### setDpi(int value)
```
public final void setDpi(int value)
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMarginTop()
```
public final int getMarginTop()
```

Desired page top margin in pixels after conversion.

**Returns:**
int
##### setMarginTop(int value)
```
public final void setMarginTop(int value)
```

Desired page top margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginBottom()
```
public final int getMarginBottom()
```

Desired page bottom margin in pixels after conversion.

**Returns:**
int
##### setMarginBottom(int value)
```
public final void setMarginBottom(int value)
```

Desired page bottom margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginLeft()
```
public final int getMarginLeft()
```

Desired page left margin in pixels after conversion.

**Returns:**
int
##### setMarginLeft(int value)
```
public final void setMarginLeft(int value)
```

Desired page left margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginRight()
```
public final int getMarginRight()
```

Desired page right margin in pixels after conversion.

**Returns:**
int
##### setMarginRight(int value)
```
public final void setMarginRight(int value)
```

Desired page right margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPdfOptions()
```
public final PdfOptions getPdfOptions()
```

Pdf specific convert options

**Returns:**
PdfOptions
##### setPdfOptions(PdfOptions value)
```
public final void setPdfOptions(PdfOptions value)
```

Pdf specific convert options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfOptions |  |

##### getRotate()
```
public final Rotation getRotate()
```

Page rotation

**Returns:**
Rotation
##### setRotate(Rotation value)
```
public final void setRotate(Rotation value)
```

Page rotation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Rotation |  |

##### getPageOrientation()
```
public PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

##### getPageSize()
```
public PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public float getPageWidth()
```

Specified page width in points if  is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public float getPageHeight()
```

Specified page height in points if  is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

### PdfDirection
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfdirection.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PdfDirection extends Enumeration implements Serializable
```

Describes Pdf text direction.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDirection() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| L2R | Left to right. |
| R2L | Right to left. |
##### PdfDirection()
```
public PdfDirection()
```

Serialization constructor

##### L2R
```
public static final PdfDirection L2R
```

Left to right.

##### R2L
```
public static final PdfDirection R2L
```

Right to left.

### PdfFormats
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfFormats extends Enumeration implements Serializable
```

Describes Pdf formats enumeration.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFormats() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Default | Default pdf format |
| PdfA_1A | PDF/A-1a \\u2013 Level A (accessible) conformance. |
| PdfA_1B | PDF/A-1b \\u2013 Level B (basic) conformance. |
| PdfA_2A | PDF/A-2a conformance. |
| PdfA_3A | PDF/A-3a conformance. |
| PdfA_2B | PDF/A-2b conformance. |
| PdfA_2U | PDF/A-2u conformance. |
| PdfA_3B | PDF/A-3b conformance. |
| PdfA_3U | PDF/A-3u conformance. |
| v1_3 | PDF version 1.3. |
| v1_4 | PDF version 1.4. |
| v1_5 | PDF version 1.5. |
| v1_6 | PDF version 1.6. |
| v1_7 | PDF version 1.7. |
| PdfX_1A | PDF/X-1a conformance. |
| PdfX_3 | PDF/X-3 conformance. |
| PdfUA_1 | PDF/UA-1 conformance. |
##### PdfFormats()
```
public PdfFormats()
```

Serialization constructor

##### Default
```
public static final PdfFormats Default
```

Default pdf format

##### PdfA_1A
```
public static final PdfFormats PdfA_1A
```

PDF/A-1a \\u2013 Level A (accessible) conformance.

##### PdfA_1B
```
public static final PdfFormats PdfA_1B
```

PDF/A-1b \\u2013 Level B (basic) conformance.

##### PdfA_2A
```
public static final PdfFormats PdfA_2A
```

PDF/A-2a conformance.

##### PdfA_3A
```
public static final PdfFormats PdfA_3A
```

PDF/A-3a conformance.

##### PdfA_2B
```
public static final PdfFormats PdfA_2B
```

PDF/A-2b conformance.

##### PdfA_2U
```
public static final PdfFormats PdfA_2U
```

PDF/A-2u conformance.

##### PdfA_3B
```
public static final PdfFormats PdfA_3B
```

PDF/A-3b conformance.

##### PdfA_3U
```
public static final PdfFormats PdfA_3U
```

PDF/A-3u conformance.

##### v1_3
```
public static final PdfFormats v1_3
```

PDF version 1.3.

##### v1_4
```
public static final PdfFormats v1_4
```

PDF version 1.4.

##### v1_5
```
public static final PdfFormats v1_5
```

PDF version 1.5.

##### v1_6
```
public static final PdfFormats v1_6
```

PDF version 1.6.

##### v1_7
```
public static final PdfFormats v1_7
```

PDF version 1.7.

##### PdfX_1A
```
public static final PdfFormats PdfX_1A
```

PDF/X-1a conformance.

##### PdfX_3
```
public static final PdfFormats PdfX_3
```

PDF/X-3 conformance.

##### PdfUA_1
```
public static final PdfFormats PdfUA_1
```

PDF/UA-1 conformance.

### PdfFormattingOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfformattingoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfFormattingOptions extends ValueObject implements Serializable
```

Defines Pdf formatting options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFormattingOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getCenterWindow() | Specifies whether position of the document's window will be centered on the screen. |
| setCenterWindow(boolean value) | Specifies whether position of the document's window will be centered on the screen. |
| getDirection() | Sets reading order of text: L2R (left to right) or R2L (right to left). |
| setDirection(PdfDirection value) | Sets reading order of text: L2R (left to right) or R2L (right to left). |
| getDisplayDocTitle() | Specifies whether document's window title bar should display document title. |
| setDisplayDocTitle(boolean value) | Specifies whether document's window title bar should display document title. |
| getFitWindow() | Specifies whether document window must be resized to fit the first displayed page. |
| setFitWindow(boolean value) | Specifies whether document window must be resized to fit the first displayed page. |
| getHideMenuBar() | Specifies whether menu bar should be hidden when document is active. |
| setHideMenuBar(boolean value) | Specifies whether menu bar should be hidden when document is active. |
| getHideToolBar() | Specifies whether toolbar should be hidden when document is active. |
| setHideToolBar(boolean value) | Specifies whether toolbar should be hidden when document is active. |
| getHideWindowUI() | Specifies whether user interface elements should be hidden when document is active. |
| setHideWindowUI(boolean value) | Specifies whether user interface elements should be hidden when document is active. |
| getNonFullScreenPageMode() | Sets page mode, specifying how to display the document on exiting full-screen mode. |
| setNonFullScreenPageMode(PdfPageMode value) | Sets page mode, specifying how to display the document on exiting full-screen mode. |
| getPageLayout() | Sets page layout which shall be used when the document is opened. |
| setPageLayout(PdfPageLayout value) | Sets page layout which shall be used when the document is opened. |
| getPageMode() | Sets page mode, specifying how document should be displayed when opened. |
| setPageMode(PdfPageMode value) | Sets page mode, specifying how document should be displayed when opened. |
##### PdfFormattingOptions()
```
public PdfFormattingOptions()
```

##### getCenterWindow()
```
public final boolean getCenterWindow()
```

Specifies whether position of the document's window will be centered on the screen. Default: false.

**Returns:**
boolean
##### setCenterWindow(boolean value)
```
public final void setCenterWindow(boolean value)
```

Specifies whether position of the document's window will be centered on the screen. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDirection()
```
public final PdfDirection getDirection()
```

Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.

**Returns:**
PdfDirection
##### setDirection(PdfDirection value)
```
public final void setDirection(PdfDirection value)
```

Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfDirection |  |

##### getDisplayDocTitle()
```
public final boolean getDisplayDocTitle()
```

Specifies whether document's window title bar should display document title. Default: false.

**Returns:**
boolean
##### setDisplayDocTitle(boolean value)
```
public final void setDisplayDocTitle(boolean value)
```

Specifies whether document's window title bar should display document title. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFitWindow()
```
public final boolean getFitWindow()
```

Specifies whether document window must be resized to fit the first displayed page. Default: false.

**Returns:**
boolean
##### setFitWindow(boolean value)
```
public final void setFitWindow(boolean value)
```

Specifies whether document window must be resized to fit the first displayed page. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHideMenuBar()
```
public final boolean getHideMenuBar()
```

Specifies whether menu bar should be hidden when document is active. Default: false.

**Returns:**
boolean
##### setHideMenuBar(boolean value)
```
public final void setHideMenuBar(boolean value)
```

Specifies whether menu bar should be hidden when document is active. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHideToolBar()
```
public final boolean getHideToolBar()
```

Specifies whether toolbar should be hidden when document is active. Default: false.

**Returns:**
boolean
##### setHideToolBar(boolean value)
```
public final void setHideToolBar(boolean value)
```

Specifies whether toolbar should be hidden when document is active. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getHideWindowUI()
```
public final boolean getHideWindowUI()
```

Specifies whether user interface elements should be hidden when document is active. Default: false.

**Returns:**
boolean
##### setHideWindowUI(boolean value)
```
public final void setHideWindowUI(boolean value)
```

Specifies whether user interface elements should be hidden when document is active. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getNonFullScreenPageMode()
```
public final PdfPageMode getNonFullScreenPageMode()
```

Sets page mode, specifying how to display the document on exiting full-screen mode.

**Returns:**
PdfPageMode
##### setNonFullScreenPageMode(PdfPageMode value)
```
public final void setNonFullScreenPageMode(PdfPageMode value)
```

Sets page mode, specifying how to display the document on exiting full-screen mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfPageMode |  |

##### getPageLayout()
```
public final PdfPageLayout getPageLayout()
```

Sets page layout which shall be used when the document is opened.

**Returns:**
PdfPageLayout
##### setPageLayout(PdfPageLayout value)
```
public final void setPageLayout(PdfPageLayout value)
```

Sets page layout which shall be used when the document is opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfPageLayout |  |

##### getPageMode()
```
public final PdfPageMode getPageMode()
```

Sets page mode, specifying how document should be displayed when opened.

**Returns:**
PdfPageMode
##### setPageMode(PdfPageMode value)
```
public final void setPageMode(PdfPageMode value)
```

Sets page mode, specifying how document should be displayed when opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfPageMode |  |

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfoptimizationoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfOptimizationOptions extends ValueObject implements Serializable
```

Defines Pdf optimization options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptimizationOptions() | Initializes new instance of PdfOptimizationOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getLinkDuplicateStreams() | Link duplicate streams |
| setLinkDuplicateStreams(boolean value) | Link duplicate streams |
| getRemoveUnusedObjects() | Remove unused objects |
| setRemoveUnusedObjects(boolean value) | Remove unused objects |
| getRemoveUnusedStreams() | Remove unused streams |
| setRemoveUnusedStreams(boolean value) | Remove unused streams |
| getCompressImages() | If CompressImages set to  true , all images in the document are recompressed. |
| setCompressImages(boolean value) | If CompressImages set to  true , all images in the document are recompressed. |
| getImageQuality() | Value in percent where 100% is unchanged quality and image size. |
| setImageQuality(int value) | Value in percent where 100% is unchanged quality and image size. |
| getUnembedFonts() | Make fonts not embedded if set to true |
| setUnembedFonts(boolean value) | Make fonts not embedded if set to true |
| getFontSubsetStrategy() |  |
| setFontSubsetStrategy(PdfFontSubsetStrategy fontSubsetStrategy) | Set font subset strategy |
##### PdfOptimizationOptions()
```
public PdfOptimizationOptions()
```

Initializes new instance of PdfOptimizationOptions class.

##### getLinkDuplicateStreams()
```
public final boolean getLinkDuplicateStreams()
```

Link duplicate streams

**Returns:**
boolean
##### setLinkDuplicateStreams(boolean value)
```
public final void setLinkDuplicateStreams(boolean value)
```

Link duplicate streams

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRemoveUnusedObjects()
```
public final boolean getRemoveUnusedObjects()
```

Remove unused objects

**Returns:**
boolean
##### setRemoveUnusedObjects(boolean value)
```
public final void setRemoveUnusedObjects(boolean value)
```

Remove unused objects

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRemoveUnusedStreams()
```
public final boolean getRemoveUnusedStreams()
```

Remove unused streams

**Returns:**
boolean
##### setRemoveUnusedStreams(boolean value)
```
public final void setRemoveUnusedStreams(boolean value)
```

Remove unused streams

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getCompressImages()
```
public final boolean getCompressImages()
```

If CompressImages set to  true , all images in the document are recompressed. The compression is defined by the ImageQuality property.

**Returns:**
boolean
##### setCompressImages(boolean value)
```
public final void setCompressImages(boolean value)
```

If CompressImages set to  true , all images in the document are recompressed. The compression is defined by the ImageQuality property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getImageQuality()
```
public final int getImageQuality()
```

Value in percent where 100% is unchanged quality and image size. To decrease the image size set this property to less than 100

**Returns:**
int
##### setImageQuality(int value)
```
public final void setImageQuality(int value)
```

Value in percent where 100% is unchanged quality and image size. To decrease the image size set this property to less than 100

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getUnembedFonts()
```
public final boolean getUnembedFonts()
```

Make fonts not embedded if set to true

**Returns:**
boolean
##### setUnembedFonts(boolean value)
```
public final void setUnembedFonts(boolean value)
```

Make fonts not embedded if set to true

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFontSubsetStrategy()
```
public PdfFontSubsetStrategy getFontSubsetStrategy()
```

**Returns:**
PdfFontSubsetStrategy
##### setFontSubsetStrategy(PdfFontSubsetStrategy fontSubsetStrategy)
```
public void setFontSubsetStrategy(PdfFontSubsetStrategy fontSubsetStrategy)
```

Set font subset strategy

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontSubsetStrategy | PdfFontSubsetStrategy |  |

### PdfOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfOptions extends ValueObject implements Serializable
```

Options for conversion to Pdf file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptions() | ctor |
#### Methods

| Method | Description |
| --- | --- |
| getPdfFormat() | Sets the pdf format of the converted document. |
| setPdfFormat(PdfFormats value) | Sets the pdf format of the converted document. |
| getRemovePdfACompliance() | Removes Pdf-A Compliance |
| setRemovePdfACompliance(boolean value) | Removes Pdf-A Compliance |
| getZoom() | Specifies the zoom level in percentage. |
| setZoom(int value) | Specifies the zoom level in percentage. |
| getLinearize() | Linearizes PDF Document for the Web |
| setLinearize(boolean value) | Linearizes PDF Document for the Web |
| getOptimizationOptions() | Pdf optimization options |
| setOptimizationOptions(PdfOptimizationOptions value) | Pdf optimization options |
| getGrayscale() | Convert a PDF from RGB colorspace to grayscale |
| setGrayscale(boolean value) | Convert a PDF from RGB colorspace to grayscale |
| getFormattingOptions() | Pdf formatting options |
| setFormattingOptions(PdfFormattingOptions value) | Pdf formatting options |
| getDocumentInfo() | Meta information of PDF document. |
| setDocumentInfo(PdfDocumentInfo documentInfo) |  |
##### PdfOptions()
```
public PdfOptions()
```

ctor

##### getPdfFormat()
```
public final PdfFormats getPdfFormat()
```

Sets the pdf format of the converted document.

**Returns:**
PdfFormats
##### setPdfFormat(PdfFormats value)
```
public final void setPdfFormat(PdfFormats value)
```

Sets the pdf format of the converted document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfFormats |  |

##### getRemovePdfACompliance()
```
public final boolean getRemovePdfACompliance()
```

Removes Pdf-A Compliance

**Returns:**
boolean
##### setRemovePdfACompliance(boolean value)
```
public final void setRemovePdfACompliance(boolean value)
```

Removes Pdf-A Compliance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLinearize()
```
public final boolean getLinearize()
```

Linearizes PDF Document for the Web

**Returns:**
boolean
##### setLinearize(boolean value)
```
public final void setLinearize(boolean value)
```

Linearizes PDF Document for the Web

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOptimizationOptions()
```
public final PdfOptimizationOptions getOptimizationOptions()
```

Pdf optimization options

**Returns:**
PdfOptimizationOptions
##### setOptimizationOptions(PdfOptimizationOptions value)
```
public final void setOptimizationOptions(PdfOptimizationOptions value)
```

Pdf optimization options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfOptimizationOptions |  |

##### getGrayscale()
```
public final boolean getGrayscale()
```

Convert a PDF from RGB colorspace to grayscale

**Returns:**
boolean
##### setGrayscale(boolean value)
```
public final void setGrayscale(boolean value)
```

Convert a PDF from RGB colorspace to grayscale

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFormattingOptions()
```
public final PdfFormattingOptions getFormattingOptions()
```

Pdf formatting options

**Returns:**
PdfFormattingOptions
##### setFormattingOptions(PdfFormattingOptions value)
```
public final void setFormattingOptions(PdfFormattingOptions value)
```

Pdf formatting options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfFormattingOptions |  |

##### getDocumentInfo()
```
public PdfDocumentInfo getDocumentInfo()
```

Meta information of PDF document.

**Returns:**
PdfDocumentInfo
##### setDocumentInfo(PdfDocumentInfo documentInfo)
```
public void setDocumentInfo(PdfDocumentInfo documentInfo)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | PdfDocumentInfo |  |

### PdfPageLayout
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfpagelayout.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PdfPageLayout extends Enumeration implements Serializable
```

Describes Pdf page layout.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfPageLayout() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Default | Default layout. |
| SinglePage | Single page. |
| OneColumn | Display pages in one column. |
| TwoColumnLeft | Display the pages in two columns, with odd-numbered pages on the left. |
| TwoColumnRight | Display the pages in two columns, with odd-numbered pages on the right. |
| TwoPagesLeft | Display the pages two at a time, with odd-numbered pages on the left. |
| TwoPagesRight | Display the pages two at a time, with odd-numbered pages on the right. |
##### PdfPageLayout()
```
public PdfPageLayout()
```

Serialization constructor

##### Default
```
public static final PdfPageLayout Default
```

Default layout.

##### SinglePage
```
public static final PdfPageLayout SinglePage
```

Single page.

##### OneColumn
```
public static final PdfPageLayout OneColumn
```

Display pages in one column.

##### TwoColumnLeft
```
public static final PdfPageLayout TwoColumnLeft
```

Display the pages in two columns, with odd-numbered pages on the left.

##### TwoColumnRight
```
public static final PdfPageLayout TwoColumnRight
```

Display the pages in two columns, with odd-numbered pages on the right.

##### TwoPagesLeft
```
public static final PdfPageLayout TwoPagesLeft
```

Display the pages two at a time, with odd-numbered pages on the left.

##### TwoPagesRight
```
public static final PdfPageLayout TwoPagesRight
```

Display the pages two at a time, with odd-numbered pages on the right.

### PdfPageMode
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfpagemode.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PdfPageMode extends Enumeration implements Serializable
```

Describes Pdf page mode
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfPageMode() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| UseNone | Don't use any components. |
| UseOutlines | Document outline visible. |
| UseThumbs | Thumbnail images visible. |
| FullScreen | FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible. |
| UseOC | Optional content group panel visible. |
| UseAttachments | Attachments panel visible. |
##### PdfPageMode()
```
public PdfPageMode()
```

Serialization constructor

##### UseNone
```
public static final PdfPageMode UseNone
```

Don't use any components.

##### UseOutlines
```
public static final PdfPageMode UseOutlines
```

Document outline visible.

##### UseThumbs
```
public static final PdfPageMode UseThumbs
```

Thumbnail images visible.

##### FullScreen
```
public static final PdfPageMode FullScreen
```

FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.

##### UseOC
```
public static final PdfPageMode UseOC
```

Optional content group panel visible.

##### UseAttachments
```
public static final PdfPageMode UseAttachments
```

Attachments panel visible.

### PdfRecognitionMode
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/pdfrecognitionmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PdfRecognitionMode extends Enum<PdfRecognitionMode>
```
#### Fields

| Field | Description |
| --- | --- |
| TEXTBOX |  |
| FLOW |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getKey() |  |
| getName() |  |
##### TEXTBOX
```
public static final PdfRecognitionMode TEXTBOX
```

##### FLOW
```
public static final PdfRecognitionMode FLOW
```

##### values()
```
public static PdfRecognitionMode[] values()
```

**Returns:**
com.groupdocs.conversion.options.convert.PdfRecognitionMode[]
##### valueOf(String name)
```
public static PdfRecognitionMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PdfRecognitionMode
##### getKey()
```
public String getKey()
```

**Returns:**
java.lang.String
##### getName()
```
public String getName()
```

**Returns:**
java.lang.String

### PresentationConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/presentationconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public class PresentationConvertOptions extends CommonConvertOptions<PresentationFileType> implements Serializable
```

Describes options for conversion to Presentation file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationConvertOptions() | Initializes new instance of PresentationConvertOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Set this property if you want to protect the converted document with a password. |
| setPassword(String value) | Set this property if you want to protect the converted document with a password. |
| getZoom() | Specifies the zoom level in percentage. |
| setZoom(int value) | Specifies the zoom level in percentage. |
##### PresentationConvertOptions()
```
public PresentationConvertOptions()
```

Initializes new instance of PresentationConvertOptions class.

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProjectManagementConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/projectmanagementconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions
```
public class ProjectManagementConvertOptions extends ConvertOptions<ProjectManagementFileType>
```

Options for conversion to Project management file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementConvertOptions() | Initializes new instance of  class. |
##### ProjectManagementConvertOptions()
```
public ProjectManagementConvertOptions()
```

Initializes new instance of  class.

### PsdColorModes
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/psdcolormodes.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PsdColorModes extends Enumeration implements Serializable
```

Defines Psd color modes enumeration.
#### Constructors

| Constructor | Description |
| --- | --- |
| PsdColorModes() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Bitmap | Bitmap. |
| Grayscale | Grayscale. |
| Indexed | Indexed. |
| Rgb | RGB. |
| Cmyk | CMYK. |
| Multichannel | Multichannel. |
| Duotone | Duotone. |
| Lab | Lab. |
##### PsdColorModes()
```
public PsdColorModes()
```

Serialization constructor

##### Bitmap
```
public static final PsdColorModes Bitmap
```

Bitmap.

##### Grayscale
```
public static final PsdColorModes Grayscale
```

Grayscale.

##### Indexed
```
public static final PsdColorModes Indexed
```

Indexed.

##### Rgb
```
public static final PsdColorModes Rgb
```

RGB.

##### Cmyk
```
public static final PsdColorModes Cmyk
```

CMYK.

##### Multichannel
```
public static final PsdColorModes Multichannel
```

Multichannel.

##### Duotone
```
public static final PsdColorModes Duotone
```

Duotone.

##### Lab
```
public static final PsdColorModes Lab
```

Lab.

### PsdCompressionMethods
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/psdcompressionmethods.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class PsdCompressionMethods extends Enumeration implements Serializable
```

Describes Psd compression methods.
#### Constructors

| Constructor | Description |
| --- | --- |
| PsdCompressionMethods() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Raw | RAW. |
| Rle | RLE. |
| ZipWithoutPrediction | ZipWithoutPrediction. |
| ZipWithPrediction | ZipWithPrediction. |
##### PsdCompressionMethods()
```
public PsdCompressionMethods()
```

Serialization constructor

##### Raw
```
public static final PsdCompressionMethods Raw
```

RAW.

##### Rle
```
public static final PsdCompressionMethods Rle
```

RLE.

##### ZipWithoutPrediction
```
public static final PsdCompressionMethods ZipWithoutPrediction
```

ZipWithoutPrediction.

##### ZipWithPrediction
```
public static final PsdCompressionMethods ZipWithPrediction
```

ZipWithPrediction.

### PsdOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/psdoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PsdOptions extends ValueObject implements Serializable
```

Options for converting to Psd file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PsdOptions() | Initializes new instance of PsdOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getChannelBitsCount() | Bits count per color channel. |
| setChannelBitsCount(short value) | Bits count per color channel. |
| getChannelsCount() | Color channels count. |
| setChannelsCount(short value) | Color channels count. |
| getColorMode() | Psd color mode. |
| setColorMode(PsdColorModes value) | Psd color mode. |
| getCompression() | Psd compression method. |
| setCompression(PsdCompressionMethods value) | Psd compression method. |
| getVersion() | Psd file version. |
| setVersion(int value) | Psd file version. |
##### PsdOptions()
```
public PsdOptions()
```

Initializes new instance of PsdOptions class.

##### getChannelBitsCount()
```
public final short getChannelBitsCount()
```

Bits count per color channel.

**Returns:**
short
##### setChannelBitsCount(short value)
```
public final void setChannelBitsCount(short value)
```

Bits count per color channel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | short |  |

##### getChannelsCount()
```
public final short getChannelsCount()
```

Color channels count.

**Returns:**
short
##### setChannelsCount(short value)
```
public final void setChannelsCount(short value)
```

Color channels count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | short |  |

##### getColorMode()
```
public final PsdColorModes getColorMode()
```

Psd color mode.

**Returns:**
PsdColorModes
##### setColorMode(PsdColorModes value)
```
public final void setColorMode(PsdColorModes value)
```

Psd color mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PsdColorModes |  |

##### getCompression()
```
public final PsdCompressionMethods getCompression()
```

Psd compression method.

**Returns:**
PsdCompressionMethods
##### setCompression(PsdCompressionMethods value)
```
public final void setCompression(PsdCompressionMethods value)
```

Psd compression method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PsdCompressionMethods |  |

##### getVersion()
```
public final int getVersion()
```

Psd file version.

**Returns:**
int
##### setVersion(int value)
```
public final void setVersion(int value)
```

Psd file version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### Rotation
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/rotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class Rotation extends Enumeration implements Serializable
```

Describes page rotation enumeration
#### Constructors

| Constructor | Description |
| --- | --- |
| Rotation() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| None | None. |
| On90 | 90 degrees. |
| On180 | 180 degrees. |
| On270 | 270 degrees. |
##### Rotation()
```
public Rotation()
```

Serialization constructor

##### None
```
public static final Rotation None
```

None.

##### On90
```
public static final Rotation On90
```

90 degrees.

##### On180
```
public static final Rotation On180
```

180 degrees.

##### On270
```
public static final Rotation On270
```

270 degrees.

### RtfOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/rtfoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class RtfOptions extends ValueObject implements Serializable
```

Options for conversion to RTF file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| RtfOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getExportImagesForOldReaders() | Specifies whether the keywords for "old readers" are written to RTF or not. |
| setExportImagesForOldReaders(boolean value) | Specifies whether the keywords for "old readers" are written to RTF or not. |
##### RtfOptions()
```
public RtfOptions()
```

##### getExportImagesForOldReaders()
```
public final boolean getExportImagesForOldReaders()
```

Specifies whether the keywords for "old readers" are written to RTF or not. This can significantly affect the size of the RTF document. Default is False.

**Returns:**
boolean
##### setExportImagesForOldReaders(boolean value)
```
public final void setExportImagesForOldReaders(boolean value)
```

Specifies whether the keywords for "old readers" are written to RTF or not. This can significantly affect the size of the RTF document. Default is False.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### SpreadsheetConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/spreadsheetconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public class SpreadsheetConvertOptions extends CommonConvertOptions<SpreadsheetFileType> implements Serializable
```

Options for conversion to Spreadsheet file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetConvertOptions() | Initializes new instance of SpreadsheetConvertOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Set this property if you want to protect the converted document with a password. |
| setPassword(String value) | Set this property if you want to protect the converted document with a password. |
| getZoom() | Specifies the zoom level in percentage. |
| setZoom(int value) | Specifies the zoom level in percentage. |
##### SpreadsheetConvertOptions()
```
public SpreadsheetConvertOptions()
```

Initializes new instance of SpreadsheetConvertOptions class.

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### TiffCompressionMethods
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/tiffcompressionmethods.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class TiffCompressionMethods extends Enumeration implements Serializable
```

Describes Tiff compression methods enumeration.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffCompressionMethods() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Lzw | LZW compression. |
| None | No compression. |
| Ccitt3 | CCITT3 compression. |
| Ccitt4 | CCITT4 compression. |
| Rle | RLE compression. |
##### TiffCompressionMethods()
```
public TiffCompressionMethods()
```

Serialization constructor

##### Lzw
```
public static final TiffCompressionMethods Lzw
```

LZW compression.

##### None
```
public static final TiffCompressionMethods None
```

No compression.

##### Ccitt3
```
public static final TiffCompressionMethods Ccitt3
```

CCITT3 compression.

##### Ccitt4
```
public static final TiffCompressionMethods Ccitt4
```

CCITT4 compression.

##### Rle
```
public static final TiffCompressionMethods Rle
```

RLE compression.

### TiffOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/tiffoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class TiffOptions extends ValueObject implements Serializable
```

Options for conversion to TIFF file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffOptions() | ctor |
#### Methods

| Method | Description |
| --- | --- |
| getCompression() | Sets Tiff compression. |
| setCompression(TiffCompressionMethods value) | Sets Tiff compression. |
##### TiffOptions()
```
public TiffOptions()
```

ctor

##### getCompression()
```
public final TiffCompressionMethods getCompression()
```

Sets Tiff compression.

**Returns:**
TiffCompressionMethods
##### setCompression(TiffCompressionMethods value)
```
public final void setCompression(TiffCompressionMethods value)
```

Sets Tiff compression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffCompressionMethods |  |

### WatermarkImageOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/watermarkimageoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.WatermarkOptions
```
public class WatermarkImageOptions extends WatermarkOptions
```

Options for settings watermark to the converted document
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkImageOptions(byte[] image) |  |
#### Methods

| Method | Description |
| --- | --- |
| getImage() |  |
##### WatermarkImageOptions(byte[] image)
```
public WatermarkImageOptions(byte[] image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | byte[] |  |

##### getImage()
```
public byte[] getImage()
```

**Returns:**
byte[]

### WatermarkOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/watermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.lang.Cloneable, java.io.Serializable
```
public abstract class WatermarkOptions extends ValueObject implements Cloneable, Serializable
```

Options for settings watermark to the converted document
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkOptions() | Create WatermarkOptions class and set watermark text |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Watermark width |
| setWidth(int value) | Watermark width |
| getHeight() | Watermark height |
| setHeight(int value) | Watermark height |
| getTop() | Watermark top position |
| setTop(int value) | Watermark top position |
| getLeft() | Watermark left position |
| setLeft(int value) | Watermark left position |
| getRotationAngle() | Watermark rotation angle |
| setRotationAngle(int value) | Watermark rotation angle |
| getTransparency() | Watermark transparency. |
| setTransparency(double value) | Watermark transparency. |
| getBackground() | Indicates that the watermark is stamped as background. |
| setBackground(boolean value) | Indicates that the watermark is stamped as background. |
| isAutoAlign() |  |
| setAutoAlign(boolean autoAlign) |  |
| deepClone() | Clone current instance |
##### WatermarkOptions()
```
public WatermarkOptions()
```

Create WatermarkOptions class and set watermark text

##### getWidth()
```
public final int getWidth()
```

Watermark width

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Watermark width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Watermark height

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Watermark height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public final int getTop()
```

Watermark top position

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Watermark top position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLeft()
```
public final int getLeft()
```

Watermark left position

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Watermark left position

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRotationAngle()
```
public final int getRotationAngle()
```

Watermark rotation angle

**Returns:**
int
##### setRotationAngle(int value)
```
public final void setRotationAngle(int value)
```

Watermark rotation angle

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBackground()
```
public final boolean getBackground()
```

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

**Returns:**
boolean
##### setBackground(boolean value)
```
public final void setBackground(boolean value)
```

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### isAutoAlign()
```
public boolean isAutoAlign()
```

**Returns:**
boolean
##### setAutoAlign(boolean autoAlign)
```
public void setAutoAlign(boolean autoAlign)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoAlign | boolean |  |

##### deepClone()
```
public final Object deepClone()
```

Clone current instance

**Returns:**
java.lang.Object - instance

### WatermarkTextOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/watermarktextoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.WatermarkOptions
```
public class WatermarkTextOptions extends WatermarkOptions
```

Options for settings text watermark to the converted document
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkTextOptions(String text) |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Watermark text |
| setText(String value) | Watermark text |
| getWatermarkFont() | Watermark font if text watermark is applied |
| setWatermarkFont(Font watermarkFont) | Sets Watermark font if text watermark is applied |
| getColor() | Watermark font color if text watermark is applied |
| getColorInternal() |  |
| setColor(int argb) | Watermark font color as argb if text watermark is applied |
| setColor(String colorName) | Watermark font color name if text watermark is applied |
| setColor(Color value) | Watermark font color if text watermark is applied |
| getHexColor() |  |
##### WatermarkTextOptions(String text)
```
public WatermarkTextOptions(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

##### getText()
```
public final String getText()
```

Watermark text

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Watermark text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getWatermarkFont()
```
public Font getWatermarkFont()
```

Watermark font if text watermark is applied

**Returns:**
Font - font
##### setWatermarkFont(Font watermarkFont)
```
public void setWatermarkFont(Font watermarkFont)
```

Sets Watermark font if text watermark is applied

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermarkFont | Font | font |

##### getColor()
```
public final Color getColor()
```

Watermark font color if text watermark is applied

**Returns:**
java.awt.Color
##### getColorInternal()
```
public System.Drawing.Color getColorInternal()
```

**Returns:**
com.aspose.ms.System.Drawing.Color
##### setColor(int argb)
```
public final void setColor(int argb)
```

Watermark font color as argb if text watermark is applied

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| argb | int |  |

##### setColor(String colorName)
```
public final void setColor(String colorName)
```

Watermark font color name if text watermark is applied

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| colorName | java.lang.String |  |

##### setColor(Color value)
```
public final void setColor(Color value)
```

Watermark font color if text watermark is applied

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### getHexColor()
```
public String getHexColor()
```

**Returns:**
java.lang.String

### WebConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/webconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
```
public class WebConvertOptions extends CommonConvertOptions<WebFileType>
```

Options for conversion to Web file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| WebConvertOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| isUsePdf() |  |
| setUsePdf(boolean usePdf) |  |
| isFixedLayout() |  |
| setFixedLayout(boolean fixedLayout) |  |
| isFixedLayoutShowBorders() |  |
| setFixedLayoutShowBorders(boolean fixedLayoutShowBorders) |  |
| getZoom() |  |
| setZoom(int zoom) |  |
##### WebConvertOptions()
```
public WebConvertOptions()
```

Initializes new instance of  class.

##### isUsePdf()
```
public boolean isUsePdf()
```

**Returns:**
boolean
##### setUsePdf(boolean usePdf)
```
public void setUsePdf(boolean usePdf)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| usePdf | boolean |  |

##### isFixedLayout()
```
public boolean isFixedLayout()
```

**Returns:**
boolean
##### setFixedLayout(boolean fixedLayout)
```
public void setFixedLayout(boolean fixedLayout)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixedLayout | boolean |  |

##### isFixedLayoutShowBorders()
```
public boolean isFixedLayoutShowBorders()
```

**Returns:**
boolean
##### setFixedLayoutShowBorders(boolean fixedLayoutShowBorders)
```
public void setFixedLayoutShowBorders(boolean fixedLayoutShowBorders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixedLayoutShowBorders | boolean |  |

##### getZoom()
```
public int getZoom()
```

**Returns:**
int
##### setZoom(int zoom)
```
public void setZoom(int zoom)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| zoom | int |  |

### WebpOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/webpoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public final class WebpOptions extends ValueObject implements Serializable
```

Options for conversion to Webp file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| WebpOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getLossless() | Indicates if the compression of the converted file will be lossless. |
| setLossless(boolean value) | Indicates if the compression of the converted file will be lossless. |
| getQuality() | Gets or sets the quality. |
| setQuality(int value) | Gets or sets the quality. |
##### WebpOptions()
```
public WebpOptions()
```

##### getLossless()
```
public final boolean getLossless()
```

Indicates if the compression of the converted file will be lossless.

**Returns:**
boolean
##### setLossless(boolean value)
```
public final void setLossless(boolean value)
```

Indicates if the compression of the converted file will be lossless.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getQuality()
```
public final int getQuality()
```

Gets or sets the quality.

**Returns:**
int
##### setQuality(int value)
```
public final void setQuality(int value)
```

Gets or sets the quality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### WordProcessingConvertOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.convert/wordprocessingconvertoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.convert.IPageMarginConvertOptions, com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions, com.groupdocs.conversion.options.convert.IPdfRecognitionModeOptions
```
public class WordProcessingConvertOptions extends CommonConvertOptions<WordProcessingFileType> implements Serializable, IPageMarginConvertOptions, IPageSizeConvertOptions, IPageOrientationConvertOptions, IPdfRecognitionModeOptions
```

Options for conversion to WordProcessing file type.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingConvertOptions() | Initializes new instance of WordProcessingConvertOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getDpi() | Desired page DPI after conversion. |
| setDpi(int value) | Desired page DPI after conversion. |
| getPassword() | Set this property if you want to protect the converted document with a password. |
| setPassword(String value) | Set this property if you want to protect the converted document with a password. |
| getRtfOptions() | RTF specific convert options |
| setRtfOptions(RtfOptions value) | RTF specific convert options |
| getZoom() | Specifies the zoom level in percentage. |
| setZoom(int value) | Specifies the zoom level in percentage. |
| getMarginTop() | Desired page top margin in pixels after conversion. |
| setMarginTop(int value) | Desired page top margin in pixels after conversion. |
| getMarginBottom() | Desired page bottom margin in pixels after conversion. |
| setMarginBottom(int value) | Desired page bottom margin in pixels after conversion. |
| getMarginLeft() | Desired page left margin in pixels after conversion. |
| setMarginLeft(int value) | Desired page left margin in pixels after conversion. |
| getMarginRight() | Desired page right margin in pixels after conversion. |
| setMarginRight(int value) | Desired page right margin in pixels after conversion. |
| getPageOrientation() |  |
| setPageOrientation(PageOrientation pageOrientation) |  |
| getPageSize() |  |
| setPageSize(PageSize pageSize) |  |
| getPageWidth() |  |
| setPageWidth(float pageWidth) |  |
| getPageHeight() |  |
| setPageHeight(float pageHeight) |  |
| getPdfRecognitionMode() |  |
| setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode) |  |
##### WordProcessingConvertOptions()
```
public WordProcessingConvertOptions()
```

Initializes new instance of WordProcessingConvertOptions class.

##### getDpi()
```
public final int getDpi()
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Returns:**
int
##### setDpi(int value)
```
public final void setDpi(int value)
```

Desired page DPI after conversion. The default resolution is: 96 dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPassword()
```
public final String getPassword()
```

Set this property if you want to protect the converted document with a password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set this property if you want to protect the converted document with a password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRtfOptions()
```
public final RtfOptions getRtfOptions()
```

RTF specific convert options

**Returns:**
RtfOptions
##### setRtfOptions(RtfOptions value)
```
public final void setRtfOptions(RtfOptions value)
```

RTF specific convert options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | RtfOptions |  |

##### getZoom()
```
public final int getZoom()
```

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Returns:**
int
##### setZoom(int value)
```
public final void setZoom(int value)
```

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginTop()
```
public final int getMarginTop()
```

Desired page top margin in pixels after conversion.

**Returns:**
int
##### setMarginTop(int value)
```
public final void setMarginTop(int value)
```

Desired page top margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginBottom()
```
public final int getMarginBottom()
```

Desired page bottom margin in pixels after conversion.

**Returns:**
int
##### setMarginBottom(int value)
```
public final void setMarginBottom(int value)
```

Desired page bottom margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginLeft()
```
public final int getMarginLeft()
```

Desired page left margin in pixels after conversion.

**Returns:**
int
##### setMarginLeft(int value)
```
public final void setMarginLeft(int value)
```

Desired page left margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMarginRight()
```
public final int getMarginRight()
```

Desired page right margin in pixels after conversion.

**Returns:**
int
##### setMarginRight(int value)
```
public final void setMarginRight(int value)
```

Desired page right margin in pixels after conversion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageOrientation()
```
public PageOrientation getPageOrientation()
```

Gets page orientation after conversion

**Returns:**
PageOrientation
##### setPageOrientation(PageOrientation pageOrientation)
```
public void setPageOrientation(PageOrientation pageOrientation)
```

Sets desired page orientation after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageOrientation | PageOrientation |  |

##### getPageSize()
```
public PageSize getPageSize()
```

Gets desired page size after conversion

**Returns:**
PageSize
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Set desired page size after conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize |  |

##### getPageWidth()
```
public float getPageWidth()
```

Specified page width in points if  is set to PageSize.Custom

**Returns:**
float
##### setPageWidth(float pageWidth)
```
public void setPageWidth(float pageWidth)
```

Set desired page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | float |  |

##### getPageHeight()
```
public float getPageHeight()
```

Specified page height in points if  is set to PageSize.Custom

**Returns:**
float
##### setPageHeight(float pageHeight)
```
public void setPageHeight(float pageHeight)
```

Set desired page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageHeight | float |  |

##### getPdfRecognitionMode()
```
public PdfRecognitionMode getPdfRecognitionMode()
```

Gets recognition mode when converting from pdf

**Returns:**
PdfRecognitionMode
##### setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)
```
public void setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)
```

Sets recognition mode when converting from pdf

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfRecognitionMode | PdfRecognitionMode |  |

### com.groupdocs.conversion.options.load
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load.md

The GroupDocs.Conversion.Options.Load namespace provides classes to specify additional options for document loading process.

#### Classes

| Class | Description |
| --- | --- |
| AudioLoadOptions |  |
| CadDrawTypeMode | Represents possible modes for colorization of objects. |
| CadLoadOptions | Options for loading CAD documents. |
| CompressionLoadOptions | Options for loading compression documents. |
| CsvLoadOptions | Options for loading Csv documents. |
| DatabaseLoadOptions | Options for loading database documents. |
| DiagramLoadOptions | Options for loading Diagram documents. |
| EBookLoadOptions | Options for loading EBook documents. |
| EmailField | Describes email fields enumeration |
| EmailLoadOptions | Options for loading Email documents. |
| EmptyLoadOptions | Base class for load options |
| EpubLoadOptions | Options for loading Epub documents. |
| FontLoadOptions | Options for loading Font documents. |
| ImageLoadOptions | Options for loading Image documents. |
| ImageRecognitionLanguage | Image Recognition Language |
| LoadOptions | Abstract document load options class. |
| MboxLoadOptions | Options for loading Mbox documents. |
| NoteLoadOptions | Options for loading One documents. |
| NsfLoadOptions | Options for loading Nsf documents. |
| OlmLoadOptions | Options for loading Olm documents. |
| PageDescriptionLanguageLoadOptions | Options for loading page description language documents. |
| PdfLoadOptions | Options for loading Pdf documents. |
| PersonalStorageLoadOptions | Options for loading personal storage documents. |
| PresentationLoadOptions | Options for loading Presentation documents. |
| PublisherLoadOptions | Options for loading Publisher documents. |
| SpreadsheetLoadOptions | Options for loading Spreadsheet documents. |
| TsvLoadOptions | Options for loading Tsv documents. |
| TxtLeadingSpacesOptions | Describes txt leading spaces options enumeration. |
| TxtLoadOptions | Options for loading Txt documents. |
| TxtTrailingSpacesOptions | Describes txt trailing spaces options enumeration. |
| VcfLoadOptions | Options for loading Vcf documents. |
| VideoLoadOptions | Options for loading video documents. |
| WebLoadOptions | Options for loading web documents. |
| WordProcessingBookmarksOptions | Options for handling bookmarks in WordProcessing |
| WordProcessingLoadOptions | Options for loading WordProcessing documents. |
| XmlLoadOptions | Options for loading XML documents. |

### AudioLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/audioloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class AudioLoadOptions extends LoadOptions
```
#### Constructors

| Constructor | Description |
| --- | --- |
| AudioLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAudioConnector() |  |
| setAudioConnector(IAudioConnector audioConnector) | Sets audio connector |
##### AudioLoadOptions()
```
public AudioLoadOptions()
```

Initializes new instance of  class.

##### getAudioConnector()
```
public IAudioConnector getAudioConnector()
```

**Returns:**
IAudioConnector
##### setAudioConnector(IAudioConnector audioConnector)
```
public void setAudioConnector(IAudioConnector audioConnector)
```

Sets audio connector

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| audioConnector | IAudioConnector | Audio connector |

### CadDrawTypeMode
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/caddrawtypemode.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration
```
public class CadDrawTypeMode extends Enumeration
```

Represents possible modes for colorization of objects.
#### Constructors

| Constructor | Description |
| --- | --- |
| CadDrawTypeMode() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| UseDrawColor | Allows to use common color. |
| UseObjectColor | Allows to use separate color for every object. |
##### CadDrawTypeMode()
```
public CadDrawTypeMode()
```

Serialization constructor

##### UseDrawColor
```
public static final CadDrawTypeMode UseDrawColor
```

Allows to use common color.

##### UseObjectColor
```
public static final CadDrawTypeMode UseObjectColor
```

Allows to use separate color for every object.

### CadLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/cadloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class CadLoadOptions extends LoadOptions implements Serializable
```

Options for loading CAD documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| CadLoadOptions() | Initializes new instance of CadLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getWidth() | Sets desired page width for converting CAD document |
| setWidth(int value) | Sets desired page width for converting CAD document |
| getHeight() | Sets desired page height for converting CAD document |
| setHeight(int value) | Sets desired page height for converting CAD document |
| getLayoutNames() | Specifies which CAD layouts to be converted |
| setLayoutNames(String[] value) | Specififies which CAD layouts to be converted |
| getDrawType() | Gets type of drawing. |
| setDrawType(CadDrawTypeMode drawType) | Sets type of drawing. |
| getBackgroundColor() | Gets a background color. |
| setBackgroundColor(System.Drawing.Color backgroundColor) | Sets a background color. |
| getFontDirectories() |  |
| setFontDirectories(List<String> fontDirectories) |  |
##### CadLoadOptions()
```
public CadLoadOptions()
```

Initializes new instance of CadLoadOptions class.

##### getFormat()
```
public CadFileType getFormat()
```

Input document file type

**Returns:**
CadFileType
##### getWidth()
```
public final int getWidth()
```

Sets desired page width for converting CAD document

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets desired page width for converting CAD document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Sets desired page height for converting CAD document

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets desired page height for converting CAD document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLayoutNames()
```
public final String[] getLayoutNames()
```

Specifies which CAD layouts to be converted

**Returns:**
java.lang.String[]
##### setLayoutNames(String[] value)
```
public final void setLayoutNames(String[] value)
```

Specififies which CAD layouts to be converted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] |  |

##### getDrawType()
```
public CadDrawTypeMode getDrawType()
```

Gets type of drawing.

**Returns:**
CadDrawTypeMode
##### setDrawType(CadDrawTypeMode drawType)
```
public void setDrawType(CadDrawTypeMode drawType)
```

Sets type of drawing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| drawType | CadDrawTypeMode |  |

##### getBackgroundColor()
```
public System.Drawing.Color getBackgroundColor()
```

Gets a background color.

**Returns:**
com.aspose.ms.System.Drawing.Color
##### setBackgroundColor(System.Drawing.Color backgroundColor)
```
public void setBackgroundColor(System.Drawing.Color backgroundColor)
```

Sets a background color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | com.aspose.ms.System.Drawing.Color |  |

##### getFontDirectories()
```
public List<String> getFontDirectories()
```

**Returns:**
java.util.List<java.lang.String>
##### setFontDirectories(List<String> fontDirectories)
```
public void setFontDirectories(List<String> fontDirectories)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontDirectories | java.util.List<java.lang.String> |  |

### CompressionLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/compressionloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class CompressionLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading compression documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| CompressionLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| isConvertOwner() | The owner will not be converted |
| isConvertOwned() |  |
| getDepth() |  |
| setDepth(int depth) |  |
| getPassword() |  |
| setPassword(String password) | Set password to load protected document. |
| getEqualityComponents() |  |
##### CompressionLoadOptions()
```
public CompressionLoadOptions()
```

Initializes new instance of  class.

##### isConvertOwner()
```
public boolean isConvertOwner()
```

The owner will not be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

##### getPassword()
```
public String getPassword()
```

**Returns:**
java.lang.String
##### setPassword(String password)
```
public void setPassword(String password)
```

Set password to load protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | password |

##### getEqualityComponents()
```
public List<Object> getEqualityComponents()
```

**Returns:**
java.util.List<java.lang.Object>

### CsvLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/csvloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions, com.groupdocs.conversion.options.load.SpreadsheetLoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class CsvLoadOptions extends SpreadsheetLoadOptions implements Serializable
```

Options for loading Csv documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| CsvLoadOptions() | Initializes new instance of CsvLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getSeparator() | Delimiter of a Csv file. |
| setSeparator(String value) | Delimiter of a Csv file. |
| setSeparator(char value) | Delimiter of a Csv file. |
| isMultiEncoded() | True means the file contains several encodings. |
| setMultiEncoded(boolean value) | True means the file contains several encodings. |
| hasFormula() | Indicates whether text is formula if it starts with "=". |
| setFormula(boolean value) | Indicates whether text is formula if it starts with "=". |
| getConvertNumericData() | Indicates whether the string in the file is converted to numeric. |
| setConvertNumericData(boolean value) | Indicates whether the string in the file is converted to numeric. |
| getConvertDateTimeData() | Indicates whether the string in the file is converted to date. |
| setConvertDateTimeData(boolean value) | Indicates whether the string in the file is converted to date. |
| getEncoding() | Encoding. |
| getEncodingInternal() |  |
| setEncoding(Charset value) | Encoding. |
| setEncoding(String charsetName) | Gets or sets the encoding that will be used when loading Txt document. |
| setEncodingInternal(System.Text.Encoding value) |  |
##### CsvLoadOptions()
```
public CsvLoadOptions()
```

Initializes new instance of CsvLoadOptions class.

##### getSeparator()
```
public final char getSeparator()
```

Delimiter of a Csv file.

**Returns:**
char
##### setSeparator(String value)
```
public final void setSeparator(String value)
```

Delimiter of a Csv file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### setSeparator(char value)
```
public final void setSeparator(char value)
```

Delimiter of a Csv file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char |  |

##### isMultiEncoded()
```
public final boolean isMultiEncoded()
```

True means the file contains several encodings.

**Returns:**
boolean
##### setMultiEncoded(boolean value)
```
public final void setMultiEncoded(boolean value)
```

True means the file contains several encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### hasFormula()
```
public final boolean hasFormula()
```

Indicates whether text is formula if it starts with "=".

**Returns:**
boolean
##### setFormula(boolean value)
```
public final void setFormula(boolean value)
```

Indicates whether text is formula if it starts with "=".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertNumericData()
```
public final boolean getConvertNumericData()
```

Indicates whether the string in the file is converted to numeric. Default is True.

**Returns:**
boolean
##### setConvertNumericData(boolean value)
```
public final void setConvertNumericData(boolean value)
```

Indicates whether the string in the file is converted to numeric. Default is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertDateTimeData()
```
public final boolean getConvertDateTimeData()
```

Indicates whether the string in the file is converted to date. Default is True.

**Returns:**
boolean
##### setConvertDateTimeData(boolean value)
```
public final void setConvertDateTimeData(boolean value)
```

Indicates whether the string in the file is converted to date. Default is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEncoding()
```
public final Charset getEncoding()
```

Encoding. Default is Encoding.Default.

**Returns:**
java.nio.charset.Charset
##### getEncodingInternal()
```
public System.Text.Encoding getEncodingInternal()
```

**Returns:**
com.aspose.ms.System.Text.Encoding
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Encoding. Default is Encoding.Default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### setEncoding(String charsetName)
```
public final void setEncoding(String charsetName)
```

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| charsetName | java.lang.String |  |

##### setEncodingInternal(System.Text.Encoding value)
```
public void setEncodingInternal(System.Text.Encoding value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.Text.Encoding |  |

### DatabaseLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/databaseloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class DatabaseLoadOptions extends LoadOptions
```

Options for loading database documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| DatabaseLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type. |
| setFormat(DatabaseFileType format) | Sets Input document file type. |
##### DatabaseLoadOptions()
```
public DatabaseLoadOptions()
```

Initializes new instance of  class.

##### getFormat()
```
public DatabaseFileType getFormat()
```

Gets Input document file type.

**Returns:**
DatabaseFileType
##### setFormat(DatabaseFileType format)
```
public void setFormat(DatabaseFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | DatabaseFileType |  |

### DiagramLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/diagramloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class DiagramLoadOptions extends LoadOptions implements Serializable
```

Options for loading Diagram documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramLoadOptions() | Initializes new instance of DiagramLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Diagram document. |
| setDefaultFont(String value) | Default font for Diagram document. |
##### DiagramLoadOptions()
```
public DiagramLoadOptions()
```

Initializes new instance of DiagramLoadOptions class.

##### getFormat()
```
public final DiagramFileType getFormat()
```

Input document file type

**Returns:**
DiagramFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Diagram document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Diagram document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### EBookLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/ebookloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class EBookLoadOptions extends LoadOptions
```

Options for loading EBook documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| EBookLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type. |
| setFormat(EBookFileType format) | Sets Input document file type. |
##### EBookLoadOptions()
```
public EBookLoadOptions()
```

Initializes new instance of  class.

##### getFormat()
```
public EBookFileType getFormat()
```

Gets Input document file type.

**Returns:**
EBookFileType
##### setFormat(EBookFileType format)
```
public void setFormat(EBookFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | EBookFileType |  |

### EmailField
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/emailfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class EmailField extends Enumeration implements Serializable
```

Describes email fields enumeration
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailField() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Start | Default field text is "Start". |
| Attachments | Default field text is "Attachments". |
| Cc | Default field text is "Cc". |
| Bcc | Default field text is "Bcc". |
| End | Default field text is "End". |
| From | Default field text is "From". |
| Importance | Default field text is "Importance". |
| Location | Default field text is "Location". |
| Organizer | Default field text is "Organizer". |
| PageHeader | Default field text is "PageHeader". |
| Recurrence | Default field text is "Recurrence". |
| RecurrencePattern | Default field text is "RecurrencePattern". |
| RequiredAttendees | Default field text is "RequiredAttendees". |
| Sent | Default field text is "Sent". |
| ShowTimeAs | Default field text is "ShowTimeAs". |
| Subject | Default field text is "Subject". |
| TabField | Default field text is "TabField". |
| To | Default field text is "To". |
##### EmailField()
```
public EmailField()
```

Serialization constructor

##### Start
```
public static final EmailField Start
```

Default field text is "Start".

##### Attachments
```
public static final EmailField Attachments
```

Default field text is "Attachments".

##### Cc
```
public static final EmailField Cc
```

Default field text is "Cc".

##### Bcc
```
public static final EmailField Bcc
```

Default field text is "Bcc".

##### End
```
public static final EmailField End
```

Default field text is "End".

##### From
```
public static final EmailField From
```

Default field text is "From".

##### Importance
```
public static final EmailField Importance
```

Default field text is "Importance".

##### Location
```
public static final EmailField Location
```

Default field text is "Location".

##### Organizer
```
public static final EmailField Organizer
```

Default field text is "Organizer".

##### PageHeader
```
public static final EmailField PageHeader
```

Default field text is "PageHeader".

##### Recurrence
```
public static final EmailField Recurrence
```

Default field text is "Recurrence".

##### RecurrencePattern
```
public static final EmailField RecurrencePattern
```

Default field text is "RecurrencePattern".

##### RequiredAttendees
```
public static final EmailField RequiredAttendees
```

Default field text is "RequiredAttendees".

##### Sent
```
public static final EmailField Sent
```

Default field text is "Sent".

##### ShowTimeAs
```
public static final EmailField ShowTimeAs
```

Default field text is "ShowTimeAs".

##### Subject
```
public static final EmailField Subject
```

Default field text is "Subject".

##### TabField
```
public static final EmailField TabField
```

Default field text is "TabField".

##### To
```
public static final EmailField To
```

Default field text is "To".

### EmailLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/emailloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, java.lang.Cloneable, java.io.Serializable
```
public final class EmailLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions, Cloneable, Serializable
```

Options for loading Email documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailLoadOptions() | Initializes new instance of EmailLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDisplayHeader() | Option to display or hide the email header. |
| setDisplayHeader(boolean value) | Option to display or hide the email header. |
| getDisplayFromEmailAddress() | Option to display or hide "from" email address. |
| setDisplayFromEmailAddress(boolean value) | Option to display or hide "from" email address. |
| getDisplayEmailAddress() | Option to display or hide email address. |
| setDisplayEmailAddress(boolean value) | Option to display or hide email address. |
| getDisplayToEmailAddress() | Option to display or hide "to" email address. |
| setDisplayToEmailAddress(boolean value) | Option to display or hide "to" email address. |
| getDisplayCcEmailAddress() | Option to display or hide "Cc" email address. |
| setDisplayCcEmailAddress(boolean value) | Option to display or hide "Cc" email address. |
| getDisplayBccEmailAddress() | Option to display or hide "Bcc" email address. |
| setDisplayBccEmailAddress(boolean value) | Option to display or hide "Bcc" email address. |
| getTimeZoneOffset() | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. |
| getTimeZoneOffsetInternal() |  |
| getResourceLoadingTimeout() | Timeout for loading external resources |
| setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout) | Timeout for loading external resources (setter) |
| setTimeZoneOffset(Double value) | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. |
| deepClone() | Clones current instance. |
| getFieldTextMap() | Gets the mapping between email message  and field text representation |
| setFieldTextMap(Map<EmailField,String> fieldTextMap) | Sets the mapping between email message  and field text representation |
| isPreserveOriginalDate() | Defines whether need to keep original date header string in mail message when saving or not (Default value is true) |
| setPreserveOriginalDate(boolean preserveOriginalDate) | Defines whether need to keep original date header string in mail message when saving or not |
| isConvertOwner() |  |
| setConvertOwner(boolean convertOwner) |  |
| isConvertOwned() |  |
| setConvertOwned(boolean convertOwned) |  |
| getDepth() |  |
| setDepth(int depth) |  |
##### EmailLoadOptions()
```
public EmailLoadOptions()
```

Initializes new instance of EmailLoadOptions class.

##### getFormat()
```
public final EmailFileType getFormat()
```

Input document file type

**Returns:**
EmailFileType
##### getDisplayHeader()
```
public final boolean getDisplayHeader()
```

Option to display or hide the email header. Default: true.

**Returns:**
boolean
##### setDisplayHeader(boolean value)
```
public final void setDisplayHeader(boolean value)
```

Option to display or hide the email header. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayFromEmailAddress()
```
public final boolean getDisplayFromEmailAddress()
```

Option to display or hide "from" email address. Default: true.

**Returns:**
boolean
##### setDisplayFromEmailAddress(boolean value)
```
public final void setDisplayFromEmailAddress(boolean value)
```

Option to display or hide "from" email address. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayEmailAddress()
```
public final boolean getDisplayEmailAddress()
```

Option to display or hide email address. Default: true.

**Returns:**
boolean
##### setDisplayEmailAddress(boolean value)
```
public final void setDisplayEmailAddress(boolean value)
```

Option to display or hide email address. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayToEmailAddress()
```
public final boolean getDisplayToEmailAddress()
```

Option to display or hide "to" email address. Default: true.

**Returns:**
boolean
##### setDisplayToEmailAddress(boolean value)
```
public final void setDisplayToEmailAddress(boolean value)
```

Option to display or hide "to" email address. Default: true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayCcEmailAddress()
```
public final boolean getDisplayCcEmailAddress()
```

Option to display or hide "Cc" email address. Default: false.

**Returns:**
boolean
##### setDisplayCcEmailAddress(boolean value)
```
public final void setDisplayCcEmailAddress(boolean value)
```

Option to display or hide "Cc" email address. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDisplayBccEmailAddress()
```
public final boolean getDisplayBccEmailAddress()
```

Option to display or hide "Bcc" email address. Default: false.

**Returns:**
boolean
##### setDisplayBccEmailAddress(boolean value)
```
public final void setDisplayBccEmailAddress(boolean value)
```

Option to display or hide "Bcc" email address. Default: false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTimeZoneOffset()
```
public final Double getTimeZoneOffset()
```

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.

**Returns:**
java.lang.Double
##### getTimeZoneOffsetInternal()
```
public System.TimeSpan getTimeZoneOffsetInternal()
```

**Returns:**
com.aspose.ms.System.TimeSpan
##### getResourceLoadingTimeout()
```
public System.TimeSpan getResourceLoadingTimeout()
```

Timeout for loading external resources

**Returns:**
com.aspose.ms.System.TimeSpan
##### setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
```
public void setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
```

Timeout for loading external resources (setter)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resourceLoadingTimeout | com.aspose.ms.System.TimeSpan |  |

##### setTimeZoneOffset(Double value)
```
public final void setTimeZoneOffset(Double value)
```

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double |  |

##### deepClone()
```
public final Object deepClone()
```

Clones current instance.

**Returns:**
java.lang.Object -
##### getFieldTextMap()
```
public Map<EmailField,String> getFieldTextMap()
```

Gets the mapping between email message  and field text representation

**Returns:**
java.util.Map<com.groupdocs.conversion.options.load.EmailField,java.lang.String> - mapping
##### setFieldTextMap(Map<EmailField,String> fieldTextMap)
```
public void setFieldTextMap(Map<EmailField,String> fieldTextMap)
```

Sets the mapping between email message  and field text representation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldTextMap | java.util.Map<com.groupdocs.conversion.options.load.EmailField,java.lang.String> | mapping |

##### isPreserveOriginalDate()
```
public boolean isPreserveOriginalDate()
```

Defines whether need to keep original date header string in mail message when saving or not (Default value is true)

**Returns:**
boolean - preserve original date if true
##### setPreserveOriginalDate(boolean preserveOriginalDate)
```
public void setPreserveOriginalDate(boolean preserveOriginalDate)
```

Defines whether need to keep original date header string in mail message when saving or not

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preserveOriginalDate | boolean | preserve original date |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### setConvertOwner(boolean convertOwner)
```
public void setConvertOwner(boolean convertOwner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwner | boolean |  |

##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### setConvertOwned(boolean convertOwned)
```
public void setConvertOwned(boolean convertOwned)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertOwned | boolean |  |

##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### EmptyLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/emptyloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EmptyLoadOptions extends LoadOptions implements Serializable
```

Base class for load options
#### Constructors

| Constructor | Description |
| --- | --- |
| EmptyLoadOptions() |  |
##### EmptyLoadOptions()
```
public EmptyLoadOptions()
```

### EpubLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/epubloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class EpubLoadOptions extends LoadOptions implements Serializable
```

Options for loading Epub documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| EpubLoadOptions() | Initializes new instance of EpubLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
##### EpubLoadOptions()
```
public EpubLoadOptions()
```

Initializes new instance of EpubLoadOptions class.

##### getFormat()
```
public final EBookFileType getFormat()
```

Input document file type

**Returns:**
EBookFileType

### FontLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/fontloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class FontLoadOptions extends LoadOptions
```

Options for loading Font documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type. |
| setFormat(FontFileType format) | Sets Input document file type. |
##### FontLoadOptions()
```
public FontLoadOptions()
```

Initializes new instance of  class.

##### getFormat()
```
public FontFileType getFormat()
```

Gets Input document file type.

**Returns:**
FontFileType
##### setFormat(FontFileType format)
```
public void setFormat(FontFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | FontFileType |  |

### ImageLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/imageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class ImageLoadOptions extends LoadOptions implements Serializable
```

Options for loading Image documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageLoadOptions() | Initializes new instance of ImageLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Psd, Emf, Wmf document types. |
| setDefaultFont(String value) | Default font for Psd, Emf, Wmf document types. |
| isRecognitionEnabled() |  |
| getOcrConnector() |  |
| setOcrConnector(IOcrConnector ocrConnector) | Set image OCR connector |
| getResetFontFolders() | Reset font folders before loading document |
| setResetFontFolders(boolean resetFontFolders) |  |
##### ImageLoadOptions()
```
public ImageLoadOptions()
```

Initializes new instance of ImageLoadOptions class.

##### getFormat()
```
public final ImageFileType getFormat()
```

Input document file type

**Returns:**
ImageFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### isRecognitionEnabled()
```
public boolean isRecognitionEnabled()
```

**Returns:**
boolean
##### getOcrConnector()
```
public IOcrConnector getOcrConnector()
```

**Returns:**
IOcrConnector
##### setOcrConnector(IOcrConnector ocrConnector)
```
public void setOcrConnector(IOcrConnector ocrConnector)
```

Set image OCR connector

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | OCR connector instance |

##### getResetFontFolders()
```
public boolean getResetFontFolders()
```

Reset font folders before loading document

**Returns:**
boolean
##### setResetFontFolders(boolean resetFontFolders)
```
public void setResetFontFolders(boolean resetFontFolders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resetFontFolders | boolean |  |

### ImageRecognitionLanguage
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/imagerecognitionlanguage.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration
```
public class ImageRecognitionLanguage extends Enumeration
```

Image Recognition Language
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageRecognitionLanguage() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| None | Default language is None. |
| Eng | English alphabet |
| Deu | German alphabet |
| Por | Portuguese alphabet |
| Spa | Spanish alphabet |
| Fra | French alphabet |
| Ita | Italian alphabet |
| Cze | Czech alphabet |
| Dan | Danish alphabet |
| Dum | Dutch alphabet |
| Est | Estonian alphabet |
| Fin | Finnish alphabet |
| Lav | Latvian alphabet |
| Lit | Lithuanian alphabet |
| Nor | Norwegian alphabet |
| Pol | Polish alphabet |
| Rum | Romanian alphabet |
| SrpHrv | Serbo-Croatian alphabet |
| Slk | Slovak alphabet |
| Slv | Slovene alphabet |
| Swe | Swedish alphabet |
| Chi | Chinese alphabet |
##### ImageRecognitionLanguage()
```
public ImageRecognitionLanguage()
```

Serialization constructor

##### None
```
public static final ImageRecognitionLanguage None
```

Default language is None.

##### Eng
```
public static final ImageRecognitionLanguage Eng
```

English alphabet

##### Deu
```
public static final ImageRecognitionLanguage Deu
```

German alphabet

##### Por
```
public static final ImageRecognitionLanguage Por
```

Portuguese alphabet

##### Spa
```
public static final ImageRecognitionLanguage Spa
```

Spanish alphabet

##### Fra
```
public static final ImageRecognitionLanguage Fra
```

French alphabet

##### Ita
```
public static final ImageRecognitionLanguage Ita
```

Italian alphabet

##### Cze
```
public static final ImageRecognitionLanguage Cze
```

Czech alphabet

##### Dan
```
public static final ImageRecognitionLanguage Dan
```

Danish alphabet

##### Dum
```
public static final ImageRecognitionLanguage Dum
```

Dutch alphabet

##### Est
```
public static final ImageRecognitionLanguage Est
```

Estonian alphabet

##### Fin
```
public static final ImageRecognitionLanguage Fin
```

Finnish alphabet

##### Lav
```
public static final ImageRecognitionLanguage Lav
```

Latvian alphabet

##### Lit
```
public static final ImageRecognitionLanguage Lit
```

Lithuanian alphabet

##### Nor
```
public static final ImageRecognitionLanguage Nor
```

Norwegian alphabet

##### Pol
```
public static final ImageRecognitionLanguage Pol
```

Polish alphabet

##### Rum
```
public static final ImageRecognitionLanguage Rum
```

Romanian alphabet

##### SrpHrv
```
public static final ImageRecognitionLanguage SrpHrv
```

Serbo-Croatian alphabet

##### Slk
```
public static final ImageRecognitionLanguage Slk
```

Slovak alphabet

##### Slv
```
public static final ImageRecognitionLanguage Slv
```

Slovene alphabet

##### Swe
```
public static final ImageRecognitionLanguage Swe
```

Swedish alphabet

##### Chi
```
public static final ImageRecognitionLanguage Chi
```

Chinese alphabet

### LoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/loadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public abstract class LoadOptions extends ValueObject implements Serializable
```

Abstract document load options class.
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Input document file type |
| setFormat(FileType value) | Input document file type |
##### LoadOptions()
```
public LoadOptions()
```

##### getFormat()
```
public FileType getFormat()
```

Input document file type

**Returns:**
FileType
##### setFormat(FileType value)
```
public void setFormat(FileType value)
```

Input document file type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### MboxLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/mboxloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class MboxLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading Mbox documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| MboxLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| isConvertOwner() | The owner will not be converted |
| isConvertOwned() | \{@inheritDoc\} |
| getDepth() | \{@inheritDoc\} Default: 3 |
| setDepth(int depth) | \{@inheritDoc\} |
| getEqualityComponents() | \{@inheritDoc\} |
##### MboxLoadOptions()
```
public MboxLoadOptions()
```

Initializes new instance of  class.

##### isConvertOwner()
```
public boolean isConvertOwner()
```

The owner will not be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion Default: 3

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

##### getEqualityComponents()
```
public List<Object> getEqualityComponents()
```

**Returns:**
java.util.List<java.lang.Object>

### NoteLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/noteloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class NoteLoadOptions extends LoadOptions implements Serializable
```

Options for loading One documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| NoteLoadOptions() | Initializes new instance of NoteLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Note document. |
| setDefaultFont(String value) | Default font for Note document. |
| getFontSubstitutes() | Substitute specific fonts when converting Note document. |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Note document. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
##### NoteLoadOptions()
```
public NoteLoadOptions()
```

Initializes new instance of NoteLoadOptions class.

##### getFormat()
```
public final NoteFileType getFormat()
```

Input document file type

**Returns:**
NoteFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Note document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Note document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Note document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Note document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### NsfLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/nsfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class NsfLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading Nsf documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| NsfLoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| isConvertOwner() |  |
| isConvertOwned() | \{@inheritDoc\} |
| getDepth() |  |
| setDepth(int depth) |  |
##### NsfLoadOptions()
```
public NsfLoadOptions()
```

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### OlmLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/olmloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, java.lang.Cloneable, java.io.Serializable
```
public final class OlmLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions, Cloneable, Serializable
```

Options for loading Olm documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| OlmLoadOptions() | Initializes new instance of OlmLoadOptions class. |
#### Fields

| Field | Description |
| --- | --- |
| folder |  |
#### Methods

| Method | Description |
| --- | --- |
| memberwiseClone() |  |
| isConvertOwner() | The owner will not be converted |
| isConvertOwned() | \{@inheritDoc\} |
| getFolder() | Folder which to be processed Default is Inbox |
| setFolder(String folder) |  |
| getDepth() | \{@inheritDoc\} Default: 3 |
| setDepth(int depth) |  |
| deepClone() | Clones current instance. |
##### OlmLoadOptions()
```
public OlmLoadOptions()
```

Initializes new instance of OlmLoadOptions class.

##### folder
```
public String folder
```

##### memberwiseClone()
```
public Object memberwiseClone()
```

**Returns:**
java.lang.Object
##### isConvertOwner()
```
public boolean isConvertOwner()
```

The owner will not be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getFolder()
```
public String getFolder()
```

Folder which to be processed Default is Inbox

**Returns:**
java.lang.String
##### setFolder(String folder)
```
public void setFolder(String folder)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folder | java.lang.String |  |

##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion Default: 3

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

##### deepClone()
```
public Object deepClone()
```

Clones current instance.

**Returns:**
java.lang.Object

### PageDescriptionLanguageLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class PageDescriptionLanguageLoadOptions extends LoadOptions
```

Options for loading page description language documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageDescriptionLanguageLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type. |
| setFormat(PageDescriptionLanguageFileType format) | Sets Input document file type. |
##### PageDescriptionLanguageLoadOptions()
```
public PageDescriptionLanguageLoadOptions()
```

Initializes new instance of  class.

##### getFormat()
```
public PageDescriptionLanguageFileType getFormat()
```

Gets Input document file type.

**Returns:**
PageDescriptionLanguageFileType
##### setFormat(PageDescriptionLanguageFileType format)
```
public void setFormat(PageDescriptionLanguageFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | PageDescriptionLanguageFileType |  |

### PdfLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/pdfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class PdfLoadOptions extends LoadOptions implements Serializable
```

Options for loading Pdf documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfLoadOptions() | Initializes new instance of PdfLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getRemoveEmbeddedFiles() | Remove embedded files. |
| setRemoveEmbeddedFiles(boolean value) | Remove embedded files. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
| getDefaultFont() | Default font for Pdf document. |
| setDefaultFont(String value) | Default font for Pdf document. |
| getFontSubstitutes() | Substitute specific fonts when converting Pdf document. |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Pdf document. |
| getHidePdfAnnotations() | Hide annotations in Pdf documents. |
| setHidePdfAnnotations(boolean value) | Hide annotations in Pdf documents. |
| getFlattenAllFields() | Flatten all the fields of the PDF form. |
| setFlattenAllFields(boolean value) | Flatten all the fields of the PDF form. |
| getResetFontFolders() | Reset font folders before loading document |
| setResetFontFolders(boolean resetFontFolders) |  |
##### PdfLoadOptions()
```
public PdfLoadOptions()
```

Initializes new instance of PdfLoadOptions class.

##### getFormat()
```
public final PdfFileType getFormat()
```

Input document file type

**Returns:**
PdfFileType
##### getRemoveEmbeddedFiles()
```
public final boolean getRemoveEmbeddedFiles()
```

Remove embedded files.

**Returns:**
boolean
##### setRemoveEmbeddedFiles(boolean value)
```
public final void setRemoveEmbeddedFiles(boolean value)
```

Remove embedded files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Pdf document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Pdf document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Pdf document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Pdf document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getHidePdfAnnotations()
```
public final boolean getHidePdfAnnotations()
```

Hide annotations in Pdf documents.

**Returns:**
boolean
##### setHidePdfAnnotations(boolean value)
```
public final void setHidePdfAnnotations(boolean value)
```

Hide annotations in Pdf documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFlattenAllFields()
```
public final boolean getFlattenAllFields()
```

Flatten all the fields of the PDF form.

**Returns:**
boolean
##### setFlattenAllFields(boolean value)
```
public final void setFlattenAllFields(boolean value)
```

Flatten all the fields of the PDF form.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getResetFontFolders()
```
public boolean getResetFontFolders()
```

Reset font folders before loading document

**Returns:**
boolean
##### setResetFontFolders(boolean resetFontFolders)
```
public void setResetFontFolders(boolean resetFontFolders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resetFontFolders | boolean |  |

### PersonalStorageLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/personalstorageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
public class PersonalStorageLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions
```

Options for loading personal storage documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PersonalStorageLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFolder() | Folder which to be processed Default is Inbox |
| setFolder(String folder) | Set folder which to be processed |
| isConvertOwner() | \{@inheritDoc\} The owner will not be converted |
| isConvertOwned() | \{@inheritDoc\} |
| getDepth() | \{@inheritDoc\} |
| setDepth(int depth) | \{@inheritDoc\} |
##### PersonalStorageLoadOptions()
```
public PersonalStorageLoadOptions()
```

Initializes new instance of  class.

##### getFolder()
```
public String getFolder()
```

Folder which to be processed Default is Inbox

**Returns:**
java.lang.String - Folder which to be processed
##### setFolder(String folder)
```
public void setFolder(String folder)
```

Set folder which to be processed

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folder | java.lang.String | folder |

##### isConvertOwner()
```
public boolean isConvertOwner()
```

Gets option to control whether the documents container itself must be converted The owner will not be converted

**Returns:**
boolean
##### isConvertOwned()
```
public boolean isConvertOwned()
```

Option to control whether the owned documents in the documents container must be converted

**Returns:**
boolean
##### getDepth()
```
public int getDepth()
```

Option to control how many levels in depth to perform conversion

**Returns:**
int
##### setDepth(int depth)
```
public void setDepth(int depth)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int |  |

### PresentationLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/presentationloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions
```
public class PresentationLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions
```

Options for loading Presentation documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationLoadOptions() | Initializes new instance of EmailLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for rendering the presentation. |
| setDefaultFont(String value) | Default font for rendering the presentation. |
| getFontSubstitutes() | Substitute specific fonts when converting Presentation document. |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Presentation document. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
| getHideComments() | Hide comments. |
| setHideComments(boolean value) | Hide comments. |
| getShowHiddenSlides() | Show hidden slides. |
| setShowHiddenSlides(boolean value) | Show hidden slides. |
| getSkipExternalResources() | \{@inheritDoc\} |
| setSkipExternalResources(boolean skip) | \{@inheritDoc\} |
| getWhitelistedResources() | \{@inheritDoc\} |
| setWhitelistedResources(List<String> whiteList) | \{@inheritDoc\} |
| getDocumentFontSources() |  |
| setDocumentFontSources(List<String> documentFontSources) |  |
| getNotesPosition() | Represents the way comments are printed with the slide. |
| setNotesPosition(PresentationNotesPosition notesPosition) | Represents the way notes are printed with the slide. |
| getCommentsPosition() |  |
| setCommentsPosition(PresentationCommentsPosition commentsPosition) |  |
##### PresentationLoadOptions()
```
public PresentationLoadOptions()
```

Initializes new instance of EmailLoadOptions class.

##### getFormat()
```
public final PresentationFileType getFormat()
```

Input document file type

**Returns:**
PresentationFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Presentation document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Presentation document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHideComments()
```
public final boolean getHideComments()
```

Hide comments.

**Returns:**
boolean
##### setHideComments(boolean value)
```
public final void setHideComments(boolean value)
```

Hide comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getShowHiddenSlides()
```
public final boolean getShowHiddenSlides()
```

Show hidden slides.

**Returns:**
boolean
##### setShowHiddenSlides(boolean value)
```
public final void setShowHiddenSlides(boolean value)
```

Show hidden slides.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSkipExternalResources()
```
public boolean getSkipExternalResources()
```

If true all external resource will not be loading with exception of the resources in the

**Returns:**
boolean
##### setSkipExternalResources(boolean skip)
```
public void setSkipExternalResources(boolean skip)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean |  |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

External resources that will be always loaded

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whiteList)
```
public void setWhitelistedResources(List<String> whiteList)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteList | java.util.List<java.lang.String> |  |

##### getDocumentFontSources()
```
public List<String> getDocumentFontSources()
```

**Returns:**
java.util.List<java.lang.String>
##### setDocumentFontSources(List<String> documentFontSources)
```
public void setDocumentFontSources(List<String> documentFontSources)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentFontSources | java.util.List<java.lang.String> |  |

##### getNotesPosition()
```
public PresentationNotesPosition getNotesPosition()
```

Represents the way comments are printed with the slide. Default is None.

**Returns:**
PresentationNotesPosition
##### setNotesPosition(PresentationNotesPosition notesPosition)
```
public void setNotesPosition(PresentationNotesPosition notesPosition)
```

Represents the way notes are printed with the slide. Default is None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| notesPosition | PresentationNotesPosition |  |

##### getCommentsPosition()
```
public PresentationCommentsPosition getCommentsPosition()
```

**Returns:**
PresentationCommentsPosition -
##### setCommentsPosition(PresentationCommentsPosition commentsPosition)
```
public void setCommentsPosition(PresentationCommentsPosition commentsPosition)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| commentsPosition | PresentationCommentsPosition |  |

### PublisherLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/publisherloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class PublisherLoadOptions extends LoadOptions
```

Options for loading Publisher documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PublisherLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type. |
| setFormat(PublisherFileType format) | Sets Input document file type. |
##### PublisherLoadOptions()
```
public PublisherLoadOptions()
```

Initializes new instance of  class.

##### getFormat()
```
public PublisherFileType getFormat()
```

Gets Input document file type.

**Returns:**
PublisherFileType
##### setFormat(PublisherFileType format)
```
public void setFormat(PublisherFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | PublisherFileType |  |

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/spreadsheetloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.lang.Cloneable, java.io.Serializable
```
public class SpreadsheetLoadOptions extends LoadOptions implements Cloneable, Serializable
```

Options for loading Spreadsheet documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Initializes new instance of SpreadsheetLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getSheets() | Get sheet name to convert |
| setSheets(List<String> sheets) | Set sheet name to convert |
| getCultureInfo() | Get the system culture info at the time file is loaded |
| setCultureInfo(System.Globalization.CultureInfo cultureInfo) | Set the system culture info at the time file is loaded |
| getFormat() |  |
| getDefaultFont() | Default font for spreadsheet document. |
| setDefaultFont(String value) | Default font for spreadsheet document. |
| getFontSubstitutes() | Substitute specific fonts when converting spreadsheet document. |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting spreadsheet document. |
| getShowGridLines() | Show grid lines when converting Excel files. |
| setShowGridLines(boolean value) | Show grid lines when converting Excel files. |
| getShowHiddenSheets() | Show hidden sheets when converting Excel files. |
| setShowHiddenSheets(boolean value) | Show hidden sheets when converting Excel files. |
| getOnePagePerSheet() | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. |
| setOnePagePerSheet(boolean value) | If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. |
| getAllColumnsInOnePagePerSheet() | Gets AllColumnsInOnePagePerSheet property |
| setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet) | Sets AllColumnsInOnePagePerSheet property |
| getOptimizePdfSize() | If True and converting to Pdf the conversion is optimized for better file size than print quality. |
| setOptimizePdfSize(boolean value) | If True and converting to Pdf the conversion is optimized for better file size than print quality. |
| getConvertRange() | Convert specific range when converting to other than spreadsheet format. |
| setConvertRange(String value) | Convert specific range when converting to other than spreadsheet format. |
| getSkipEmptyRowsAndColumns() | Skips empty rows and columns when converting. |
| setSkipEmptyRowsAndColumns(boolean value) | Skips empty rows and columns when converting. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
| getHideComments() | Hide comments. |
| setHideComments(boolean value) | Hide comments. |
| isCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects. |
| setCheckExcelRestriction(boolean checkExcelRestriction) |  |
| getSheetIndexes() | Gets List of sheet indexes to convert. |
| setSheetIndexes(List<Integer> sheetIndexes) | Sets List of sheet indexes to convert. |
| isAutoFitRows() | Autofits all rows when converting |
| setAutoFitRows(boolean autoFitRows) |  |
| getResetFontFolders() | Reset font folders before loading document |
| setResetFontFolders(boolean resetFontFolders) |  |
| deepClone() | Clones current instance. |
##### SpreadsheetLoadOptions()
```
public SpreadsheetLoadOptions()
```

Initializes new instance of SpreadsheetLoadOptions class.

##### getSheets()
```
public List<String> getSheets()
```

Get sheet name to convert

**Returns:**
java.util.List<java.lang.String>
##### setSheets(List<String> sheets)
```
public void setSheets(List<String> sheets)
```

Set sheet name to convert

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sheets | java.util.List<java.lang.String> |  |

##### getCultureInfo()
```
public System.Globalization.CultureInfo getCultureInfo()
```

Get the system culture info at the time file is loaded

**Returns:**
com.aspose.ms.System.Globalization.CultureInfo
##### setCultureInfo(System.Globalization.CultureInfo cultureInfo)
```
public void setCultureInfo(System.Globalization.CultureInfo cultureInfo)
```

Set the system culture info at the time file is loaded

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cultureInfo | com.aspose.ms.System.Globalization.CultureInfo |  |

##### getFormat()
```
public final SpreadsheetFileType getFormat()
```

Input document file type

**Returns:**
SpreadsheetFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for spreadsheet document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for spreadsheet document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting spreadsheet document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting spreadsheet document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getShowGridLines()
```
public final boolean getShowGridLines()
```

Show grid lines when converting Excel files.

**Returns:**
boolean
##### setShowGridLines(boolean value)
```
public final void setShowGridLines(boolean value)
```

Show grid lines when converting Excel files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getShowHiddenSheets()
```
public final boolean getShowHiddenSheets()
```

Show hidden sheets when converting Excel files.

**Returns:**
boolean
##### setShowHiddenSheets(boolean value)
```
public final void setShowHiddenSheets(boolean value)
```

Show hidden sheets when converting Excel files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOnePagePerSheet()
```
public final boolean getOnePagePerSheet()
```

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is false.

**Returns:**
boolean
##### setOnePagePerSheet(boolean value)
```
public final void setOnePagePerSheet(boolean value)
```

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAllColumnsInOnePagePerSheet()
```
public boolean getAllColumnsInOnePagePerSheet()
```

Gets AllColumnsInOnePagePerSheet property

**Returns:**
boolean - true if fit all columns to ont page
##### setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)
```
public void setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)
```

Sets AllColumnsInOnePagePerSheet property

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allColumnsInOnePagePerSheet | boolean | AllColumnsInOnePagePerSheet property |

##### getOptimizePdfSize()
```
public final boolean getOptimizePdfSize()
```

If True and converting to Pdf the conversion is optimized for better file size than print quality.

**Returns:**
boolean
##### setOptimizePdfSize(boolean value)
```
public final void setOptimizePdfSize(boolean value)
```

If True and converting to Pdf the conversion is optimized for better file size than print quality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertRange()
```
public final String getConvertRange()
```

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

**Returns:**
java.lang.String
##### setConvertRange(String value)
```
public final void setConvertRange(String value)
```

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSkipEmptyRowsAndColumns()
```
public final boolean getSkipEmptyRowsAndColumns()
```

Skips empty rows and columns when converting. Default is True.

**Returns:**
boolean
##### setSkipEmptyRowsAndColumns(boolean value)
```
public final void setSkipEmptyRowsAndColumns(boolean value)
```

Skips empty rows and columns when converting. Default is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHideComments()
```
public final boolean getHideComments()
```

Hide comments.

**Returns:**
boolean
##### setHideComments(boolean value)
```
public final void setHideComments(boolean value)
```

Hide comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### isCheckExcelRestriction()
```
public boolean isCheckExcelRestriction()
```

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

**Returns:**
boolean - check restriction flag
##### setCheckExcelRestriction(boolean checkExcelRestriction)
```
public void setCheckExcelRestriction(boolean checkExcelRestriction)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| checkExcelRestriction | boolean |  |

##### getSheetIndexes()
```
public List<Integer> getSheetIndexes()
```

Gets List of sheet indexes to convert.

**Returns:**
java.util.List<java.lang.Integer>
##### setSheetIndexes(List<Integer> sheetIndexes)
```
public void setSheetIndexes(List<Integer> sheetIndexes)
```

Sets List of sheet indexes to convert. The indexes must be zero-based

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sheetIndexes | java.util.List<java.lang.Integer> |  |

##### isAutoFitRows()
```
public boolean isAutoFitRows()
```

Autofits all rows when converting

**Returns:**
boolean
##### setAutoFitRows(boolean autoFitRows)
```
public void setAutoFitRows(boolean autoFitRows)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| autoFitRows | boolean |  |

##### getResetFontFolders()
```
public boolean getResetFontFolders()
```

Reset font folders before loading document

**Returns:**
boolean
##### setResetFontFolders(boolean resetFontFolders)
```
public void setResetFontFolders(boolean resetFontFolders)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resetFontFolders | boolean |  |

##### deepClone()
```
public final Object deepClone()
```

Clones current instance.

**Returns:**
java.lang.Object -

### TsvLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/tsvloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions, com.groupdocs.conversion.options.load.SpreadsheetLoadOptions
```
public class TsvLoadOptions extends SpreadsheetLoadOptions
```

Options for loading Tsv documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| TsvLoadOptions() | Initializes new instance of  class. |
##### TsvLoadOptions()
```
public TsvLoadOptions()
```

Initializes new instance of  class.

### TxtLeadingSpacesOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/txtleadingspacesoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class TxtLeadingSpacesOptions extends Enumeration implements Serializable
```

Describes txt leading spaces options enumeration.
#### Constructors

| Constructor | Description |
| --- | --- |
| TxtLeadingSpacesOptions() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| ConvertToIndent | Converts leading spaces to indents. |
| Preserve | Preserves leading spaces. |
| Trim | Trims leading spaces. |
##### TxtLeadingSpacesOptions()
```
public TxtLeadingSpacesOptions()
```

Serialization constructor

##### ConvertToIndent
```
public static final TxtLeadingSpacesOptions ConvertToIndent
```

Converts leading spaces to indents.

##### Preserve
```
public static final TxtLeadingSpacesOptions Preserve
```

Preserves leading spaces.

##### Trim
```
public static final TxtLeadingSpacesOptions Trim
```

Trims leading spaces.

### TxtLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/txtloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class TxtLoadOptions extends LoadOptions implements Serializable
```

Options for loading Txt documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| TxtLoadOptions() | Initializes new instance of TxtLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDetectNumberingWithWhitespaces() | Allows to specify how numbered list items are recognized when plain text document is converted. |
| setDetectNumberingWithWhitespaces(boolean value) | Allows to specify how numbered list items are recognized when plain text document is converted. |
| getTrailingSpacesOptions() | Gets or sets preferred option of a trailing space handling. |
| setTrailingSpacesOptions(TxtTrailingSpacesOptions value) | Gets or sets preferred option of a trailing space handling. |
| getLeadingSpacesOptions() | Gets or sets preferred option of a leading space handling. |
| setLeadingSpacesOptions(TxtLeadingSpacesOptions value) | Gets or sets preferred option of a leading space handling. |
| getEncoding() | Gets or sets the encoding that will be used when loading Txt document. |
| getEncodingInternal() |  |
| setEncoding(Charset value) | Gets or sets the encoding that will be used when loading Txt document. |
| setEncoding(String charsetName) | Gets or sets the encoding that will be used when loading Txt document. |
##### TxtLoadOptions()
```
public TxtLoadOptions()
```

Initializes new instance of TxtLoadOptions class.

##### getFormat()
```
public WordProcessingFileType getFormat()
```

Input document file type

**Returns:**
WordProcessingFileType
##### getDetectNumberingWithWhitespaces()
```
public final boolean getDetectNumberingWithWhitespaces()
```

Allows to specify how numbered list items are recognized when plain text document is converted. The default value is true.

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "\\u2022", "\*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

**Returns:**
boolean
##### setDetectNumberingWithWhitespaces(boolean value)
```
public final void setDetectNumberingWithWhitespaces(boolean value)
```

Allows to specify how numbered list items are recognized when plain text document is converted. The default value is true.

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "\\u2022", "\*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTrailingSpacesOptions()
```
public final TxtTrailingSpacesOptions getTrailingSpacesOptions()
```

Gets or sets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.Trim.

**Returns:**
TxtTrailingSpacesOptions
##### setTrailingSpacesOptions(TxtTrailingSpacesOptions value)
```
public final void setTrailingSpacesOptions(TxtTrailingSpacesOptions value)
```

Gets or sets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.Trim.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TxtTrailingSpacesOptions |  |

##### getLeadingSpacesOptions()
```
public final TxtLeadingSpacesOptions getLeadingSpacesOptions()
```

Gets or sets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.ConvertToIndent.

**Returns:**
TxtLeadingSpacesOptions
##### setLeadingSpacesOptions(TxtLeadingSpacesOptions value)
```
public final void setLeadingSpacesOptions(TxtLeadingSpacesOptions value)
```

Gets or sets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.ConvertToIndent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TxtLeadingSpacesOptions |  |

##### getEncoding()
```
public final Charset getEncoding()
```

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

**Returns:**
java.nio.charset.Charset
##### getEncodingInternal()
```
public System.Text.Encoding getEncodingInternal()
```

**Returns:**
com.aspose.ms.System.Text.Encoding
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### setEncoding(String charsetName)
```
public final void setEncoding(String charsetName)
```

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| charsetName | java.lang.String |  |

### TxtTrailingSpacesOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/txttrailingspacesoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.Enumeration

**All Implemented Interfaces:**
java.io.Serializable
```
public class TxtTrailingSpacesOptions extends Enumeration implements Serializable
```

Describes txt trailing spaces options enumeration.
#### Constructors

| Constructor | Description |
| --- | --- |
| TxtTrailingSpacesOptions() | Serialization constructor |
#### Fields

| Field | Description |
| --- | --- |
| Preserve | Preserves trailing spaces |
| Trim | Trims trailing spaces |
##### TxtTrailingSpacesOptions()
```
public TxtTrailingSpacesOptions()
```

Serialization constructor

##### Preserve
```
public static final TxtTrailingSpacesOptions Preserve
```

Preserves trailing spaces

##### Trim
```
public static final TxtTrailingSpacesOptions Trim
```

Trims trailing spaces

### VcfLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/vcfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class VcfLoadOptions extends LoadOptions
```

Options for loading Vcf documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| VcfLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets or sets the encoding that will be used when loading Vcf document. |
| setEncoding(System.Text.Encoding encoding) |  |
##### VcfLoadOptions()
```
public VcfLoadOptions()
```

Initializes new instance of  class.

##### getEncoding()
```
public System.Text.Encoding getEncoding()
```

Gets or sets the encoding that will be used when loading Vcf document. Default is Encoding.Default.

**Returns:**
com.aspose.ms.System.Text.Encoding
##### setEncoding(System.Text.Encoding encoding)
```
public void setEncoding(System.Text.Encoding encoding)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | com.aspose.ms.System.Text.Encoding |  |

### VideoLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/videoloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
```
public class VideoLoadOptions extends LoadOptions
```

Options for loading video documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| VideoLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getVideoConnector() |  |
| setVideoConnector(IVideoConnector videoConnector) | Set video document connector |
##### VideoLoadOptions()
```
public VideoLoadOptions()
```

Initializes new instance of  class.

##### getVideoConnector()
```
public IVideoConnector getVideoConnector()
```

**Returns:**
IVideoConnector
##### setVideoConnector(IVideoConnector videoConnector)
```
public void setVideoConnector(IVideoConnector videoConnector)
```

Set video document connector

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| videoConnector | IVideoConnector | Video connector instance |

### WebLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/webloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions
```
public class WebLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions
```

Options for loading web documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| WebLoadOptions() | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets Input document file type. |
| setFormat(WebFileType format) | Sets Input document file type. |
| isPageNumbering() |  |
| setPageNumbering(boolean pageNumbering) |  |
| getBasePath() |  |
| setBasePath(String basePath) |  |
| getEncoding() |  |
| setEncoding(String encoding) |  |
| getResourceLoadingTimeout() |  |
| setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout) |  |
| getSkipExternalResources() | \{@inheritDoc\} |
| setSkipExternalResources(boolean skip) | \{@inheritDoc\} |
| getWhitelistedResources() | \{@inheritDoc\} |
| setWhitelistedResources(List<String> whiteList) | \{@inheritDoc\} |
##### WebLoadOptions()
```
public WebLoadOptions()
```

Initializes new instance of  class.

##### getFormat()
```
public WebFileType getFormat()
```

Gets Input document file type.

**Returns:**
WebFileType
##### setFormat(WebFileType format)
```
public void setFormat(WebFileType format)
```

Sets Input document file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | WebFileType |  |

##### isPageNumbering()
```
public boolean isPageNumbering()
```

**Returns:**
boolean
##### setPageNumbering(boolean pageNumbering)
```
public void setPageNumbering(boolean pageNumbering)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbering | boolean |  |

##### getBasePath()
```
public String getBasePath()
```

**Returns:**
java.lang.String
##### setBasePath(String basePath)
```
public void setBasePath(String basePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| basePath | java.lang.String |  |

##### getEncoding()
```
public String getEncoding()
```

**Returns:**
java.lang.String
##### setEncoding(String encoding)
```
public void setEncoding(String encoding)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | java.lang.String |  |

##### getResourceLoadingTimeout()
```
public System.TimeSpan getResourceLoadingTimeout()
```

**Returns:**
com.aspose.ms.System.TimeSpan
##### setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
```
public void setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resourceLoadingTimeout | com.aspose.ms.System.TimeSpan |  |

##### getSkipExternalResources()
```
public boolean getSkipExternalResources()
```

If true all external resource will not be loading with exception of the resources in the

**Returns:**
boolean
##### setSkipExternalResources(boolean skip)
```
public void setSkipExternalResources(boolean skip)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean |  |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

External resources that will be always loaded

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whiteList)
```
public void setWhitelistedResources(List<String> whiteList)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteList | java.util.List<java.lang.String> |  |

### WordProcessingBookmarksOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/wordprocessingbookmarksoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject

**All Implemented Interfaces:**
java.io.Serializable
```
public class WordProcessingBookmarksOptions extends ValueObject implements Serializable
```

Options for handling bookmarks in WordProcessing
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingBookmarksOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getBookmarksOutlineLevel() | Specifies the default level in the document outline at which to display Word bookmarks. |
| setBookmarksOutlineLevel(int value) | Specifies the default level in the document outline at which to display Word bookmarks. |
| getHeadingsOutlineLevels() | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. |
| setHeadingsOutlineLevels(int value) | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. |
| getExpandedOutlineLevels() | Specifies how many levels in the document outline to show expanded when the file is viewed. |
| setExpandedOutlineLevels(int value) | Specifies how many levels in the document outline to show expanded when the file is viewed. |
##### WordProcessingBookmarksOptions()
```
public WordProcessingBookmarksOptions()
```

##### getBookmarksOutlineLevel()
```
public final int getBookmarksOutlineLevel()
```

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.

**Returns:**
int
##### setBookmarksOutlineLevel(int value)
```
public final void setBookmarksOutlineLevel(int value)
```

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeadingsOutlineLevels()
```
public final int getHeadingsOutlineLevels()
```

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.

**Returns:**
int
##### setHeadingsOutlineLevels(int value)
```
public final void setHeadingsOutlineLevels(int value)
```

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExpandedOutlineLevels()
```
public final int getExpandedOutlineLevels()
```

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.

**Returns:**
int
##### setExpandedOutlineLevels(int value)
```
public final void setExpandedOutlineLevels(int value)
```

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/wordprocessingloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

**All Implemented Interfaces:**
java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions
```
public class WordProcessingLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions
```

Options for loading WordProcessing documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingLoadOptions() | Initializes new instance of WordProcessingLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() |  |
| getDefaultFont() | Default font for Words document. |
| setDefaultFont(String value) | Default font for Words document. |
| getAutoFontSubstitution() | If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. |
| setAutoFontSubstitution(boolean value) | If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. |
| getFontSubstitutes() | Substitute specific fonts when converting Words document. |
| isEmbedTrueTypeFonts() | If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. |
| setEmbedTrueTypeFonts(boolean embedTrueTypeFonts) |  |
| isUpdatePageLayout() | Update page layout after loading. |
| setUpdatePageLayout(boolean updatePageLayout) |  |
| isUpdateFields() | Update fields after loading. |
| setUpdateFields(boolean updateFields) |  |
| isKeepDateFieldOriginalValue() | Keep original value of date field. |
| setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue) | Sets Keep original value of date field. |
| setFontSubstitutes(List<FontSubstitute> value) | Substitute specific fonts when converting Words document. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
| getHideWordTrackedChanges() | Hide markup and track changes for Word documents. |
| setHideWordTrackedChanges(boolean value) | Hide markup and track changes for Word documents. |
| setHideComments(boolean value) | Hide comments. |
| getBookmarkOptions() | Bookmarks options |
| setBookmarkOptions(WordProcessingBookmarksOptions value) | Bookmarks options |
| isPreserveFontFields() | Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. |
| setPreserveFontFields(boolean preserveFontFields) | Sets preserveFontFields flag |
| isUseTextShaper() | Specifies whether to use a text shaper for better kerning display. |
| setUseTextShaper(boolean isUseTextShaper) | Specifies whether to use a text shaper for better kerning display. |
| isPreserveDocumentStructure() | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| setPreserveDocumentStructure(boolean preserveDocumentStructure) |  |
| getSkipExternalResources() | \{@inheritDoc\} |
| setSkipExternalResources(boolean skip) | \{@inheritDoc\} |
| getWhitelistedResources() | \{@inheritDoc\} |
| setWhitelistedResources(List<String> whiteList) | \{@inheritDoc\} |
| getCommentDisplayMode() | Specifies how comments should be displayed in the output document. |
| setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode) |  |
| getShowFullCommenterName() | Show full commenter name in comments. |
| setShowFullCommenterName(boolean showFullCommenterName) |  |
##### WordProcessingLoadOptions()
```
public WordProcessingLoadOptions()
```

Initializes new instance of WordProcessingLoadOptions class.

##### getFormat()
```
public final WordProcessingFileType getFormat()
```

Input document file type

**Returns:**
WordProcessingFileType
##### getDefaultFont()
```
public final String getDefaultFont()
```

Default font for Words document. The following font will be used if a font is missing.

**Returns:**
java.lang.String
##### setDefaultFont(String value)
```
public final void setDefaultFont(String value)
```

Default font for Words document. The following font will be used if a font is missing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAutoFontSubstitution()
```
public final boolean getAutoFontSubstitution()
```

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.

**Returns:**
boolean
##### setAutoFontSubstitution(boolean value)
```
public final void setAutoFontSubstitution(boolean value)
```

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFontSubstitutes()
```
public final List<FontSubstitute> getFontSubstitutes()
```

Substitute specific fonts when converting Words document.

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
##### isEmbedTrueTypeFonts()
```
public boolean isEmbedTrueTypeFonts()
```

If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: false

**Returns:**
boolean
##### setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
```
public void setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| embedTrueTypeFonts | boolean |  |

##### isUpdatePageLayout()
```
public boolean isUpdatePageLayout()
```

Update page layout after loading. Default: false

**Returns:**
boolean
##### setUpdatePageLayout(boolean updatePageLayout)
```
public void setUpdatePageLayout(boolean updatePageLayout)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updatePageLayout | boolean |  |

##### isUpdateFields()
```
public boolean isUpdateFields()
```

Update fields after loading. Default: false

**Returns:**
boolean
##### setUpdateFields(boolean updateFields)
```
public void setUpdateFields(boolean updateFields)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updateFields | boolean |  |

##### isKeepDateFieldOriginalValue()
```
public boolean isKeepDateFieldOriginalValue()
```

Keep original value of date field. Default: false

**Returns:**
boolean
##### setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue)
```
public void setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue)
```

Sets Keep original value of date field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keepDateFieldOriginalValue | boolean |  |

##### setFontSubstitutes(List<FontSubstitute> value)
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```

Substitute specific fonts when converting Words document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |  |

##### getPassword()
```
public final String getPassword()
```

Set password to unprotect protected document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Set password to unprotect protected document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHideWordTrackedChanges()
```
public final boolean getHideWordTrackedChanges()
```

Hide markup and track changes for Word documents.

**Returns:**
boolean
##### setHideWordTrackedChanges(boolean value)
```
public final void setHideWordTrackedChanges(boolean value)
```

Hide markup and track changes for Word documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### setHideComments(boolean value)
```
public final void setHideComments(boolean value)
```

Hide comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getBookmarkOptions()
```
public final WordProcessingBookmarksOptions getBookmarkOptions()
```

Bookmarks options

**Returns:**
WordProcessingBookmarksOptions
##### setBookmarkOptions(WordProcessingBookmarksOptions value)
```
public final void setBookmarkOptions(WordProcessingBookmarksOptions value)
```

Bookmarks options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WordProcessingBookmarksOptions |  |

##### isPreserveFontFields()
```
public boolean isPreserveFontFields()
```

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

**Returns:**
boolean - preserveFontFields flag
##### setPreserveFontFields(boolean preserveFontFields)
```
public void setPreserveFontFields(boolean preserveFontFields)
```

Sets preserveFontFields flag

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preserveFontFields | boolean | preserve Microsoft Word form fields as form fields in PDF or convert them to text |

##### isUseTextShaper()
```
public boolean isUseTextShaper()
```

Specifies whether to use a text shaper for better kerning display. Default is false.

**Returns:**
boolean
##### setUseTextShaper(boolean isUseTextShaper)
```
public void setUseTextShaper(boolean isUseTextShaper)
```

Specifies whether to use a text shaper for better kerning display. Default is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isUseTextShaper | boolean | isUseTextShaper flag |

##### isPreserveDocumentStructure()
```
public boolean isPreserveDocumentStructure()
```

Determines whether the document structure should be preserved when converting to PDF (default is false). Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

**Returns:**
boolean
##### setPreserveDocumentStructure(boolean preserveDocumentStructure)
```
public void setPreserveDocumentStructure(boolean preserveDocumentStructure)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preserveDocumentStructure | boolean |  |

##### getSkipExternalResources()
```
public boolean getSkipExternalResources()
```

If true all external resource will not be loading with exception of the resources in the

**Returns:**
boolean
##### setSkipExternalResources(boolean skip)
```
public void setSkipExternalResources(boolean skip)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skip | boolean |  |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

External resources that will be always loaded

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whiteList)
```
public void setWhitelistedResources(List<String> whiteList)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteList | java.util.List<java.lang.String> |  |

##### getCommentDisplayMode()
```
public WordProcessingCommentDisplay getCommentDisplayMode()
```

Specifies how comments should be displayed in the output document. Default is ShowInBalloons.

**Returns:**
WordProcessingCommentDisplay
##### setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode)
```
public void setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| commentDisplayMode | WordProcessingCommentDisplay |  |

##### getShowFullCommenterName()
```
public boolean getShowFullCommenterName()
```

Show full commenter name in comments. Default is false.

**Returns:**
boolean
##### setShowFullCommenterName(boolean showFullCommenterName)
```
public void setShowFullCommenterName(boolean showFullCommenterName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| showFullCommenterName | boolean |  |

### XmlLoadOptions
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.options.load/xmlloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions, com.groupdocs.conversion.options.load.WebLoadOptions

**All Implemented Interfaces:**
java.io.Serializable
```
public final class XmlLoadOptions extends WebLoadOptions implements Serializable
```

Options for loading XML documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlLoadOptions() | Initializes new instance of XmlLoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getXslFoFactory() | XSL-FO document stream to convert XML-FO using XSL. |
| setXslFoFactory(Supplier<System.IO.Stream> value) | XSL document stream to convert XML-FO using XSL. |
| getXsltFactory() | get XSLT document stream to convert XML performing XSL transformation to HTML. |
| setXsltFactory(Supplier<System.IO.Stream> value) | set XSLT document stream to convert XML performing XSL transformation to HTML. |
| isUseAsDataSource() | Use Xml document as data source |
| setUseAsDataSource(boolean useAsDataSource) | Set use Xml document as data source |
##### XmlLoadOptions()
```
public XmlLoadOptions()
```

Initializes new instance of XmlLoadOptions class.

##### getXslFoFactory()
```
public final Supplier<System.IO.Stream> getXslFoFactory()
```

XSL-FO document stream to convert XML-FO using XSL.

**Returns:**
java.util.function.Supplier<com.aspose.ms.System.IO.Stream>
##### setXslFoFactory(Supplier<System.IO.Stream> value)
```
public final void setXslFoFactory(Supplier<System.IO.Stream> value)
```

XSL document stream to convert XML-FO using XSL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.function.Supplier<com.aspose.ms.System.IO.Stream> |  |

##### getXsltFactory()
```
public final Supplier<System.IO.Stream> getXsltFactory()
```

get XSLT document stream to convert XML performing XSL transformation to HTML.

**Returns:**
java.util.function.Supplier<com.aspose.ms.System.IO.Stream>
##### setXsltFactory(Supplier<System.IO.Stream> value)
```
public final void setXsltFactory(Supplier<System.IO.Stream> value)
```

set XSLT document stream to convert XML performing XSL transformation to HTML.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.function.Supplier<com.aspose.ms.System.IO.Stream> |  |

##### isUseAsDataSource()
```
public boolean isUseAsDataSource()
```

Use Xml document as data source

**Returns:**
boolean - true if use
##### setUseAsDataSource(boolean useAsDataSource)
```
public void setUseAsDataSource(boolean useAsDataSource)
```

Set use Xml document as data source

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useAsDataSource | boolean | use Xml document as data source |

### com.groupdocs.conversion.reporting
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.reporting.md

The GroupDocs.Conversion.Options.Load namespace provides classes to implement converter listening.

**Learn more**More about monitoring conversion progress: [Listening to conversion process events][]

[Listening to conversion process events]: https://docs.groupdocs.com/display/conversionnet/Listening

### com.groupdocs.conversion
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion.md

The scope for GroupDocs.Conversion classes

#### Classes

| Class | Description |
| --- | --- |
| Converter | Represents main class that controls document conversion process. |
| ConverterSettings | Defines settings for customizing Converter behaviour. |

### Converter
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion/converter.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Converter implements Closeable
```

Represents main class that controls document conversion process.
#### Constructors

| Constructor | Description |
| --- | --- |
| Converter() | Initializes new instance of  class for fluent conversion setup. |
| Converter(Supplier<InputStream> document) | Initializes new instance of Converter class. |
| Converter(Supplier<InputStream> document, ConverterSettingsProvider settings) | Initializes new instance of Converter class. |
| Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions) | Initializes new instance of Converter class. |
| Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of Converter class. |
| Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions) | Initializes new instance of  class. |
| Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of  class. |
| Converter(String filePath) | Initializes new instance of Converter class. |
| Converter(String filePath, ConverterSettingsProvider settings) | Initializes new instance of Converter class. |
| Converter(String filePath, LoadOptionsProvider loadOptions) | Initializes new instance of Converter class. |
| Converter(String filePath, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of Converter class. |
| Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions) | Initializes new instance of  class. |
| Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings) | Initializes new instance of  class. |
#### Methods

| Method | Description |
| --- | --- |
| tweakPackageUtil(String vendor, String version, String specTitle) |  |
| convert(SaveDocumentStream document, ConvertOptions convertOptions) | Converts source document. |
| convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions) | Converts source document. |
| convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions) | Converts source document. |
| convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions) | Converts source document. |
| convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(String filePath, ConvertOptions convertOptions) | Converts source document. |
| convert(SavePageStream document, ConvertOptions convertOptions) | Converts source document. |
| convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions) | Converts source document. |
| convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(SavePageStreamForFileType document, ConvertOptions convertOptions) | Converts source document. |
| convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions) | Converts source document. |
| convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider) | Converts source document. |
| withSettings(ConverterSettingsProvider settingsProvider) |  |
| load(String fileName) |  |
| load(String[] fileNames) |  |
| load(DocumentStreamProvider documentStreamProvider) |  |
| load(DocumentStreamsProvider documentStreamProvider) |  |
| getDocumentInfo() | Gets source document info - pages count and other document properties specific to the file type. |
| isDocumentPasswordProtected() | Checks is source document is password protected |
| getPossibleConversions() | Gets possible conversions for the source document. |
| getAllPossibleConversions() | Gets all supported conversions **Learn more**Learn more about supported conversions: [Full list of supported conversions][]Learn more about available conversions: [How to get supported conversions in code][]

[Full list of supported conversions]: https://docs.groupdocs.com/display/conversionnet/Supported+Document+Formats
[How to get supported conversions in code]: https://docs.groupdocs.com/display/conversionnet/Get+possible+conversions |
| getPossibleConversions(String extension) | Gets supported conversions for provided document extension Converter.GetPossibleConversions(".docx") Converter.GetPossibleConversions("docx")**Learn more**Learn more about supported conversions: [Full list of supported conversions][]Learn more about available conversions: [How to get supported conversions in code][]

[Full list of supported conversions]: https://docs.groupdocs.com/display/conversionnet/Supported+Document+Formats
[How to get supported conversions in code]: https://docs.groupdocs.com/display/conversionnet/Get+possible+conversions |
| dispose() | Releases resources. |
| close() |  |
##### Converter()
```
public Converter()
```

Initializes new instance of  class for fluent conversion setup.  Sample fluent conversion usage: `var converter = new Converter();` `converter .Load("") .ConvertTo("") .Convert();` `converter .WithSettings(() => new ConverterSettings()) .Load("").WithOptions(new PdfLoadOptions()) .ConvertTo("").WithOptions(new PdfConvertOptions()) .OnConversionCompleted(convertedDocumentStream => { }) .Convert();` `converter .Load("").WithOptions(new PdfLoadOptions()) .ConvertByPageTo((number => new FileStream("", FileMode.Create))).WithOptions(new PdfConvertOptions()) .OnConversionCompleted((number, stream) => {}) .Convert();` `converter.Load("").GetPossibleConversions(); converter.Load("").GetDocumentInfo(); converter.Load("").WithOptions(new PdfLoadOptions()).GetPossibleConversions(); converter.Load("").WithOptions(new PdfLoadOptions()).GetDocumentInfo();`

##### Converter(Supplier<InputStream> document)
```
public Converter(Supplier<InputStream> document)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | input stream supplier. |

##### Converter(Supplier<InputStream> document, ConverterSettingsProvider settings)
```
public Converter(Supplier<InputStream> document, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier. |
| settings | ConverterSettingsProvider | A Converter settings supplier. |

##### Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions)
```
public Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier. |
| loadOptions | LoadOptionsProvider | A load options supplier. |

##### Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(Supplier<InputStream> document, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier. |
| loadOptions | LoadOptionsProvider | A document load options supplier. |
| settings | ConverterSettingsProvider | A Converter settings supplier. |

##### Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions)
```
public Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions)
```

Initializes new instance of  class.**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | An input stream supplier. |
| loadOptions | LoadOptionsForFileTypeProvider | The function that return document load options. |

##### Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(Supplier<InputStream> document, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of  class.**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.util.function.Supplier<java.io.InputStream> | A supplier that returns readable stream. |
| loadOptions | LoadOptionsForFileTypeProvider | A function that returns document load options. |
| settings | ConverterSettingsProvider | A Converter settings supplier. |

##### Converter(String filePath)
```
public Converter(String filePath)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |

##### Converter(String filePath, ConverterSettingsProvider settings)
```
public Converter(String filePath, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |
| settings | ConverterSettingsProvider | A Converter settings supplier. |

##### Converter(String filePath, LoadOptionsProvider loadOptions)
```
public Converter(String filePath, LoadOptionsProvider loadOptions)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |
| loadOptions | LoadOptionsProvider | The load options supplier. |

##### Converter(String filePath, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(String filePath, LoadOptionsProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of Converter class.

**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |
| loadOptions | LoadOptionsProvider | The document load options supplier. |
| settings | ConverterSettingsProvider | The Converter settings supplier. |

##### Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions)
```
public Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions)
```

Initializes new instance of  class.**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |
| loadOptions | LoadOptionsForFileTypeProvider | The document load options function. |

##### Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings)
```
public Converter(String filePath, LoadOptionsForFileTypeProvider loadOptions, ConverterSettingsProvider settings)
```

Initializes new instance of  class.**Learn more**More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: [Loading document from different sources][]More about document loading options dependent on file type: [Load options for different document types][]

[Loading document from different sources]: https://docs.groupdocs.com/display/conversionnet/Loading+documents+from+different+sources
[Load options for different document types]: https://docs.groupdocs.com/display/conversionnet/Load+options+for+different+document+types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |
| loadOptions | LoadOptionsForFileTypeProvider | The document load options function. |
| settings | ConverterSettingsProvider | The Converter settings supplier. |

##### tweakPackageUtil(String vendor, String version, String specTitle)
```
public static void tweakPackageUtil(String vendor, String version, String specTitle)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| vendor | java.lang.String |  |
| version | java.lang.String |  |
| specTitle | java.lang.String |  |

##### convert(SaveDocumentStream document, ConvertOptions convertOptions)
```
public final void convert(SaveDocumentStream document, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document.

**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | The output stream supplier. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document. **Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | output stream supplier |
| documentCompleted | ConvertedDocumentStream | the delegate that receive converted document stream. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | the convert options specific to desired target file type. |

##### convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | The output stream supplier. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStream | The output stream supplier. |
| documentCompleted | ConvertedDocumentStream | The delegate that receive converted document stream. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions)
```
public void convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function |
| documentCompleted | ConvertedDocumentStream | The delegate that receive converted document stream |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type |

##### convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the whole converted document.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SaveDocumentStreamForFileType | Output stream function. |
| documentCompleted | ConvertedDocumentStream | The delegate that receive converted document stream. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(String filePath, ConvertOptions convertOptions)
```
public final void convert(String filePath, ConvertOptions convertOptions)
```

Converts source document. Saves the whole converted document.

**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to the source document. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SavePageStream document, ConvertOptions convertOptions)
```
public final void convert(SavePageStream document, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page.

**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | The page output stream function. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page. **Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | The output stream function. |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStream document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | The output stream function. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStream document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStream | Output stream function. |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(SavePageStreamForFileType document, ConvertOptions convertOptions)
```
public void convert(SavePageStreamForFileType document, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```
public void convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)
```

Converts source document. Saves the converted document page by page.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function. |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream. |
| convertOptions | com.groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

##### convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```
public void convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
```

Converts source document. Saves the converted document page by page.**Learn more**More about document conversion basic scenarios: [How to convert document in 3 steps][]Conversion use cases, advanced settings and customizations: [Convert document with advanced settings][]

[How to convert document in 3 steps]: https://docs.groupdocs.com/display/conversionnet/Convert+document
[Convert document with advanced settings]: https://docs.groupdocs.com/display/conversionnet/Converting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | SavePageStreamForFileType | An output stream function. |
| documentCompleted | ConvertedPageStream | The delegate that receive converted document page stream. |
| convertOptionsProvider | ConvertOptionsProvider | Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type. |

##### withSettings(ConverterSettingsProvider settingsProvider)
```
public IConversionFrom withSettings(ConverterSettingsProvider settingsProvider)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| settingsProvider | ConverterSettingsProvider |  |

**Returns:**
IConversionFrom
##### load(String fileName)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(String fileName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### load(String[] fileNames)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(String[] fileNames)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileNames | java.lang.String[] |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### load(DocumentStreamProvider documentStreamProvider)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(DocumentStreamProvider documentStreamProvider)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | DocumentStreamProvider |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### load(DocumentStreamsProvider documentStreamProvider)
```
public IConversionLoadOptionsOrSourceDocumentLoaded load(DocumentStreamsProvider documentStreamProvider)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentStreamProvider | DocumentStreamsProvider |  |

**Returns:**
IConversionLoadOptionsOrSourceDocumentLoaded
##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets source document info - pages count and other document properties specific to the file type.

**Learn more**Learn more about converted document - file type, pages count, creation date and many other format specific properties: [How to get document info][]

[How to get document info]: https://docs.groupdocs.com/display/conversionnet/Get+document+info

**Returns:**
IDocumentInfo - document info
##### isDocumentPasswordProtected()
```
public boolean isDocumentPasswordProtected()
```

Checks is source document is password protected

**Returns:**
boolean - true if document is password protected **Learn more**Learn more about converted document - file type, pages count, creation date and many other format specific properties: [How to check is the document password protected][]

[How to check is the document password protected]: https://docs.groupdocs.com/display/conversionnet/Is+document+password+protected
##### getPossibleConversions()
```
public final PossibleConversions getPossibleConversions()
```

Gets possible conversions for the source document.

**Learn more**Learn more about supported conversions: [Full list of supported conversions][]Learn more about available conversions: [How to get supported conversions in code][]

[Full list of supported conversions]: https://docs.groupdocs.com/display/conversionnet/Supported+Document+Formats
[How to get supported conversions in code]: https://docs.groupdocs.com/display/conversionnet/Get+possible+conversions

**Returns:**
PossibleConversions - possible conversions
##### getAllPossibleConversions()
```
public static List<PossibleConversions> getAllPossibleConversions()
```

Gets all supported conversions **Learn more**Learn more about supported conversions: [Full list of supported conversions][]Learn more about available conversions: [How to get supported conversions in code][]

[Full list of supported conversions]: https://docs.groupdocs.com/display/conversionnet/Supported+Document+Formats
[How to get supported conversions in code]: https://docs.groupdocs.com/display/conversionnet/Get+possible+conversions

**Returns:**
java.util.List<com.groupdocs.conversion.contracts.PossibleConversions> - supported conversions
##### getPossibleConversions(String extension)
```
public static PossibleConversions getPossibleConversions(String extension)
```

Gets supported conversions for provided document extension Converter.GetPossibleConversions(".docx") Converter.GetPossibleConversions("docx")**Learn more**Learn more about supported conversions: [Full list of supported conversions][]Learn more about available conversions: [How to get supported conversions in code][]

[Full list of supported conversions]: https://docs.groupdocs.com/display/conversionnet/Supported+Document+Formats
[How to get supported conversions in code]: https://docs.groupdocs.com/display/conversionnet/Get+possible+conversions

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | Document extension |

**Returns:**
PossibleConversions - possible conversions
##### dispose()
```
public final void dispose()
```

Releases resources.

##### close()
```
public void close()
```

### ConverterSettings
Path: https://reference.groupdocs.com/conversion/nodejs-java/com.groupdocs.conversion/convertersettings.md

**Inheritance:**
java.lang.Object
```
public final class ConverterSettings
```

Defines settings for customizing Converter behaviour.
#### Constructors

| Constructor | Description |
| --- | --- |
| ConverterSettings() |  |
#### Methods

| Method | Description |
| --- | --- |
| getCache() | The cache implementation used for storing conversion results. |
| setCache(ICache value) | The cache implementation used for storing conversion results. |
| getLogger() | The logger implementation used for logging conversion process. |
| setLogger(ILogger value) | The logger implementation used for logging conversion process. |
| getListener() | Gets the converter listener implementation used for monitoring conversion status and progress |
| setListener(IConverterListener listener) | Sets the converter listener implementation used for monitoring conversion status and progress |
| getFontDirectories() | The custom font directories paths |
| getFontDirectoriesInternal() |  |
| setFontDirectories(List<String> value) | The custom font directories paths |
| listConverterSettings() |  |
| getTempFolder() | Temp folder used for conversion |
| setTempFolder(String tempFolder) | Sets Temp folder used for conversion |
##### ConverterSettings()
```
public ConverterSettings()
```

##### getCache()
```
public final ICache getCache()
```

The cache implementation used for storing conversion results.

**Returns:**
ICache
##### setCache(ICache value)
```
public final void setCache(ICache value)
```

The cache implementation used for storing conversion results.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICache |  |

##### getLogger()
```
public final ILogger getLogger()
```

The logger implementation used for logging conversion process.

**Returns:**
ILogger
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

The logger implementation used for logging conversion process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ILogger |  |

##### getListener()
```
public IConverterListener getListener()
```

Gets the converter listener implementation used for monitoring conversion status and progress

**Returns:**
IConverterListener - The converter listener
##### setListener(IConverterListener listener)
```
public void setListener(IConverterListener listener)
```

Sets the converter listener implementation used for monitoring conversion status and progress

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| listener | IConverterListener | The converter listener |

##### getFontDirectories()
```
public final List<String> getFontDirectories()
```

The custom font directories paths

**Returns:**
java.util.List<java.lang.String>
##### getFontDirectoriesInternal()
```
public List<String> getFontDirectoriesInternal()
```

**Returns:**
java.util.List<java.lang.String>
##### setFontDirectories(List<String> value)
```
public void setFontDirectories(List<String> value)
```

The custom font directories paths

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### listConverterSettings()
```
public List<String> listConverterSettings()
```

**Returns:**
java.util.List<java.lang.String>
##### getTempFolder()
```
public String getTempFolder()
```

Temp folder used for conversion

**Returns:**
java.lang.String
##### setTempFolder(String tempFolder)
```
public void setTempFolder(String tempFolder)
```

Sets Temp folder used for conversion

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tempFolder | java.lang.String |  |

## Python

### GroupDocs.Conversion for Python via .NET
Path: https://reference.groupdocs.com/conversion/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.conversion` | Main GroupDocs.Conversion namespace with top-level API classes. |
| `groupdocs.conversion.caching` | Types under `groupdocs.conversion.caching`. |
| `groupdocs.conversion.contracts` | Result, context, and data-transfer types returned by the API. |
| `groupdocs.conversion.file_types` | Types under `groupdocs.conversion.file_types`. |
| `groupdocs.conversion.filetypes` | File type constants and format identifiers. |
| `groupdocs.conversion.fluent` | Types under `groupdocs.conversion.fluent`. |
| `groupdocs.conversion.logging` | Logging hooks and listener interfaces. |
| `groupdocs.conversion.options` | Option classes for configuring conversions and operations. |
| `groupdocs.conversion.options.convert` | Types under `groupdocs.conversion.options.convert`. |
| `groupdocs.conversion.options.load` | Types under `groupdocs.conversion.options.load`. |
| `groupdocs.conversion.reporting` | Types under `groupdocs.conversion.reporting`. |

### groupdocs.conversion.caching
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching.md

Types under `groupdocs.conversion.caching`.

##### Classes
| Class | Description |
| :- | :- |
| `FileCache` |  |
| `ICache` |  |
| `MemoryCache` |  |

### FileCache class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache.md

#### FileCache class

The FileCache type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_keys_string |  |
| _init_string |  |
| _set_string_object |  |
| _try_get_value_string_object_ |  |
| get_keys |  |
| get_keys_file |  |
| get_keys_string |  |
| set |  |
| set_file |  |
| set_string |  |
| try_get_value |  |
| try_get_value_file |  |
| try_get_value_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_keys_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/_get_keys_string.md

#### _get_keys_string

```python
def _get_keys_string(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `str` |  |

**Returns:** List[Any]

### _init_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/_init_string.md

#### _init_string

```python
def _init_string(self, cache_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| cache_path | `str` |  |

### _set_string_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/_set_string_object.md

#### _set_string_object

```python
def _set_string_object(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

### _try_get_value_string_object_ method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/_try_get_value_string_object_.md

#### _try_get_value_string_object_

```python
def _try_get_value_string_object_(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

**Returns:** bool

### get_keys method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/get_keys.md

#### get_keys

```python
def get_keys(self):
    ...
```

### get_keys_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/set.md

#### set

```python
def set(self):
    ...
```

### set_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/try_get_value.md

#### try_get_value

```python
def try_get_value(self):
    ...
```

### try_get_value_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/try_get_value_file.md

#### try_get_value_file

```python
def try_get_value_file(self):
    ...
```

### try_get_value_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/filecache/try_get_value_string.md

#### try_get_value_string

```python
def try_get_value_string(self):
    ...
```

### ICache class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache.md

#### ICache class

The ICache type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_keys_string |  |
| _set_string_object |  |
| _try_get_value_string_object_ |  |
| get_keys |  |
| get_keys_file |  |
| get_keys_string |  |
| set |  |
| set_file |  |
| set_string |  |
| try_get_value |  |
| try_get_value_file |  |
| try_get_value_string |  |

### _get_keys_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/_get_keys_string.md

#### _get_keys_string

```python
def _get_keys_string(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `str` |  |

**Returns:** List[Any]

### _set_string_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/_set_string_object.md

#### _set_string_object

```python
def _set_string_object(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

### _try_get_value_string_object_ method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/_try_get_value_string_object_.md

#### _try_get_value_string_object_

```python
def _try_get_value_string_object_(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

**Returns:** bool

### get_keys method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/get_keys.md

#### get_keys

```python
def get_keys(self):
    ...
```

### get_keys_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/set.md

#### set

```python
def set(self):
    ...
```

### set_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/try_get_value.md

#### try_get_value

```python
def try_get_value(self):
    ...
```

### try_get_value_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/try_get_value_file.md

#### try_get_value_file

```python
def try_get_value_file(self):
    ...
```

### try_get_value_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/icache/try_get_value_string.md

#### try_get_value_string

```python
def try_get_value_string(self):
    ...
```

### MemoryCache class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache.md

#### MemoryCache class

The MemoryCache type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_keys_string |  |
| _init_noargs |  |
| _set_string_object |  |
| _try_get_value_string_object_ |  |
| get_keys |  |
| get_keys_file |  |
| get_keys_string |  |
| set |  |
| set_file |  |
| set_string |  |
| try_get_value |  |
| try_get_value_file |  |
| try_get_value_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_keys_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/_get_keys_string.md

#### _get_keys_string

```python
def _get_keys_string(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `str` |  |

**Returns:** List[Any]

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _set_string_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/_set_string_object.md

#### _set_string_object

```python
def _set_string_object(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

### _try_get_value_string_object_ method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/_try_get_value_string_object_.md

#### _try_get_value_string_object_

```python
def _try_get_value_string_object_(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

**Returns:** bool

### get_keys method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/get_keys.md

#### get_keys

```python
def get_keys(self):
    ...
```

### get_keys_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/set.md

#### set

```python
def set(self):
    ...
```

### set_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/try_get_value.md

#### try_get_value

```python
def try_get_value(self):
    ...
```

### try_get_value_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/try_get_value_file.md

#### try_get_value_file

```python
def try_get_value_file(self):
    ...
```

### try_get_value_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.caching/memorycache/try_get_value_string.md

#### try_get_value_string

```python
def try_get_value_string(self):
    ...
```

### groupdocs.conversion.contracts
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts.md

Result, context, and data-transfer types returned by the API.

##### Classes
| Class | Description |
| :- | :- |
| `AudioDocumentInfo` |  |
| `BitmapInfo` |  |
| `Bzip2DocumentInfo` |  |
| `CabDocumentInfo` |  |
| `CadDocumentInfo` |  |
| `CgmDocumentInfo` |  |
| `CompressionNodeInfo` |  |
| `CpioDocumentInfo` |  |
| `CsvDocumentInfo` |  |
| `DiagramDocumentInfo` |  |
| `DjVuDocumentInfo` |  |
| `DocumentInfo` |  |
| `EmailDocumentInfo` |  |
| `Enumeration` |  |
| `EpsDocumentInfo` |  |
| `FlagsEnumeration` |  |
| `FontDocumentInfo` |  |
| `FontSubstitute` |  |
| `FontTransformation` |  |
| `GisDocumentInfo` |  |
| `GzipDocumentInfo` |  |
| `HeicDocumentInfo` |  |
| `ICompressionDocumentHierarchyInfo` |  |
| `IDocumentInfo` |  |
| `IDocumentsContainerLoadOptions` |  |
| `IcoDocumentInfo` |  |
| `ImageDocumentInfo` |  |
| `InlineXbrlDocumentInfo` |  |
| `IsoDocumentInfo` |  |
| `JsonDocumentInfo` |  |
| `LhaDocumentInfo` |  |
| `Lz4DocumentInfo` |  |
| `LzipDocumentInfo` |  |
| `LzmaDocumentInfo` |  |
| `NoteDocumentInfo` |  |
| `OlmDocumentInfo` |  |
| `OlmFolderInfo` |  |
| `PasswordProtectedDocumentInfo` |  |
| `PclDocumentInfo` |  |
| `PdfDocumentInfo` |  |
| `PersonalStorageDocumentInfo` |  |
| `PersonalStorageFolderInfo` |  |
| `PersonalStorageItemInfo` |  |
| `PixelFormat` |  |
| `PossibleConversions` |  |
| `PresentationDocumentInfo` |  |
| `ProjectManagementDocumentInfo` |  |
| `PsDocumentInfo` |  |
| `PsdDocumentInfo` |  |
| `PublisherDocumentInfo` |  |
| `RarDocumentInfo` |  |
| `Rectangle` |  |
| `SevenZipDocumentInfo` |  |
| `SpreadsheetDocumentInfo` |  |
| `SvgDocumentInfo` |  |
| `TableOfContentsItem` |  |
| `TarDocumentInfo` |  |
| `TargetConversion` |  |
| `TexDocumentInfo` |  |
| `ThreeDDocumentInfo` |  |
| `TsvDocumentInfo` |  |
| `TxtDocumentInfo` |  |
| `UueDocumentInfo` |  |
| `ValueObject` |  |
| `VcfDocumentInfo` |  |
| `VideoDocumentInfo` |  |
| `WebDocumentInfo` |  |
| `WordProcessingDocumentInfo` |  |
| `XbrlDocumentInfo` |  |
| `XmlDocumentInfo` |  |
| `XpsDocumentInfo` |  |
| `XslFoDocumentInfo` |  |
| `XzDocumentInfo` |  |
| `ZDocumentInfo` |  |
| `ZipDocumentInfo` |  |
| `ZstDocumentInfo` |  |

### AudioDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo.md

#### AudioDocumentInfo class

The AudioDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/audiodocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### BitmapInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo.md

#### BitmapInfo class

The BitmapInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| height |  |
| pixel_bytes |  |
| width |  |

### create method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo/create.md

#### create

```python
def create(cls, pixel_bytes, width, height, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pixel_bytes | `bytes` |  |
| width | `int` |  |
| height | `int` |  |
| format | `Any` |  |

**Returns:** BitmapInfo

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### pixel_bytes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo/pixel_bytes.md

##### Definition:
```python
@property
def pixel_bytes(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bitmapinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### Bzip2DocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo.md

#### Bzip2DocumentInfo class

The Bzip2DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/bzip2documentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### CabDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo.md

#### CabDocumentInfo class

The CabDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cabdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### CadDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo.md

#### CadDocumentInfo class

The CadDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| height |  |
| item |  |
| layers |  |
| layouts |  |
| pages_count |  |
| property_names |  |
| size |  |
| width |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### layers property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/layers.md

##### Definition:
```python
@property
def layers(self):
    ...
```

### layouts property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/layouts.md

##### Definition:
```python
@property
def layouts(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/caddocumentinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### CgmDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo.md

#### CgmDocumentInfo class

The CgmDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| author |  (inherited from `PdfDocumentInfo`) |
| height |  (inherited from `PdfDocumentInfo`) |
| is_landscape |  (inherited from `PdfDocumentInfo`) |
| is_password_protected |  (inherited from `PdfDocumentInfo`) |
| table_of_contents |  (inherited from `PdfDocumentInfo`) |
| title |  (inherited from `PdfDocumentInfo`) |
| version |  (inherited from `PdfDocumentInfo`) |
| width |  (inherited from `PdfDocumentInfo`) |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/height.md

#### height property

Gets page height

### is_landscape property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/is_landscape.md

#### is_landscape property

Gets is page landscaped

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/table_of_contents.md

#### table_of_contents property

Table of contents

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/title.md

#### title property

Gets title

### version property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/version.md

#### version property

Gets version

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cgmdocumentinfo/width.md

#### width property

Gets page width

### CompressionNodeInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo.md

#### CompressionNodeInfo class

The CompressionNodeInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| children |  |
| file_size |  |
| is_file |  |
| name |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### children property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo/children.md

##### Definition:
```python
@property
def children(self):
    ...
```

### file_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo/file_size.md

##### Definition:
```python
@property
def file_size(self):
    ...
@file_size.setter
def file_size(self, value):
    ...
```

### is_file property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo/is_file.md

##### Definition:
```python
@property
def is_file(self):
    ...
@is_file.setter
def is_file(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/compressionnodeinfo/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### CpioDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo.md

#### CpioDocumentInfo class

The CpioDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/cpiodocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### CsvDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo.md

#### CsvDocumentInfo class

The CsvDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| active_worksheet_index |  (inherited from `SpreadsheetDocumentInfo`) |
| author |  (inherited from `SpreadsheetDocumentInfo`) |
| is_password_protected |  (inherited from `SpreadsheetDocumentInfo`) |
| title |  (inherited from `SpreadsheetDocumentInfo`) |
| worksheets |  (inherited from `SpreadsheetDocumentInfo`) |
| worksheets_count |  (inherited from `SpreadsheetDocumentInfo`) |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/title.md

#### title property

Gets title

### worksheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/worksheets.md

#### worksheets property

Worksheets names

### worksheets_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/csvdocumentinfo/worksheets_count.md

#### worksheets_count property

Gets worksheets count

### DiagramDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo.md

#### DiagramDocumentInfo class

The DiagramDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/diagramdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### DjVuDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo.md

#### DjVuDocumentInfo class

The DjVuDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| horizontal_resolution |  |
| item |  |
| opacity |  |
| pages_count |  |
| property_names |  |
| size |  |
| vertical_resolution |  |
| bits_per_pixel |  (inherited from `ImageDocumentInfo`) |
| height |  (inherited from `ImageDocumentInfo`) |
| width |  (inherited from `ImageDocumentInfo`) |

### bits_per_pixel property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/bits_per_pixel.md

#### bits_per_pixel property

Gets bits per pixel

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/height.md

#### height property

Gets height

### horizontal_resolution property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/horizontal_resolution.md

##### Definition:
```python
@property
def horizontal_resolution(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/opacity.md

##### Definition:
```python
@property
def opacity(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### vertical_resolution property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/vertical_resolution.md

##### Definition:
```python
@property
def vertical_resolution(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/djvudocumentinfo/width.md

#### width property

Gets width

### DocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo.md

#### DocumentInfo class

The DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
@creation_date.setter
def creation_date(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/documentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### EmailDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo.md

#### EmailDocumentInfo class

The EmailDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| attachments_count |  |
| attachments_names |  |
| creation_date |  |
| format |  |
| is_encrypted |  |
| is_html |  |
| is_signed |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### attachments_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/attachments_count.md

##### Definition:
```python
@property
def attachments_count(self):
    ...
```

### attachments_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/attachments_names.md

##### Definition:
```python
@property
def attachments_names(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### is_html property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/is_html.md

##### Definition:
```python
@property
def is_html(self):
    ...
```

### is_signed property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/is_signed.md

##### Definition:
```python
@property
def is_signed(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/emaildocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### Enumeration class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration.md

#### Enumeration class

The Enumeration type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  |
| _equals_enumeration |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _to_string_noargs |  |
| compare_to |  |
| compare_to_object |  |
| equals |  |
| equals_enumeration |  |
| equals_object |  |
| from_display_name |  |
| from_value |  |
| get_all |  |
| get_hash_code |  |
| to_string |  |

### _compare_to_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/_compare_to_object.md

#### _compare_to_object

```python
def _compare_to_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** int

### _equals_enumeration method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/_equals_enumeration.md

#### _equals_enumeration

```python
def _equals_enumeration(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Enumeration` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/compare_to.md

#### compare_to

```python
def compare_to(self):
    ...
```

### compare_to_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/compare_to_object.md

#### compare_to_object

```python
def compare_to_object(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_enumeration method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/equals_enumeration.md

#### equals_enumeration

```python
def equals_enumeration(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### from_display_name method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/from_display_name.md

#### from_display_name

```python
def from_display_name(cls, display_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| display_name | `str` |  |

**Returns:** Any

### from_value method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/from_value.md

#### from_value

```python
def from_value(cls, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `str` |  |

**Returns:** Any

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/get_all.md

#### get_all

```python
def get_all(cls):
    ...
```

**Returns:** Any

### get_hash_code method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/enumeration/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### EpsDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo.md

#### EpsDocumentInfo class

The EpsDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| bits_per_pixel |  (inherited from `ImageDocumentInfo`) |
| height |  (inherited from `ImageDocumentInfo`) |
| width |  (inherited from `ImageDocumentInfo`) |

### bits_per_pixel property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/bits_per_pixel.md

#### bits_per_pixel property

Gets bits per pixel

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/height.md

#### height property

Gets height

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epsdocumentinfo/width.md

#### width property

Gets width

### EpubDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo.md

#### EpubDocumentInfo class

Contains Epub document metadata

**Inheritance:** `EpubDocumentInfo` →
`PdfDocumentInfo` →
`DocumentInfo`

The EpubDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages_count | Implements `IDocumentInfo.pages_count` |
| format | Implements `IDocumentInfo.format` |
| size | Implements `IDocumentInfo.size` |
| creation_date | Implements `IDocumentInfo.creation_date` |
| property_names | Implements `IDocumentInfo.property_names` |
| version | Gets version |
| title | Gets title |
| author | Gets author |
| is_password_protected | Gets is document password protected |
| is_landscape | Gets is page landscaped |
| height | Gets page height |
| width | Gets page width |
| table_of_contents | Table of contents |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/creation_date.md

#### creation_date property

Implements `IDocumentInfo.creation_date`

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/format.md

#### format property

Implements `IDocumentInfo.format`

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/height.md

#### height property

Gets page height

### is_landscape property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/is_landscape.md

#### is_landscape property

Gets is page landscaped

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/pages_count.md

#### pages_count property

Implements `IDocumentInfo.pages_count`

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/property_names.md

#### property_names property

Implements `IDocumentInfo.property_names`

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/size.md

#### size property

Implements `IDocumentInfo.size`

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/table_of_contents.md

#### table_of_contents property

Table of contents

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/title.md

#### title property

Gets title

### version property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/version.md

#### version property

Gets version

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/epubdocumentinfo/width.md

#### width property

Gets page width

### FlagsEnumeration class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration.md

#### FlagsEnumeration class

The FlagsEnumeration type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _has_flag_arg |  |
| _has_flag_value_int32 |  |
| _to_string_noargs |  |
| combine |  |
| has_flag |  |
| has_flag_value |  |
| has_flag_value_int32 |  |
| to_string |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |

### _has_flag_arg method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/_has_flag_arg.md

#### _has_flag_arg

```python
def _has_flag_arg(self, flag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| flag | `Any` |  |

**Returns:** bool

### _has_flag_value_int32 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/_has_flag_value_int32.md

#### _has_flag_value_int32

```python
def _has_flag_value_int32(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `int` |  |

**Returns:** bool

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### combine method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/combine.md

#### combine

```python
def combine(cls, left, right):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | `Any` |  |
| right | `Any` |  |

**Returns:** Any

### has_flag method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/has_flag.md

#### has_flag

```python
def has_flag(self):
    ...
```

### has_flag_value method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/has_flag_value.md

#### has_flag_value

```python
def has_flag_value(self):
    ...
```

### has_flag_value_int32 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/has_flag_value_int32.md

#### has_flag_value_int32

```python
def has_flag_value_int32(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/flagsenumeration/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### FontDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo.md

#### FontDocumentInfo class

The FontDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### FontSubstitute class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontsubstitute.md

#### FontSubstitute class

The FontSubstitute type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| original_font_name |  |
| substitute_font_name |  |

### create method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontsubstitute/create.md

#### create

```python
def create(cls, original_font, substitute_with):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| original_font | `str` |  |
| substitute_with | `str` |  |

**Returns:** FontSubstitute

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontsubstitute/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### original_font_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontsubstitute/original_font_name.md

##### Definition:
```python
@property
def original_font_name(self):
    ...
```

### substitute_font_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fontsubstitute/substitute_font_name.md

##### Definition:
```python
@property
def substitute_font_name(self):
    ...
```

### FontTransformation class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation.md

#### FontTransformation class

The FontTransformation type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create |  |
| create_by_name |  |
| create_flexible |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| match_any_size |  |
| match_any_style |  |
| original_font |  |
| replacement_font |  |

### create method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/create.md

#### create

```python
def create(cls, original_font, replacement_font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| original_font | `Font` |  |
| replacement_font | `Font` |  |

**Returns:** FontTransformation

### create_by_name method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/create_by_name.md

#### create_by_name

```python
def create_by_name(cls, original_font_name, replacement_font_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| original_font_name | `str` |  |
| replacement_font_name | `str` |  |

**Returns:** FontTransformation

### create_flexible method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/create_flexible.md

#### create_flexible

```python
def create_flexible(cls, original_font, replacement_font, match_any_size, match_any_style):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| original_font | `Font` |  |
| replacement_font | `Font` |  |
| match_any_size | `bool` |  |
| match_any_style | `bool` |  |

**Returns:** FontTransformation

### match_any_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/match_any_size.md

##### Definition:
```python
@property
def match_any_size(self):
    ...
```

### match_any_style property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/match_any_style.md

##### Definition:
```python
@property
def match_any_style(self):
    ...
```

### original_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/original_font.md

##### Definition:
```python
@property
def original_font(self):
    ...
```

### replacement_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/fonttransformation/replacement_font.md

##### Definition:
```python
@property
def replacement_font(self):
    ...
```

### GisDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo.md

#### GisDocumentInfo class

The GisDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gisdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### GzipDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo.md

#### GzipDocumentInfo class

The GzipDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/gzipdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### HeicDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo.md

#### HeicDocumentInfo class

The HeicDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| bits_per_pixel |  (inherited from `ImageDocumentInfo`) |
| height |  (inherited from `ImageDocumentInfo`) |
| width |  (inherited from `ImageDocumentInfo`) |

### bits_per_pixel property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/bits_per_pixel.md

#### bits_per_pixel property

Gets bits per pixel

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/height.md

#### height property

Gets height

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/heicdocumentinfo/width.md

#### width property

Gets width

### IcoDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo.md

#### IcoDocumentInfo class

The IcoDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| bits_per_pixel |  (inherited from `ImageDocumentInfo`) |
| height |  (inherited from `ImageDocumentInfo`) |
| width |  (inherited from `ImageDocumentInfo`) |

### bits_per_pixel property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/bits_per_pixel.md

#### bits_per_pixel property

Gets bits per pixel

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/height.md

#### height property

Gets height

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icodocumentinfo/width.md

#### width property

Gets width

### ICompressionDocumentHierarchyInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icompressiondocumenthierarchyinfo.md

#### ICompressionDocumentHierarchyInfo class

The ICompressionDocumentHierarchyInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/icompressiondocumenthierarchyinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### IDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo.md

#### IDocumentInfo class

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### IDocumentsContainerLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentscontainerloadoptions.md

#### IDocumentsContainerLoadOptions class

The IDocumentsContainerLoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| convert_owned |  |
| convert_owner |  |
| depth |  |

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
```

### ImageDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo.md

#### ImageDocumentInfo class

The ImageDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| bits_per_pixel |  |
| creation_date |  |
| format |  |
| height |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| width |  |

### bits_per_pixel property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/bits_per_pixel.md

##### Definition:
```python
@property
def bits_per_pixel(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/imagedocumentinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### InlineXbrlDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo.md

#### InlineXbrlDocumentInfo class

The InlineXbrlDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/inlinexbrldocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### IsoDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo.md

#### IsoDocumentInfo class

The IsoDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/isodocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### JsonDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo.md

#### JsonDocumentInfo class

The JsonDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/jsondocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### LhaDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo.md

#### LhaDocumentInfo class

The LhaDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lhadocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### Lz4DocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo.md

#### Lz4DocumentInfo class

The Lz4DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lz4documentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### LzipDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo.md

#### LzipDocumentInfo class

The LzipDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzipdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### LzmaDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo.md

#### LzmaDocumentInfo class

The LzmaDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/lzmadocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### NoteDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo.md

#### NoteDocumentInfo class

The NoteDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| title |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/notedocumentinfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### OlmDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo.md

#### OlmDocumentInfo class

The OlmDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| folders |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/folders.md

##### Definition:
```python
@property
def folders(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### OlmFolderInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmfolderinfo.md

#### OlmFolderInfo class

The OlmFolderInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  |
| to_string |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| items_count |  |
| name |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmfolderinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmfolderinfo/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### items_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmfolderinfo/items_count.md

##### Definition:
```python
@property
def items_count(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmfolderinfo/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/olmfolderinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### PasswordProtectedDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo.md

#### PasswordProtectedDocumentInfo class

The PasswordProtectedDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| is_password_protected |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/is_password_protected.md

##### Definition:
```python
@property
def is_password_protected(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/passwordprotecteddocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### PclDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo.md

#### PclDocumentInfo class

The PclDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pcldocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### PdfDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo.md

#### PdfDocumentInfo class

The PdfDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| author |  |
| creation_date |  |
| format |  |
| height |  |
| is_landscape |  |
| is_password_protected |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| table_of_contents |  |
| title |  |
| version |  |
| width |  |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/author.md

##### Definition:
```python
@property
def author(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### is_landscape property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/is_landscape.md

##### Definition:
```python
@property
def is_landscape(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/is_password_protected.md

##### Definition:
```python
@property
def is_password_protected(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/table_of_contents.md

##### Definition:
```python
@property
def table_of_contents(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### version property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/version.md

##### Definition:
```python
@property
def version(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pdfdocumentinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### PersonalStorageDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo.md

#### PersonalStorageDocumentInfo class

The PersonalStorageDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_count |  |
| creation_date |  |
| folders |  |
| format |  |
| is_password_protected |  |
| item |  |
| pages_count |  |
| property_names |  |
| root_folder_name |  |
| size |  |

### content_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/content_count.md

##### Definition:
```python
@property
def content_count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/folders.md

##### Definition:
```python
@property
def folders(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/is_password_protected.md

##### Definition:
```python
@property
def is_password_protected(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### root_folder_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/root_folder_name.md

##### Definition:
```python
@property
def root_folder_name(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragedocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### PersonalStorageFolderInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo.md

#### PersonalStorageFolderInfo class

The PersonalStorageFolderInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  |
| to_string |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| items |  |
| items_count |  |
| name |  |
| sub_folders |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### items property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/items.md

##### Definition:
```python
@property
def items(self):
    ...
```

### items_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/items_count.md

##### Definition:
```python
@property
def items_count(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### sub_folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/sub_folders.md

##### Definition:
```python
@property
def sub_folders(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstoragefolderinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### PersonalStorageItemInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo.md

#### PersonalStorageItemInfo class

The PersonalStorageItemInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| attachments_count |  |
| bcc |  |
| cc |  |
| from_ |  |
| sent |  |
| size |  |
| subject |  |
| title |  |
| to |  |

### attachments_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/attachments_count.md

##### Definition:
```python
@property
def attachments_count(self):
    ...
```

### bcc property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/bcc.md

##### Definition:
```python
@property
def bcc(self):
    ...
```

### cc property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/cc.md

##### Definition:
```python
@property
def cc(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### from_ property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/from_.md

##### Definition:
```python
@property
def from_(self):
    ...
```

### from_address property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/from_address.md

#### from_address property

Item From
##### Definition:
```python
@property
def from_address(self):
    ...
```

### sent property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/sent.md

##### Definition:
```python
@property
def sent(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### subject property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/subject.md

##### Definition:
```python
@property
def subject(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### to property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/personalstorageiteminfo/to.md

##### Definition:
```python
@property
def to(self):
    ...
```

### PixelFormat class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat.md

#### PixelFormat class

The PixelFormat type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Argb32 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/argb32.md

### Bgr24 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/bgr24.md

### Bgra32 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/bgra32.md

### Rgb24 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/rgb24.md

### Rgba32 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/pixelformat/rgba32.md

### PossibleConversions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions.md

#### PossibleConversions class

The PossibleConversions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| all |  |
| item |  |
| item |  |
| load_options |  |
| primary |  |
| secondary |  |
| source |  |

### all property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/all.md

##### Definition:
```python
@property
def all(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### load_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/load_options.md

##### Definition:
```python
@property
def load_options(self):
    ...
```

### primary property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/primary.md

##### Definition:
```python
@property
def primary(self):
    ...
```

### secondary property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/secondary.md

##### Definition:
```python
@property
def secondary(self):
    ...
```

### source property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/possibleconversions/source.md

##### Definition:
```python
@property
def source(self):
    ...
```

### PresentationDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo.md

#### PresentationDocumentInfo class

The PresentationDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| author |  |
| creation_date |  |
| format |  |
| is_password_protected |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| title |  |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/author.md

##### Definition:
```python
@property
def author(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/is_password_protected.md

##### Definition:
```python
@property
def is_password_protected(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/presentationdocumentinfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### ProjectManagementDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo.md

#### ProjectManagementDocumentInfo class

The ProjectManagementDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| end_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| start_date |  |
| tasks_count |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### end_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/end_date.md

##### Definition:
```python
@property
def end_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### start_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/start_date.md

##### Definition:
```python
@property
def start_date(self):
    ...
```

### tasks_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/projectmanagementdocumentinfo/tasks_count.md

##### Definition:
```python
@property
def tasks_count(self):
    ...
```

### PsdDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo.md

#### PsdDocumentInfo class

The PsdDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| bits_per_pixel |  |
| creation_date |  |
| format |  |
| height |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| width |  |

### bits_per_pixel property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/bits_per_pixel.md

##### Definition:
```python
@property
def bits_per_pixel(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psddocumentinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### PsDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo.md

#### PsDocumentInfo class

The PsDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/psdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### PublisherDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo.md

#### PublisherDocumentInfo class

The PublisherDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/publisherdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### RarDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo.md

#### RarDocumentInfo class

The RarDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rardocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### Rectangle class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle.md

#### Rectangle class

The Rectangle type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _crop_int32_int32_int32_int32 |  |
| _init_int32_int32_int32_int32 |  |
| _to_string_noargs |  |
| crop |  |
| crop_int32 |  |
| to_string |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| bottom |  |
| height |  |
| left |  |
| right |  |
| top |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _crop_int32_int32_int32_int32 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/_crop_int32_int32_int32_int32.md

#### _crop_int32_int32_int32_int32

```python
def _crop_int32_int32_int32_int32(self, crop_left, crop_top, crop_right, crop_bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| crop_left | `int` |  |
| crop_top | `int` |  |
| crop_right | `int` |  |
| crop_bottom | `int` |  |

**Returns:** Rectangle

### _init_int32_int32_int32_int32 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/_init_int32_int32_int32_int32.md

#### _init_int32_int32_int32_int32

```python
def _init_int32_int32_int32_int32(self, left, top, right, bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | `int` |  |
| top | `int` |  |
| right | `int` |  |
| bottom | `int` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### bottom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/bottom.md

##### Definition:
```python
@property
def bottom(self):
    ...
```

### crop method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/crop.md

#### crop

```python
def crop(self):
    ...
```

### crop_int32 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/crop_int32.md

#### crop_int32

```python
def crop_int32(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/left.md

##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/right.md

##### Definition:
```python
@property
def right(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/top.md

##### Definition:
```python
@property
def top(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/rectangle/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### SevenZipDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo.md

#### SevenZipDocumentInfo class

The SevenZipDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/sevenzipdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### SpreadsheetDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo.md

#### SpreadsheetDocumentInfo class

The SpreadsheetDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| active_worksheet_index |  |
| author |  |
| creation_date |  |
| format |  |
| is_password_protected |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| title |  |
| worksheets |  |
| worksheets_count |  |

### active_worksheet_index property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/active_worksheet_index.md

##### Definition:
```python
@property
def active_worksheet_index(self):
    ...
```

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/author.md

##### Definition:
```python
@property
def author(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/is_password_protected.md

##### Definition:
```python
@property
def is_password_protected(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### worksheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/worksheets.md

##### Definition:
```python
@property
def worksheets(self):
    ...
```

### worksheets_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/spreadsheetdocumentinfo/worksheets_count.md

##### Definition:
```python
@property
def worksheets_count(self):
    ...
```

### SvgDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo.md

#### SvgDocumentInfo class

The SvgDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/svgdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### TableOfContentsItem class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tableofcontentsitem.md

#### TableOfContentsItem class

The TableOfContentsItem type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page |  |
| title |  |

### page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tableofcontentsitem/page.md

##### Definition:
```python
@property
def page(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tableofcontentsitem/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### TarDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo.md

#### TarDocumentInfo class

The TarDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tardocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### TargetConversion class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/targetconversion.md

#### TargetConversion class

The TargetConversion type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| convert_options |  |
| format |  |
| is_primary |  |

### convert_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/targetconversion/convert_options.md

##### Definition:
```python
@property
def convert_options(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/targetconversion/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_primary property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/targetconversion/is_primary.md

##### Definition:
```python
@property
def is_primary(self):
    ...
```

### TexDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo.md

#### TexDocumentInfo class

The TexDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/texdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### ThreeDDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo.md

#### ThreeDDocumentInfo class

The ThreeDDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/threeddocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### TsvDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo.md

#### TsvDocumentInfo class

The TsvDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| active_worksheet_index |  (inherited from `SpreadsheetDocumentInfo`) |
| author |  (inherited from `SpreadsheetDocumentInfo`) |
| is_password_protected |  (inherited from `SpreadsheetDocumentInfo`) |
| title |  (inherited from `SpreadsheetDocumentInfo`) |
| worksheets |  (inherited from `SpreadsheetDocumentInfo`) |
| worksheets_count |  (inherited from `SpreadsheetDocumentInfo`) |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/title.md

#### title property

Gets title

### worksheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/worksheets.md

#### worksheets property

Worksheets names

### worksheets_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/tsvdocumentinfo/worksheets_count.md

#### worksheets_count property

Gets worksheets count

### TxtDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo.md

#### TxtDocumentInfo class

The TxtDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| author |  (inherited from `WordProcessingDocumentInfo`) |
| is_password_protected |  (inherited from `WordProcessingDocumentInfo`) |
| lines |  (inherited from `WordProcessingDocumentInfo`) |
| table_of_contents |  (inherited from `WordProcessingDocumentInfo`) |
| title |  (inherited from `WordProcessingDocumentInfo`) |
| words |  (inherited from `WordProcessingDocumentInfo`) |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### lines property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/lines.md

#### lines property

Gets lines count

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/table_of_contents.md

#### table_of_contents property

Table of contents

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/title.md

#### title property

Gets title

### words property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/txtdocumentinfo/words.md

#### words property

Gets words count

### UueDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo.md

#### UueDocumentInfo class

The UueDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/uuedocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### ValueObject class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject.md

#### ValueObject class

The ValueObject type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  |
| _equals_value_object |  |
| _get_hash_code_noargs |  |
| equals |  |
| equals_object |  |
| equals_value_object |  |
| get_hash_code |  |

### _equals_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _equals_value_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/_equals_value_object.md

#### _equals_value_object

```python
def _equals_value_object(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `ValueObject` |  |

**Returns:** bool

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_value_object method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/equals_value_object.md

#### equals_value_object

```python
def equals_value_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/valueobject/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### VcfDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo.md

#### VcfDocumentInfo class

The VcfDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| contacts_count |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### contacts_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/contacts_count.md

##### Definition:
```python
@property
def contacts_count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/vcfdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### VideoDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo.md

#### VideoDocumentInfo class

The VideoDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/videodocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### WebDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo.md

#### WebDocumentInfo class

The WebDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| encoding |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/webdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### WordProcessingDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo.md

#### WordProcessingDocumentInfo class

The WordProcessingDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| author |  |
| creation_date |  |
| format |  |
| is_password_protected |  |
| item |  |
| lines |  |
| pages_count |  |
| property_names |  |
| size |  |
| table_of_contents |  |
| title |  |
| words |  |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/author.md

##### Definition:
```python
@property
def author(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/is_password_protected.md

##### Definition:
```python
@property
def is_password_protected(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### lines property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/lines.md

##### Definition:
```python
@property
def lines(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/table_of_contents.md

##### Definition:
```python
@property
def table_of_contents(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
```

### words property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/wordprocessingdocumentinfo/words.md

##### Definition:
```python
@property
def words(self):
    ...
```

### XbrlDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo.md

#### XbrlDocumentInfo class

The XbrlDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xbrldocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### XmlDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo.md

#### XmlDocumentInfo class

The XmlDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xmldocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### XpsDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo.md

#### XpsDocumentInfo class

The XpsDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| author |  (inherited from `PdfDocumentInfo`) |
| height |  (inherited from `PdfDocumentInfo`) |
| is_landscape |  (inherited from `PdfDocumentInfo`) |
| is_password_protected |  (inherited from `PdfDocumentInfo`) |
| table_of_contents |  (inherited from `PdfDocumentInfo`) |
| title |  (inherited from `PdfDocumentInfo`) |
| version |  (inherited from `PdfDocumentInfo`) |
| width |  (inherited from `PdfDocumentInfo`) |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/height.md

#### height property

Gets page height

### is_landscape property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/is_landscape.md

#### is_landscape property

Gets is page landscaped

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/table_of_contents.md

#### table_of_contents property

Table of contents

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/title.md

#### title property

Gets title

### version property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/version.md

#### version property

Gets version

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xpsdocumentinfo/width.md

#### width property

Gets page width

### XslFoDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo.md

#### XslFoDocumentInfo class

The XslFoDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |
| author |  (inherited from `PdfDocumentInfo`) |
| height |  (inherited from `PdfDocumentInfo`) |
| is_landscape |  (inherited from `PdfDocumentInfo`) |
| is_password_protected |  (inherited from `PdfDocumentInfo`) |
| table_of_contents |  (inherited from `PdfDocumentInfo`) |
| title |  (inherited from `PdfDocumentInfo`) |
| version |  (inherited from `PdfDocumentInfo`) |
| width |  (inherited from `PdfDocumentInfo`) |

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/author.md

#### author property

Gets author

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/height.md

#### height property

Gets page height

### is_landscape property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/is_landscape.md

#### is_landscape property

Gets is page landscaped

### is_password_protected property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/is_password_protected.md

#### is_password_protected property

Gets is document password protected

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/table_of_contents.md

#### table_of_contents property

Table of contents

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/title.md

#### title property

Gets title

### version property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/version.md

#### version property

Gets version

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xslfodocumentinfo/width.md

#### width property

Gets page width

### XzDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo.md

#### XzDocumentInfo class

The XzDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/xzdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### ZDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo.md

#### ZDocumentInfo class

The ZDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### ZipDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo.md

#### ZipDocumentInfo class

The ZipDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| content_tree |  |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### content_tree property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/content_tree.md

##### Definition:
```python
@property
def content_tree(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zipdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### ZstDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo.md

#### ZstDocumentInfo class

The ZstDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| creation_date |  |
| format |  |
| item |  |
| pages_count |  |
| property_names |  |
| size |  |

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
```

### property_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo/property_names.md

##### Definition:
```python
@property
def property_names(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.contracts/zstdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### groupdocs.conversion.exceptions
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions.md

The module provides different exceptions classes.

##### Classes
| Class | Description |
| :- | :- |
| `ConversionNotSupportedException` | GroupDocs exception thrown when the conversion from source file to target file type is not supported |
| `CorruptOrDamagedFileException` | GroupDocs exception thrown when the file is corrupt or damaged |
| `FileTypeNotSupportedException` | GroupDocs exception thrown when the file type is not supported |
| `FontSubstituteException` | Thrown if font substitute is illegal |
| `GroupDocsConversionException` | GroupDocs.Conversion general exception |
| `IncorrectPasswordException` | GroupDocs exception thrown when the file is password protected, password is provided but is incorrect |
| `InvalidConvertOptionsException` | Thrown if provided convert options are invalid |
| `InvalidConverterSettingsException` | Thrown if provided converter settings are invalid |
| `PasswordRequiredException` | GroupDocs exception thrown when the file is password protected and password is not provided |
| `SourceDocumentFactoryNotProvidedException` | GroupDocs exception thrown when the source document factory is not provided |

### ConversionNotSupportedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/conversionnotsupportedexception.md

#### ConversionNotSupportedException class

GroupDocs exception thrown when the conversion from source file to target file type is not supported

**Inheritance:** `ConversionNotSupportedException` →
`GroupDocsConversionException`

The ConversionNotSupportedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates an exception instance with a message |

### ConversionNotSupportedException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/conversionnotsupportedexception/__init__.md

#### __init__

Creates an exception instance with a message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### CorruptOrDamagedFileException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/corruptordamagedfileexception.md

#### CorruptOrDamagedFileException class

GroupDocs exception thrown when the file is corrupt or damaged

**Inheritance:** `CorruptOrDamagedFileException` →
`GroupDocsConversionException`

The CorruptOrDamagedFileException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception instance with a FileType |
| __init__ | Creates an exception instance with a message |

### CorruptOrDamagedFileException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/corruptordamagedfileexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception instance with a FileType

```python
def __init__(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.conversion.filetypes.FileType | The file type |

#### __init__

Creates an exception instance with a message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### FileTypeNotSupportedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

GroupDocs exception thrown when the file type is not supported

**Inheritance:** `FileTypeNotSupportedException` →
`GroupDocsConversionException`

The FileTypeNotSupportedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception instance with a FileType |
| __init__ | Creates an exception instance with a message |

### FileTypeNotSupportedException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/filetypenotsupportedexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception instance with a FileType

```python
def __init__(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.conversion.filetypes.FileType | The file type |

#### __init__

Creates an exception instance with a message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### FontSubstituteException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/fontsubstituteexception.md

#### FontSubstituteException class

Thrown if font substitute is illegal

**Inheritance:** `FontSubstituteException` →
`GroupDocsConversionException`

The FontSubstituteException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception with a specific message |

### FontSubstituteException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/fontsubstituteexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception with a specific message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### GroupDocsConversionException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/groupdocsconversionexception.md

#### GroupDocsConversionException class

GroupDocs.Conversion general exception

The GroupDocsConversionException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception with a specific message |

### GroupDocsConversionException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/groupdocsconversionexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception with a specific message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

GroupDocs exception thrown when the file is password protected, password is provided but is incorrect

**Inheritance:** `IncorrectPasswordException` →
`GroupDocsConversionException`

The IncorrectPasswordException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception instance with a FileType |
| __init__ | Creates an exception instance with a message |

### IncorrectPasswordException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/incorrectpasswordexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception instance with a FileType

```python
def __init__(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.conversion.filetypes.FileType | The file type |

#### __init__

Creates an exception instance with a message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### InvalidConverterSettingsException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/invalidconvertersettingsexception.md

#### InvalidConverterSettingsException class

Thrown if provided converter settings are invalid

**Inheritance:** `InvalidConverterSettingsException` →
`GroupDocsConversionException`

The InvalidConverterSettingsException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception with a specific message |

### InvalidConverterSettingsException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/invalidconvertersettingsexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception with a specific message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### InvalidConvertOptionsException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/invalidconvertoptionsexception.md

#### InvalidConvertOptionsException class

Thrown if provided convert options are invalid

**Inheritance:** `InvalidConvertOptionsException` →
`GroupDocsConversionException`

The InvalidConvertOptionsException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception with a specific message |

### InvalidConvertOptionsException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/invalidconvertoptionsexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception with a specific message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### PasswordRequiredException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

GroupDocs exception thrown when the file is password protected and password is not provided

**Inheritance:** `PasswordRequiredException` →
`GroupDocsConversionException`

The PasswordRequiredException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default constructor |
| __init__ | Creates an exception instance with a FileType |
| __init__ | Creates an exception instance with a message |

### PasswordRequiredException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/passwordrequiredexception/__init__.md

#### __init__

Default constructor

```python
def __init__(self):
    ...
```

#### __init__

Creates an exception instance with a FileType

```python
def __init__(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.conversion.filetypes.FileType | The file type |

#### __init__

Creates an exception instance with a message

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message |

### SourceDocumentFactoryNotProvidedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/sourcedocumentfactorynotprovidedexception.md

#### SourceDocumentFactoryNotProvidedException class

GroupDocs exception thrown when the source document factory is not provided

**Inheritance:** `SourceDocumentFactoryNotProvidedException` →
`GroupDocsConversionException`

The SourceDocumentFactoryNotProvidedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates an exception instance with a message |

### SourceDocumentFactoryNotProvidedException constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.exceptions/sourcedocumentfactorynotprovidedexception/__init__.md

#### __init__

Creates an exception instance with a message

```python
def __init__(self):
    ...
```

### groupdocs.conversion.file_types
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types.md

Types under `groupdocs.conversion.file_types`.

##### Classes
| Class | Description |
| :- | :- |
| `AudioFileType` |  |
| `CadFileType` |  |
| `CompressionFileType` |  |
| `DatabaseFileType` |  |
| `DiagramFileType` |  |
| `EBookFileType` |  |
| `EmailFileType` |  |
| `FileType` |  |
| `FinanceFileType` |  |
| `FontFileType` |  |
| `GisFileType` |  |
| `ImageFileType` |  |
| `NoteFileType` |  |
| `PageDescriptionLanguageFileType` |  |
| `PdfFileType` |  |
| `PresentationFileType` |  |
| `ProjectManagementFileType` |  |
| `PublisherFileType` |  |
| `SpreadsheetFileType` |  |
| `ThreeDFileType` |  |
| `VideoFileType` |  |
| `WebFileType` |  |
| `WordProcessingFileType` |  |

### AudioFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/audiofiletype.md

#### AudioFileType class

The AudioFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/audiofiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/audiofiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### CadFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/cadfiletype.md

#### CadFileType class

The CadFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/cadfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/cadfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### CompressionFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/compressionfiletype.md

#### CompressionFileType class

The CompressionFileType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _init_noargs |  (inherited from `FileType`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| is_multi_file_archive |  |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### is_multi_file_archive property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/compressionfiletype/is_multi_file_archive.md

##### Definition:
```python
@property
def is_multi_file_archive(self):
    ...
```

### DatabaseFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/databasefiletype.md

#### DatabaseFileType class

The DatabaseFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/databasefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/databasefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### DiagramFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/diagramfiletype.md

#### DiagramFileType class

The DiagramFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/diagramfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/diagramfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### EBookFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/ebookfiletype.md

#### EBookFileType class

The EBookFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/ebookfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/ebookfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### EmailFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/emailfiletype.md

#### EmailFileType class

The EmailFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/emailfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/emailfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### FileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype.md

#### FileType class

The FileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_enumeration |  |
| _init_noargs |  |
| _to_string_noargs |  |
| equals |  |
| from_extension |  |
| from_filename |  |
| from_stream |  |
| get_all |  |
| to_string |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| extension |  |
| family |  |
| file_format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_enumeration method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/_equals_enumeration.md

#### _equals_enumeration

```python
def _equals_enumeration(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Enumeration` |  |

**Returns:** bool

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/equals.md

#### equals

```python
def equals(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/family.md

##### Definition:
```python
@property
def family(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/from_extension.md

#### from_extension

```python
def from_extension(cls, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | `str` |  |

**Returns:** FileType

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/from_filename.md

#### from_filename

```python
def from_filename(cls, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

**Returns:** FileType

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/from_stream.md

#### from_stream

```python
def from_stream(cls, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

**Returns:** FileType

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/get_all.md

#### get_all

```python
def get_all(cls):
    ...
```

**Returns:** List[Any]

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### FinanceFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/financefiletype.md

#### FinanceFileType class

The FinanceFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/financefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/financefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### FontFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/fontfiletype.md

#### FontFileType class

The FontFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/fontfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/fontfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### GisFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/gisfiletype.md

#### GisFileType class

The GisFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/gisfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/gisfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### ImageFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/imagefiletype.md

#### ImageFileType class

The ImageFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| is_raster |  |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/imagefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/imagefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### is_raster property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/imagefiletype/is_raster.md

##### Definition:
```python
@property
def is_raster(self):
    ...
```

### NoteFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/notefiletype.md

#### NoteFileType class

The NoteFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/notefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/notefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### PageDescriptionLanguageFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/pagedescriptionlanguagefiletype.md

#### PageDescriptionLanguageFileType class

The PageDescriptionLanguageFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/pagedescriptionlanguagefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/pagedescriptionlanguagefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### PdfFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/pdffiletype.md

#### PdfFileType class

The PdfFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/pdffiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/pdffiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### PresentationFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/presentationfiletype.md

#### PresentationFileType class

The PresentationFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/presentationfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/presentationfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### ProjectManagementFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/projectmanagementfiletype.md

#### ProjectManagementFileType class

The ProjectManagementFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/projectmanagementfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/projectmanagementfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### PublisherFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/publisherfiletype.md

#### PublisherFileType class

The PublisherFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/publisherfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/publisherfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### SpreadsheetFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/spreadsheetfiletype.md

#### SpreadsheetFileType class

The SpreadsheetFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/spreadsheetfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/spreadsheetfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### ThreeDFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/threedfiletype.md

#### ThreeDFileType class

The ThreeDFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/threedfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/threedfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### VideoFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/videofiletype.md

#### VideoFileType class

The VideoFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/videofiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/videofiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### WebFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/webfiletype.md

#### WebFileType class

The WebFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/webfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/webfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### WordProcessingFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/wordprocessingfiletype.md

#### WordProcessingFileType class

The WordProcessingFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/wordprocessingfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.file_types/wordprocessingfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### groupdocs.conversion.filetypes
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes.md

File type constants and format identifiers.

##### Classes
| Class | Description |
| :- | :- |
| `AudioFileType` |  |
| `CadFileType` |  |
| `CompressionFileType` |  |
| `DatabaseFileType` |  |
| `DiagramFileType` |  |
| `EBookFileType` |  |
| `EmailFileType` |  |
| `FileType` |  |
| `FinanceFileType` |  |
| `FontFileType` |  |
| `GisFileType` |  |
| `ImageFileType` |  |
| `NoteFileType` |  |
| `PageDescriptionLanguageFileType` |  |
| `PdfFileType` |  |
| `PresentationFileType` |  |
| `ProjectManagementFileType` |  |
| `PublisherFileType` |  |
| `SpreadsheetFileType` |  |
| `ThreeDFileType` |  |
| `VideoFileType` |  |
| `WebFileType` |  |
| `WordProcessingFileType` |  |

### AudioFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype.md

#### AudioFileType class

The AudioFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Aac field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/aac.md

### Ac3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/ac3.md

### Aiff field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/aiff.md

### Flac field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/flac.md

### M4a field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/m4a.md

### Mp3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/mp3.md

### Ogg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/ogg.md

### Wav field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/wav.md

### Wma field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/audiofiletype/wma.md

### CadFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype.md

#### CadFileType class

The CadFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Cf2 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/cf2.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/description.md

#### description property

File type description

### Dgn field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/dgn.md

### Dwf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/dwf.md

### Dwfx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/dwfx.md

### Dwg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/dwg.md

### Dwt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/dwt.md

### Dxf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/dxf.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Ifc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/ifc.md

### Igs field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/igs.md

### Plt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/plt.md

### Stl field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/stl.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/cadfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### CompressionFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype.md

#### CompressionFileType class

The CompressionFileType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _init_noargs |  (inherited from `FileType`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| is_multi_file_archive |  |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### CompressionFileType constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### Bz2 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/bz2.md

### Cab field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/cab.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Cpio field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/cpio.md

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Gz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/gz.md

### Gzip field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/gzip.md

### is_multi_file_archive property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/is_multi_file_archive.md

##### Definition:
```python
@property
def is_multi_file_archive(self):
    ...
```

### Iso field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/iso.md

### Lha field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/lha.md

### Lz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/lz.md

### Lz4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/lz4.md

### Lzma field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/lzma.md

### Rar field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/rar.md

### SEVEN_Z property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/seven_z.md

#### SEVEN_Z property

7z is an archiving format for compressing files and folders with a high compression ratio. It is based on Open Source architecture which makes it possible to use any compression and encryption algorithms.
Learn more about this file format [here](https://docs.fileformat.com/compression/7z/).

### SevenZ field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/sevenz.md

### Tar field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/tar.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Uue field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/uue.md

### Xz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/xz.md

### Z field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/z.md

### Zip field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/zip.md

### Zst field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/compressionfiletype/zst.md

### DatabaseFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype.md

#### DatabaseFileType class

The DatabaseFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Log field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/log.md

### Nsf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/nsf.md

### Sql field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/sql.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/databasefiletype/unknown.md

#### UNKNOWN property

Unknown file type

### DiagramFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype.md

#### DiagramFileType class

The DiagramFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Vdw field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vdw.md

### Vdx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vdx.md

### Vsd field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vsd.md

### Vsdm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vsdm.md

### Vsdx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vsdx.md

### Vss field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vss.md

### Vssm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vssm.md

### Vssx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vssx.md

### Vst field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vst.md

### Vstm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vstm.md

### Vstx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vstx.md

### Vsx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vsx.md

### Vtx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/diagramfiletype/vtx.md

### EBookFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype.md

#### EBookFileType class

The EBookFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Azw3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/azw3.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/description.md

#### description property

File type description

### Epub field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/epub.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Mobi field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/mobi.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/ebookfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### EmailFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype.md

#### EmailFileType class

The EmailFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/description.md

#### description property

File type description

### Eml field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/eml.md

### Emlx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/emlx.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Ics field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/ics.md

### Mbox field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/mbox.md

### Msg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/msg.md

### Olm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/olm.md

### Ost field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/ost.md

### Pst field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/pst.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Vcf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/emailfiletype/vcf.md

### FileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype.md

#### FileType class

The FileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_enumeration |  |
| _init_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_enumeration |  |
| from_extension |  |
| from_filename |  |
| from_stream |  |
| get_all |  |
| to_string |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| extension |  |
| family |  |
| file_format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_enumeration method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/_equals_enumeration.md

#### _equals_enumeration

```python
def _equals_enumeration(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Enumeration` |  |

**Returns:** bool

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_enumeration method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/equals_enumeration.md

#### equals_enumeration

```python
def equals_enumeration(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/family.md

##### Definition:
```python
@property
def family(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/from_extension.md

#### from_extension

```python
def from_extension(cls, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | `str` |  |

**Returns:** FileType

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/from_filename.md

#### from_filename

```python
def from_filename(cls, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

**Returns:** FileType

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/from_stream.md

#### from_stream

```python
def from_stream(cls, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

**Returns:** FileType

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/get_all.md

#### get_all

```python
def get_all(cls):
    ...
```

**Returns:** List[Any]

### to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### Unknown field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/filetype/unknown.md

### FinanceFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype.md

#### FinanceFileType class

The FinanceFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### I_XBRL property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/i_xbrl.md

#### I_XBRL property

Inside the iXBRL, contents of XBRL are wrapped in xHTML file format that uses XML tags. Like XBRL, is the root element of iXBRL files. The XHTML format represents its contents as collection of different document types and modules. All the files in XHTML are based on XML file format and conform to the XML document standards.
Learn more about this file format [here](https://docs.fileformat.com/finance/ixbrl/).

### IXbrl field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/ixbrl.md

### Ofx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/ofx.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Xbrl field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/financefiletype/xbrl.md

### FontFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype.md

#### FontFileType class

The FontFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Cff field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/cff.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/description.md

#### description property

File type description

### Eot field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/eot.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Otf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/otf.md

### Ttf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/ttf.md

### Type1 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/type1.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Woff field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/woff.md

### Woff2 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/fontfiletype/woff2.md

### GisFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype.md

#### GisFileType class

The GisFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Gdb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/gdb.md

### GEO_JSON property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/geo_json.md

#### GEO_JSON property

GeoJSON is a JSON based format designed to represent the geographical features with their non-spatial attributes. This format defines different JSON (JavaScript Object Notation) objects and their joining fashion. JSON format represents a collective information about the Geographical features, their spatial extents, and properties.
Learn more about this file format [here](https://docs.fileformat.com/gis/geojson/).

### GeoJson field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/geojson.md

### Gml field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/gml.md

### Gpx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/gpx.md

### Kml field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/kml.md

### Osm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/osm.md

### Shp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/shp.md

### TOPO_JSON property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/topo_json.md

#### TOPO_JSON property

TopoJSON is an extension of GeoJSON that encodes topology. Rather than representing geometries discretely, geometries in TopoJSON files are stitched together from shared line segments called arcs.

### TopoJson field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/topojson.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/gisfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### ImageFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype.md

#### ImageFileType class

The ImageFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| is_raster |  |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Ai field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/ai.md

### Avif field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/avif.md

### Bmp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/bmp.md

### Cdr field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/cdr.md

### Cmx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/cmx.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Dcm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/dcm.md

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/description.md

#### description property

File type description

### Dib field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/dib.md

### Dicom field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/dicom.md

### DJ_VU property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/dj_vu.md

#### DJ_VU property

DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs.
Learn more about this file format [here](https://wiki.fileformat.com/image/djvu).

### DjVu field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/djvu.md

### Dng field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/dng.md

### Emf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/emf.md

### Emz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/emz.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/file_format.md

#### file_format property

The file format

### Fodg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/fodg.md

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Gif field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/gif.md

### Heic field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/heic.md

### Ico field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/ico.md

### is_raster property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/is_raster.md

##### Definition:
```python
@property
def is_raster(self):
    ...
```

### J2c field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/j2c.md

### J2k field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/j2k.md

### Jfif field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jfif.md

### Jls field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jls.md

### Jp2 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jp2.md

### Jpc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jpc.md

### Jpeg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jpeg.md

### Jpf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jpf.md

### Jpg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jpg.md

### Jpm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jpm.md

### Jpx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/jpx.md

### Odg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/odg.md

### Otg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/otg.md

### Png field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/png.md

### Psb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/psb.md

### Psd field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/psd.md

### SVGZ property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/svgz.md

#### SVGZ property

An SVGZ file is actually a compressed version of a SVG file. This allows for easier distribution of the file online. When an SVG file is compressed using the .GZIP compression algorithm, it is then given the .svgz file extension.

### Tga field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/tga.md

### Tif field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/tif.md

### Tiff field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/tiff.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Webp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/webp.md

### Wmf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/wmf.md

### Wmz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/imagefiletype/wmz.md

### NoteFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype.md

#### NoteFileType class

The NoteFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### One field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/one.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/notefiletype/unknown.md

#### UNKNOWN property

Unknown file type

### PageDescriptionLanguageFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype.md

#### PageDescriptionLanguageFileType class

The PageDescriptionLanguageFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Cgm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/cgm.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/description.md

#### description property

File type description

### Eps field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/eps.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Oxps field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/oxps.md

### Pcl field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/pcl.md

### Ps field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/ps.md

### Svg field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/svg.md

### Svgz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/svgz.md

### Tex field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/tex.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Xps field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pagedescriptionlanguagefiletype/xps.md

### PdfFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype.md

#### PdfFileType class

The PdfFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Pdf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/pdf.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/pdffiletype/unknown.md

#### UNKNOWN property

Unknown file type

### PresentationFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype.md

#### PresentationFileType class

The PresentationFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/file_format.md

#### file_format property

The file format

### Fodp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/fodp.md

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Odp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/odp.md

### Otp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/otp.md

### Pot field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/pot.md

### Potm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/potm.md

### Potx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/potx.md

### Pps field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/pps.md

### Ppsm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/ppsm.md

### Ppsx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/ppsx.md

### Ppt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/ppt.md

### Pptm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/pptm.md

### Pptx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/pptx.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/presentationfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### ProjectManagementFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype.md

#### ProjectManagementFileType class

The ProjectManagementFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Mpp field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/mpp.md

### Mpt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/mpt.md

### Mpx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/mpx.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Xer field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/projectmanagementfiletype/xer.md

### PublisherFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype.md

#### PublisherFileType class

The PublisherFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Pub field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/pub.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/publisherfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### SpreadsheetFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype.md

#### SpreadsheetFileType class

The SpreadsheetFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Csv field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/csv.md

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/description.md

#### description property

File type description

### Dif field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/dif.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/file_format.md

#### file_format property

The file format

### FlatOpc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/flatopc.md

### Fods field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/fods.md

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Numbers field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/numbers.md

### Ods field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/ods.md

### Ots field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/ots.md

### Sxc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/sxc.md

### Tsv field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/tsv.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Xlam field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlam.md

### Xls field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xls.md

### Xlsb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlsb.md

### Xlsm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlsm.md

### Xlsx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlsx.md

### Xlt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xlt.md

### Xltm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xltm.md

### Xltx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/spreadsheetfiletype/xltx.md

### ThreeDFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype.md

#### ThreeDFileType class

The ThreeDFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Amf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/amf.md

### Ase field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/ase.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Dae field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/dae.md

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/description.md

#### description property

File type description

### Drc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/drc.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/family.md

#### family property

The file family

### Fbx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/fbx.md

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Glb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/glb.md

### Gltf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/gltf.md

### Jt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/jt.md

### Ma field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/ma.md

### Mb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/mb.md

### Obj field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/obj.md

### Ply field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/ply.md

### Rvm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/rvm.md

### THREE_DS property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/three_ds.md

#### THREE_DS property

A file with .3ds extension represents 3D Sudio (DOS) mesh file format used by Autodesk 3D Studio. Autodesk 3D Studio has been in 3D file format market since 1990s and has now evolved to 3D Studio MAX for working with 3D modeling, animation and rendering.
Learn more about this file format [here](https://docs.fileformat.com/3d/3ds).

### THREE_MF property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/three_mf.md

#### THREE_MF property

3MF, 3D Manufacturing Format, is used by applications to render 3D object models to a variety of other applications, platforms, services and printers. It was built to avoid the limitations and issues in other 3D file formats, like STL, for working with the latest versions of 3D printers.
Learn more about this file format [here](https://docs.fileformat.com/3d/3mf).

### ThreeDS field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/threeds.md

### ThreeMF field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/threemf.md

### U3d field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/u3d.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Usd field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/usd.md

### Usdz field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/usdz.md

### Vrml field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/vrml.md

### X field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/threedfiletype/x.md

### VideoFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype.md

#### VideoFileType class

The VideoFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Avi field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/avi.md

### Flv field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/flv.md

### Mkv field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/mkv.md

### Mov field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/mov.md

### Mp4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/mp4.md

### Webm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/webm.md

### Wmv field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/videofiletype/wmv.md

### WebFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype.md

#### WebFileType class

The WebFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### Chm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/chm.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/description.md

#### description property

File type description

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/file_format.md

#### file_format property

The file format

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Htm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/htm.md

### Html field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/html.md

### Json field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/json.md

### Mht field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/mht.md

### Mhtml field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/mhtml.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### Xml field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/webfiletype/xml.md

### WordProcessingFileType class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype.md

#### WordProcessingFileType class

The WordProcessingFileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `FileType`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `FileType`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `FileType`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_extension |  (inherited from `FileType`) |
| from_filename |  (inherited from `FileType`) |
| from_stream |  (inherited from `FileType`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `FileType`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `FileType`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  (inherited from `FileType`) |
| extension |  (inherited from `FileType`) |
| family |  (inherited from `FileType`) |
| file_format |  (inherited from `FileType`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### description property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/description.md

#### description property

File type description

### Doc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/doc.md

### Docm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/docm.md

### Docx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/docx.md

### Dot field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/dot.md

### Dotm field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/dotm.md

### Dotx field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/dotx.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/equals.md

#### equals

Implements `Enumeration.equals`

##### Returns

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object with which to compare |

### extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/extension.md

#### extension property

The file extension

### family property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/family.md

#### family property

The file family

### file_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/file_format.md

#### file_format property

The file format

### FlatOpc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/flatopc.md

### from_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/from_extension.md

#### from_extension

Gets FileType for provided fileExtension

##### Returns

File type

```python
def from_extension(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | System.String | File extension |

### from_filename method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/from_filename.md

#### from_filename

Returns FileType for specified fileName

##### Returns

The file type of specified file name

```python
def from_filename(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | The file name |

### from_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/from_stream.md

#### from_stream

Returns FileType for provided document stream

##### Returns

The file type of provided stream

```python
def from_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | Stream which will be probed |

### Md field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/md.md

### Odt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/odt.md

### Ott field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/ott.md

### Rtf field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/rtf.md

### Txt field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/txt.md

### UNKNOWN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.filetypes/wordprocessingfiletype/unknown.md

#### UNKNOWN property

Unknown file type

### groupdocs.conversion.fluent
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent.md

Types under `groupdocs.conversion.fluent`.

##### Classes
| Class | Description |
| :- | :- |
| `IConversionByPageCompleted` |  |
| `IConversionByPageHandlerCompleted` |  |
| `IConversionByPageHandlerFailed` |  |
| `IConversionByPageHandlerOnly` |  |
| `IConversionByPageHandlerSetup` |  |
| `IConversionCompleted` |  |
| `IConversionCompressResult` |  |
| `IConversionCompressResultCompleted` |  |
| `IConversionConvert` |  |
| `IConversionConvertByPageOptions` |  |
| `IConversionConvertOptions` |  |
| `IConversionFrom` |  |
| `IConversionGetDocumentInfo` |  |
| `IConversionGetPossibleConversions` |  |
| `IConversionHandlerCompleted` |  |
| `IConversionHandlerFailed` |  |
| `IConversionHandlerOnly` |  |
| `IConversionHandlerSetup` |  |
| `IConversionIsPasswordProtected` |  |
| `IConversionLoadOptions` |  |
| `IConversionOptionsOnly` |  |
| `IConversionSettings` |  |
| `IConversionTo` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `IConversionByPageCompletedOrConvert` |  |
| `IConversionByPageOptionsOrHandlerSetup` |  |
| `IConversionCompletedOrConvert` |  |
| `IConversionCompressResultCompletedOrConvert` |  |
| `IConversionConvertOptionOrCompletedOrConvert` |  |
| `IConversionConvertOptionOrPageCompletedOrConvert` |  |
| `IConversionConvertOrCompress` |  |
| `IConversionLoadOptionsOrSourceDocumentLoaded` |  |
| `IConversionOptionsOrHandlerSetup` |  |
| `IConversionSettingsOrConversionFrom` |  |
| `IConversionSourceDocumentLoaded` |  |

### IConversionByPageCompleted class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagecompleted.md

#### IConversionByPageCompleted class

The IConversionByPageCompleted type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_174a |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |

### _on_conversion_completed_action_1_174a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagecompleted/_on_conversion_completed_action_1_174a.md

#### _on_conversion_completed_action_1_174a

```python
def _on_conversion_completed_action_1_174a(self, converted_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| converted_page_stream | `ConvertedPageContext` |  |

**Returns:** IConversionConvertOrCompress

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagecompleted/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagecompleted/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### IConversionByPageCompletedOrConvert class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagecompletedorconvert.md

#### IConversionByPageCompletedOrConvert class

The IConversionByPageCompletedOrConvert type exposes the following members:

### IConversionByPageHandlerCompleted class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlercompleted.md

#### IConversionByPageHandlerCompleted class

The IConversionByPageHandlerCompleted type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_174a |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |

### _on_conversion_completed_action_1_174a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlercompleted/_on_conversion_completed_action_1_174a.md

#### _on_conversion_completed_action_1_174a

```python
def _on_conversion_completed_action_1_174a(self, on_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_completed | `ConvertedPageContext` |  |

**Returns:** IConversionConvertOrCompress

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlercompleted/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlercompleted/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### IConversionByPageHandlerFailed class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlerfailed.md

#### IConversionByPageHandlerFailed class

The IConversionByPageHandlerFailed type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_failed_action_2_1f81 |  |
| on_conversion_failed |  |
| on_conversion_failed_action |  |

### _on_conversion_failed_action_2_1f81 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlerfailed/_on_conversion_failed_action_2_1f81.md

#### _on_conversion_failed_action_2_1f81

```python
def _on_conversion_failed_action_2_1f81(self, on_failed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_failed | `Exception` |  |

**Returns:** IConversionConvertOrCompress

### on_conversion_failed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlerfailed/on_conversion_failed.md

#### on_conversion_failed

```python
def on_conversion_failed(self):
    ...
```

### on_conversion_failed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlerfailed/on_conversion_failed_action.md

#### on_conversion_failed_action

```python
def on_conversion_failed_action(self):
    ...
```

### IConversionByPageHandlerOnly class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly.md

#### IConversionByPageHandlerOnly class

The IConversionByPageHandlerOnly type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_174a |  |
| _on_conversion_failed_action_2_1f81 |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |
| on_conversion_failed |  |
| on_conversion_failed_action |  |

### _on_conversion_completed_action_1_174a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly/_on_conversion_completed_action_1_174a.md

#### _on_conversion_completed_action_1_174a

```python
def _on_conversion_completed_action_1_174a(self, on_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_completed | `ConvertedPageContext` |  |

**Returns:** IConversionByPageHandlerFailed

### _on_conversion_failed_action_2_1f81 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly/_on_conversion_failed_action_2_1f81.md

#### _on_conversion_failed_action_2_1f81

```python
def _on_conversion_failed_action_2_1f81(self, on_failed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_failed | `Exception` |  |

**Returns:** IConversionByPageHandlerCompleted

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### on_conversion_failed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly/on_conversion_failed.md

#### on_conversion_failed

```python
def on_conversion_failed(self):
    ...
```

### on_conversion_failed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandleronly/on_conversion_failed_action.md

#### on_conversion_failed_action

```python
def on_conversion_failed_action(self):
    ...
```

### IConversionByPageHandlerSetup class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup.md

#### IConversionByPageHandlerSetup class

The IConversionByPageHandlerSetup type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_174a |  |
| _on_conversion_failed_action_2_1f81 |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |
| on_conversion_failed |  |
| on_conversion_failed_action |  |

### _on_conversion_completed_action_1_174a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup/_on_conversion_completed_action_1_174a.md

#### _on_conversion_completed_action_1_174a

```python
def _on_conversion_completed_action_1_174a(self, on_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_completed | `ConvertedPageContext` |  |

**Returns:** IConversionByPageHandlerFailed

### _on_conversion_failed_action_2_1f81 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup/_on_conversion_failed_action_2_1f81.md

#### _on_conversion_failed_action_2_1f81

```python
def _on_conversion_failed_action_2_1f81(self, on_failed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_failed | `Exception` |  |

**Returns:** IConversionByPageHandlerCompleted

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### on_conversion_failed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup/on_conversion_failed.md

#### on_conversion_failed

```python
def on_conversion_failed(self):
    ...
```

### on_conversion_failed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypagehandlersetup/on_conversion_failed_action.md

#### on_conversion_failed_action

```python
def on_conversion_failed_action(self):
    ...
```

### IConversionByPageOptionsOrHandlerSetup class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionbypageoptionsorhandlersetup.md

#### IConversionByPageOptionsOrHandlerSetup class

The IConversionByPageOptionsOrHandlerSetup type exposes the following members:

### IConversionCompleted class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompleted.md

#### IConversionCompleted class

The IConversionCompleted type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_dd_8b |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |

### _on_conversion_completed_action_1_dd_8b method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompleted/_on_conversion_completed_action_1_dd_8b.md

#### _on_conversion_completed_action_1_dd_8b

```python
def _on_conversion_completed_action_1_dd_8b(self, converted_file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| converted_file_stream | `ConvertedContext` |  |

**Returns:** IConversionConvertOrCompress

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompleted/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompleted/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### IConversionCompletedOrConvert class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompletedorconvert.md

#### IConversionCompletedOrConvert class

The IConversionCompletedOrConvert type exposes the following members:

### IConversionCompressResult class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresult.md

#### IConversionCompressResult class

The IConversionCompressResult type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compress_compression_convert_options |  |
| compress |  |
| compress_compression_convert_options |  |

### _compress_compression_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresult/_compress_compression_convert_options.md

#### _compress_compression_convert_options

```python
def _compress_compression_convert_options(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `CompressionConvertOptions` |  |

**Returns:** IConversionCompressResultCompletedOrConvert

### compress method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresult/compress.md

#### compress

```python
def compress(self):
    ...
```

### compress_compression_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresult/compress_compression_convert_options.md

#### compress_compression_convert_options

```python
def compress_compression_convert_options(self):
    ...
```

### IConversionCompressResultCompleted class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresultcompleted.md

#### IConversionCompressResultCompleted class

The IConversionCompressResultCompleted type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_compression_completed_action_1_e_2e2 |  |
| on_compression_completed |  |
| on_compression_completed_action |  |

### _on_compression_completed_action_1_e_2e2 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresultcompleted/_on_compression_completed_action_1_e_2e2.md

#### _on_compression_completed_action_1_e_2e2

```python
def _on_compression_completed_action_1_e_2e2(self, compressed_document_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| compressed_document_stream | `Stream` |  |

**Returns:** IConversionConvert

### on_compression_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresultcompleted/on_compression_completed.md

#### on_compression_completed

```python
def on_compression_completed(self):
    ...
```

### on_compression_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresultcompleted/on_compression_completed_action.md

#### on_compression_completed_action

```python
def on_compression_completed_action(self):
    ...
```

### IConversionCompressResultCompletedOrConvert class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversioncompressresultcompletedorconvert.md

#### IConversionCompressResultCompletedOrConvert class

The IConversionCompressResultCompletedOrConvert type exposes the following members:

### IConversionConvert class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvert.md

#### IConversionConvert class

The IConversionConvert type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _convert_noargs |  |
| convert |  |

### _convert_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvert/_convert_noargs.md

#### _convert_noargs

```python
def _convert_noargs(self):
    ...
```

### convert method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvert/convert.md

#### convert

```python
def convert(self):
    ...
```

### IConversionConvertByPageOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertbypageoptions.md

#### IConversionConvertByPageOptions class

The IConversionConvertByPageOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _with_options_convert_options |  |
| _with_options_func_2_8b05 |  |
| with_options |  |
| with_options_convert_options |  |
| with_options_func |  |

### _with_options_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertbypageoptions/_with_options_convert_options.md

#### _with_options_convert_options

```python
def _with_options_convert_options(self, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` |  |

**Returns:** IConversionByPageHandlerSetup

### _with_options_func_2_8b05 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertbypageoptions/_with_options_func_2_8b05.md

#### _with_options_func_2_8b05

```python
def _with_options_func_2_8b05(self, convert_options_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options_provider | `ConvertOptions` |  |

**Returns:** IConversionByPageHandlerSetup

### with_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertbypageoptions/with_options.md

#### with_options

```python
def with_options(self):
    ...
```

### with_options_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertbypageoptions/with_options_convert_options.md

#### with_options_convert_options

```python
def with_options_convert_options(self):
    ...
```

### with_options_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertbypageoptions/with_options_func.md

#### with_options_func

```python
def with_options_func(self):
    ...
```

### IConversionConvertOptionOrCompletedOrConvert class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptionorcompletedorconvert.md

#### IConversionConvertOptionOrCompletedOrConvert class

The IConversionConvertOptionOrCompletedOrConvert type exposes the following members:

### IConversionConvertOptionOrPageCompletedOrConvert class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptionorpagecompletedorconvert.md

#### IConversionConvertOptionOrPageCompletedOrConvert class

The IConversionConvertOptionOrPageCompletedOrConvert type exposes the following members:

### IConversionConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptions.md

#### IConversionConvertOptions class

The IConversionConvertOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _with_options_convert_options |  |
| _with_options_func_2_8b05 |  |
| with_options |  |
| with_options_convert_options |  |
| with_options_func |  |

### _with_options_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptions/_with_options_convert_options.md

#### _with_options_convert_options

```python
def _with_options_convert_options(self, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` |  |

**Returns:** IConversionHandlerSetup

### _with_options_func_2_8b05 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptions/_with_options_func_2_8b05.md

#### _with_options_func_2_8b05

```python
def _with_options_func_2_8b05(self, convert_options_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options_provider | `ConvertOptions` |  |

**Returns:** IConversionHandlerSetup

### with_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptions/with_options.md

#### with_options

```python
def with_options(self):
    ...
```

### with_options_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptions/with_options_convert_options.md

#### with_options_convert_options

```python
def with_options_convert_options(self):
    ...
```

### with_options_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertoptions/with_options_func.md

#### with_options_func

```python
def with_options_func(self):
    ...
```

### IConversionConvertOrCompress class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionconvertorcompress.md

#### IConversionConvertOrCompress class

The IConversionConvertOrCompress type exposes the following members:

### IConversionFrom class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom.md

#### IConversionFrom class

The IConversionFrom type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _load_func_1_4427 |  |
| _load_func_1_e_2e2 |  |
| _load_string |  |
| _load_string_array |  |
| load |  |
| load_file |  |
| load_files |  |
| load_func |  |
| load_string |  |
| load_strings |  |

### _load_func_1_4427 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/_load_func_1_4427.md

#### _load_func_1_4427

```python
def _load_func_1_4427(self, document_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream_provider | `List[Stream]` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### _load_func_1_e_2e2 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/_load_func_1_e_2e2.md

#### _load_func_1_e_2e2

```python
def _load_func_1_e_2e2(self, document_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream_provider | `Stream` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### _load_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/_load_string.md

#### _load_string

```python
def _load_string(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### _load_string_array method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/_load_string_array.md

#### _load_string_array

```python
def _load_string_array(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `List[str]` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### load method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/load.md

#### load

```python
def load(self):
    ...
```

### load_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/load_file.md

#### load_file

```python
def load_file(self):
    ...
```

### load_files method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/load_files.md

#### load_files

```python
def load_files(self):
    ...
```

### load_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/load_func.md

#### load_func

```python
def load_func(self):
    ...
```

### load_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/load_string.md

#### load_string

```python
def load_string(self):
    ...
```

### load_strings method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionfrom/load_strings.md

#### load_strings

```python
def load_strings(self):
    ...
```

### IConversionGetDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversiongetdocumentinfo.md

#### IConversionGetDocumentInfo class

The IConversionGetDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_document_info_noargs |  |
| get_document_info |  |

### _get_document_info_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversiongetdocumentinfo/_get_document_info_noargs.md

#### _get_document_info_noargs

```python
def _get_document_info_noargs(self):
    ...
```

**Returns:** IDocumentInfo

### get_document_info method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversiongetdocumentinfo/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### IConversionGetPossibleConversions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversiongetpossibleconversions.md

#### IConversionGetPossibleConversions class

The IConversionGetPossibleConversions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_possible_conversions_noargs |  |
| get_possible_conversions |  |

### _get_possible_conversions_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversiongetpossibleconversions/_get_possible_conversions_noargs.md

#### _get_possible_conversions_noargs

```python
def _get_possible_conversions_noargs(self):
    ...
```

**Returns:** PossibleConversions

### get_possible_conversions method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversiongetpossibleconversions/get_possible_conversions.md

#### get_possible_conversions

```python
def get_possible_conversions(self):
    ...
```

### IConversionHandlerCompleted class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlercompleted.md

#### IConversionHandlerCompleted class

The IConversionHandlerCompleted type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_dd_8b |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |

### _on_conversion_completed_action_1_dd_8b method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlercompleted/_on_conversion_completed_action_1_dd_8b.md

#### _on_conversion_completed_action_1_dd_8b

```python
def _on_conversion_completed_action_1_dd_8b(self, on_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_completed | `ConvertedContext` |  |

**Returns:** IConversionConvertOrCompress

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlercompleted/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlercompleted/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### IConversionHandlerFailed class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlerfailed.md

#### IConversionHandlerFailed class

The IConversionHandlerFailed type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_failed_action_2_7d_6a |  |
| on_conversion_failed |  |
| on_conversion_failed_action |  |

### _on_conversion_failed_action_2_7d_6a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlerfailed/_on_conversion_failed_action_2_7d_6a.md

#### _on_conversion_failed_action_2_7d_6a

```python
def _on_conversion_failed_action_2_7d_6a(self, on_failed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_failed | `Exception` |  |

**Returns:** IConversionConvertOrCompress

### on_conversion_failed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlerfailed/on_conversion_failed.md

#### on_conversion_failed

```python
def on_conversion_failed(self):
    ...
```

### on_conversion_failed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlerfailed/on_conversion_failed_action.md

#### on_conversion_failed_action

```python
def on_conversion_failed_action(self):
    ...
```

### IConversionHandlerOnly class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly.md

#### IConversionHandlerOnly class

The IConversionHandlerOnly type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_dd_8b |  |
| _on_conversion_failed_action_2_7d_6a |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |
| on_conversion_failed |  |
| on_conversion_failed_action |  |

### _on_conversion_completed_action_1_dd_8b method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly/_on_conversion_completed_action_1_dd_8b.md

#### _on_conversion_completed_action_1_dd_8b

```python
def _on_conversion_completed_action_1_dd_8b(self, on_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_completed | `ConvertedContext` |  |

**Returns:** IConversionHandlerFailed

### _on_conversion_failed_action_2_7d_6a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly/_on_conversion_failed_action_2_7d_6a.md

#### _on_conversion_failed_action_2_7d_6a

```python
def _on_conversion_failed_action_2_7d_6a(self, on_failed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_failed | `Exception` |  |

**Returns:** IConversionHandlerCompleted

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### on_conversion_failed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly/on_conversion_failed.md

#### on_conversion_failed

```python
def on_conversion_failed(self):
    ...
```

### on_conversion_failed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandleronly/on_conversion_failed_action.md

#### on_conversion_failed_action

```python
def on_conversion_failed_action(self):
    ...
```

### IConversionHandlerSetup class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup.md

#### IConversionHandlerSetup class

The IConversionHandlerSetup type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _on_conversion_completed_action_1_dd_8b |  |
| _on_conversion_failed_action_2_7d_6a |  |
| on_conversion_completed |  |
| on_conversion_completed_action |  |
| on_conversion_failed |  |
| on_conversion_failed_action |  |

### _on_conversion_completed_action_1_dd_8b method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup/_on_conversion_completed_action_1_dd_8b.md

#### _on_conversion_completed_action_1_dd_8b

```python
def _on_conversion_completed_action_1_dd_8b(self, on_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_completed | `ConvertedContext` |  |

**Returns:** IConversionHandlerFailed

### _on_conversion_failed_action_2_7d_6a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup/_on_conversion_failed_action_2_7d_6a.md

#### _on_conversion_failed_action_2_7d_6a

```python
def _on_conversion_failed_action_2_7d_6a(self, on_failed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| on_failed | `Exception` |  |

**Returns:** IConversionHandlerCompleted

### on_conversion_completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup/on_conversion_completed.md

#### on_conversion_completed

```python
def on_conversion_completed(self):
    ...
```

### on_conversion_completed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup/on_conversion_completed_action.md

#### on_conversion_completed_action

```python
def on_conversion_completed_action(self):
    ...
```

### on_conversion_failed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup/on_conversion_failed.md

#### on_conversion_failed

```python
def on_conversion_failed(self):
    ...
```

### on_conversion_failed_action method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionhandlersetup/on_conversion_failed_action.md

#### on_conversion_failed_action

```python
def on_conversion_failed_action(self):
    ...
```

### IConversionIsPasswordProtected class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionispasswordprotected.md

#### IConversionIsPasswordProtected class

The IConversionIsPasswordProtected type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _is_document_password_protected_noargs |  |
| is_document_password_protected |  |

### _is_document_password_protected_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionispasswordprotected/_is_document_password_protected_noargs.md

#### _is_document_password_protected_noargs

```python
def _is_document_password_protected_noargs(self):
    ...
```

**Returns:** bool

### is_document_password_protected method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionispasswordprotected/is_document_password_protected.md

#### is_document_password_protected

```python
def is_document_password_protected(self):
    ...
```

### IConversionLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptions.md

#### IConversionLoadOptions class

The IConversionLoadOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _with_options_func_2_cc52 |  |
| _with_options_load_options |  |
| with_options |  |
| with_options_func |  |
| with_options_load_options |  |

### _with_options_func_2_cc52 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptions/_with_options_func_2_cc52.md

#### _with_options_func_2_cc52

```python
def _with_options_func_2_cc52(self, load_options_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options_provider | `LoadOptions` |  |

**Returns:** IConversionSourceDocumentLoaded

### _with_options_load_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptions/_with_options_load_options.md

#### _with_options_load_options

```python
def _with_options_load_options(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | `LoadOptions` |  |

**Returns:** IConversionSourceDocumentLoaded

### with_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptions/with_options.md

#### with_options

```python
def with_options(self):
    ...
```

### with_options_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptions/with_options_func.md

#### with_options_func

```python
def with_options_func(self):
    ...
```

### with_options_load_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptions/with_options_load_options.md

#### with_options_load_options

```python
def with_options_load_options(self):
    ...
```

### IConversionLoadOptionsOrSourceDocumentLoaded class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionloadoptionsorsourcedocumentloaded.md

#### IConversionLoadOptionsOrSourceDocumentLoaded class

The IConversionLoadOptionsOrSourceDocumentLoaded type exposes the following members:

### IConversionOptionsOnly class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsonly.md

#### IConversionOptionsOnly class

The IConversionOptionsOnly type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _with_options_convert_options |  |
| _with_options_func_2_8b05 |  |
| with_options |  |
| with_options_convert_options |  |
| with_options_func |  |

### _with_options_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsonly/_with_options_convert_options.md

#### _with_options_convert_options

```python
def _with_options_convert_options(self, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` |  |

**Returns:** IConversionHandlerSetup

### _with_options_func_2_8b05 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsonly/_with_options_func_2_8b05.md

#### _with_options_func_2_8b05

```python
def _with_options_func_2_8b05(self, options_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options_provider | `ConvertOptions` |  |

**Returns:** IConversionHandlerSetup

### with_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsonly/with_options.md

#### with_options

```python
def with_options(self):
    ...
```

### with_options_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsonly/with_options_convert_options.md

#### with_options_convert_options

```python
def with_options_convert_options(self):
    ...
```

### with_options_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsonly/with_options_func.md

#### with_options_func

```python
def with_options_func(self):
    ...
```

### IConversionOptionsOrHandlerSetup class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionoptionsorhandlersetup.md

#### IConversionOptionsOrHandlerSetup class

The IConversionOptionsOrHandlerSetup type exposes the following members:

### IConversionSettings class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionsettings.md

#### IConversionSettings class

The IConversionSettings type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _with_settings_func_1_ec_4e |  |
| with_settings |  |
| with_settings_func |  |

### _with_settings_func_1_ec_4e method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionsettings/_with_settings_func_1_ec_4e.md

#### _with_settings_func_1_ec_4e

```python
def _with_settings_func_1_ec_4e(self, settings_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| settings_provider | `ConverterSettings` |  |

**Returns:** IConversionFrom

### with_settings method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionsettings/with_settings.md

#### with_settings

```python
def with_settings(self):
    ...
```

### with_settings_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionsettings/with_settings_func.md

#### with_settings_func

```python
def with_settings_func(self):
    ...
```

### IConversionSettingsOrConversionFrom class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionsettingsorconversionfrom.md

#### IConversionSettingsOrConversionFrom class

The IConversionSettingsOrConversionFrom type exposes the following members:

### IConversionSourceDocumentLoaded class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionsourcedocumentloaded.md

#### IConversionSourceDocumentLoaded class

The IConversionSourceDocumentLoaded type exposes the following members:

### IConversionTo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto.md

#### IConversionTo class

The IConversionTo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _convert_by_page_to_func_2_83b4 |  |
| _convert_to_func_2_1f04 |  |
| _convert_to_string |  |
| convert_by_page_to |  |
| convert_by_page_to_func |  |
| convert_to |  |
| convert_to_file |  |
| convert_to_func |  |
| convert_to_string |  |

### _convert_by_page_to_func_2_83b4 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/_convert_by_page_to_func_2_83b4.md

#### _convert_by_page_to_func_2_83b4

```python
def _convert_by_page_to_func_2_83b4(self, converted_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| converted_stream_provider | `Stream` |  |

**Returns:** IConversionByPageOptionsOrHandlerSetup

### _convert_to_func_2_1f04 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/_convert_to_func_2_1f04.md

#### _convert_to_func_2_1f04

```python
def _convert_to_func_2_1f04(self, converted_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| converted_stream_provider | `Stream` |  |

**Returns:** IConversionOptionsOrHandlerSetup

### _convert_to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/_convert_to_string.md

#### _convert_to_string

```python
def _convert_to_string(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

**Returns:** IConversionOptionsOrHandlerSetup

### convert_by_page_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/convert_by_page_to.md

#### convert_by_page_to

```python
def convert_by_page_to(self):
    ...
```

### convert_by_page_to_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/convert_by_page_to_func.md

#### convert_by_page_to_func

```python
def convert_by_page_to_func(self):
    ...
```

### convert_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/convert_to.md

#### convert_to

```python
def convert_to(self):
    ...
```

### convert_to_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/convert_to_file.md

#### convert_to_file

```python
def convert_to_file(self):
    ...
```

### convert_to_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/convert_to_func.md

#### convert_to_func

```python
def convert_to_func(self):
    ...
```

### convert_to_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.fluent/iconversionto/convert_to_string.md

#### convert_to_string

```python
def convert_to_string(self):
    ...
```

### groupdocs.conversion.logging
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging.md

Logging hooks and listener interfaces.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` |  |
| `ILogger` |  |

### ConsoleLogger class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger.md

#### ConsoleLogger class

The ConsoleLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _error_string_exception |  |
| _init_noargs |  |
| _trace_string |  |
| _warning_string |  |
| error |  |
| error_file |  |
| error_string |  |
| trace |  |
| trace_file |  |
| trace_string |  |
| warning |  |
| warning_file |  |
| warning_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/_error_string_exception.md

#### _error_string_exception

```python
def _error_string_exception(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |
| exception | `Exception` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _trace_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/_trace_string.md

#### _trace_string

```python
def _trace_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _warning_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/consolelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### FileLogger class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/filelogger.md

#### FileLogger class

File logger implementation.

The FileLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `FileLogger` class with the specified file path. |

##### Methods
| Method | Description |
| :- | :- |
| trace | Writes trace log message;
<br/>Trace log messages provide generally useful information about application flow. |
| warning | Writes warning log message;
<br/>Warning log messages provide information about unexpected and recoverable events in application flow. |
| error | Writes error log message;
<br/>Error log messages provide information about unrecoverable events in application flow. |

### FileLogger constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/filelogger/__init__.md

#### __init__

Initializes a new instance of the `FileLogger` class with the specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The file path where logs will be written. |

### error method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/filelogger/error.md

#### error

Writes error log message;
Error log messages provide information about unrecoverable events in application flow.

```python
def error(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The error message. |
| exception | System.String | The exception. |

### trace method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/filelogger/trace.md

#### trace

Writes trace log message;
Trace log messages provide generally useful information about application flow.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The trace message. |

### warning method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/filelogger/warning.md

#### warning

Writes warning log message;
Warning log messages provide information about unexpected and recoverable events in application flow.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The warning message. |

### ILogger class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger.md

#### ILogger class

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _error_string_exception |  |
| _trace_string |  |
| _warning_string |  |
| error |  |
| error_file |  |
| error_string |  |
| trace |  |
| trace_file |  |
| trace_string |  |
| warning |  |
| warning_file |  |
| warning_string |  |

### _error_string_exception method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/_error_string_exception.md

#### _error_string_exception

```python
def _error_string_exception(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |
| exception | `Exception` |  |

### _trace_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/_trace_string.md

#### _trace_string

```python
def _trace_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _warning_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.logging/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### groupdocs.conversion.options.convert
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert.md

Types under `groupdocs.conversion.options.convert`.

##### Classes
| Class | Description |
| :- | :- |
| `AudioConvertOptions` |  |
| `CadConvertOptions` |  |
| `CommonConvertOptions` |  |
| `CompressionConvertOptions` |  |
| `ConvertOptions` |  |
| `DiagramConvertOptions` |  |
| `EBookConvertOptions` |  |
| `EmailConvertOptions` |  |
| `FinanceConvertOptions` |  |
| `Font` |  |
| `FontConvertOptions` |  |
| `GisConvertOptions` |  |
| `IConvertOptions` |  |
| `IDpiConvertOptions` |  |
| `IPageRangedConvertOptions` |  |
| `IPagedConvertOptions` |  |
| `IPasswordConvertOptions` |  |
| `IPdfRecognitionModeOptions` |  |
| `IUsePdfConvertOptions` |  |
| `IWatermarkedConvertOptions` |  |
| `IZoomConvertOptions` |  |
| `ImageConvertOptions` |  |
| `JpegOptions` |  |
| `MarkdownOptions` |  |
| `NoConvertOptions` |  |
| `PageDescriptionLanguageConvertOptions` |  |
| `PdfConvertOptions` |  |
| `PdfDocumentInfo` |  |
| `PdfFormattingOptions` |  |
| `PdfOptimizationOptions` |  |
| `PdfOptions` |  |
| `PresentationConvertOptions` |  |
| `ProjectManagementConvertOptions` |  |
| `PsdOptions` |  |
| `RtfOptions` |  |
| `SpreadsheetConvertOptions` |  |
| `ThreeDConvertOptions` |  |
| `TiffOptions` |  |
| `VideoConvertOptions` |  |
| `WatermarkImageOptions` |  |
| `WatermarkOptions` |  |
| `WatermarkTextOptions` |  |
| `WebConvertOptions` |  |
| `WebpOptions` |  |
| `WordProcessingConvertOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ImageFlipModes` |  |
| `JpgColorModes` |  |
| `JpgCompressionMethods` |  |
| `PageOrientation` |  |
| `PageResizeMode` |  |
| `PdfDirection` |  |
| `PdfFontSubsetStrategy` |  |
| `PdfFormats` |  |
| `PdfPageLayout` |  |
| `PdfPageMode` |  |
| `PdfRecognitionMode` |  |
| `PsdColorModes` |  |
| `PsdCompressionMethods` |  |
| `Rotation` |  |
| `TiffCompressionMethods` |  |

### AudioConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/audioconvertoptions.md

#### AudioConvertOptions class

The AudioConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/audioconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/audioconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/audioconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### CadConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions.md

#### CadConvertOptions class

The CadConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| page_height |  |
| page_number |  |
| page_size |  |
| page_width |  |
| pages_count |  |
| size_settings |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/page_height.md

##### Definition:
```python
@property
def page_height(self):
    ...
@page_height.setter
def page_height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/page_width.md

##### Definition:
```python
@property
def page_width(self):
    ...
@page_width.setter
def page_width(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/cadconvertoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### CommonConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions.md

#### CommonConvertOptions class

The CommonConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| page_number |  |
| pages |  |
| pages_count |  |
| watermark |  |

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/commonconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### CompressionConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions.md

#### CompressionConvertOptions class

The CompressionConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/compressionconvertoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### ConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/convertoptions.md

#### ConvertOptions class

The ConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/convertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/convertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/convertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### DiagramConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions.md

#### DiagramConvertOptions class

The DiagramConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| auto_fit_page_to_drawing_content |  |
| format |  |
| page_number |  |
| pages |  |
| pages_count |  |
| watermark |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### auto_fit_page_to_drawing_content property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/auto_fit_page_to_drawing_content.md

##### Definition:
```python
@property
def auto_fit_page_to_drawing_content(self):
    ...
@auto_fit_page_to_drawing_content.setter
def auto_fit_page_to_drawing_content(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/diagramconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### EBookConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions.md

#### EBookConvertOptions class

The EBookConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| fallback_page_size |  |
| format |  |
| orientation_settings |  |
| page_height |  |
| page_number |  |
| page_size |  |
| page_width |  |
| pages |  |
| pages_count |  |
| size_settings |  |
| watermark |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### fallback_page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/fallback_page_size.md

##### Definition:
```python
@property
def fallback_page_size(self):
    ...
@fallback_page_size.setter
def fallback_page_size(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### orientation_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/orientation_settings.md

##### Definition:
```python
@property
def orientation_settings(self):
    ...
@orientation_settings.setter
def orientation_settings(self, value):
    ...
```

### page_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/page_height.md

##### Definition:
```python
@property
def page_height(self):
    ...
@page_height.setter
def page_height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### page_orientation property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/page_orientation.md

#### page_orientation property

Implements `IPageOrientationConvertOptions.page_orientation`
##### Definition:
```python
@property
def page_orientation(self):
    ...
@page_orientation.setter
def page_orientation(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/page_width.md

##### Definition:
```python
@property
def page_width(self):
    ...
@page_width.setter
def page_width(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ebookconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### EmailConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions.md

#### EmailConvertOptions class

The EmailConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| attachment_content_handler |  |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### attachment_content_handler property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions/attachment_content_handler.md

##### Definition:
```python
@property
def attachment_content_handler(self):
    ...
@attachment_content_handler.setter
def attachment_content_handler(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/emailconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### FinanceConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions.md

#### FinanceConvertOptions class

The FinanceConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| page_number |  |
| pages_count |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/financeconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### Font class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font.md

#### Font class

The Font type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |
| _init_string_single |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| bold |  |
| family_name |  |
| italic |  |
| size |  |
| underline |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/_init_string.md

#### _init_string

```python
def _init_string(self, font_family_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family_name | `str` |  |

### _init_string_single method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/_init_string_single.md

#### _init_string_single

```python
def _init_string_single(self, font_family_name, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family_name | `str` |  |
| size | `float` |  |

### bold property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/bold.md

##### Definition:
```python
@property
def bold(self):
    ...
@bold.setter
def bold(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### family_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### italic property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/italic.md

##### Definition:
```python
@property
def italic(self):
    ...
@italic.setter
def italic(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### underline property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/font/underline.md

##### Definition:
```python
@property
def underline(self):
    ...
@underline.setter
def underline(self, value):
    ...
```

### FontConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/fontconvertoptions.md

#### FontConvertOptions class

The FontConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/fontconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/fontconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/fontconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/fontconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/fontconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### GisConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/gisconvertoptions.md

#### GisConvertOptions class

The GisConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/gisconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/gisconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/gisconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/gisconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/gisconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### IConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/iconvertoptions.md

#### IConvertOptions class

The IConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/iconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### IDpiConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/idpiconvertoptions.md

#### IDpiConvertOptions class

The IDpiConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| dpi |  |

### dpi property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/idpiconvertoptions/dpi.md

##### Definition:
```python
@property
def dpi(self):
    ...
@dpi.setter
def dpi(self, value):
    ...
```

### ImageConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions.md

#### ImageConvertOptions class

The ImageConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| background_color |  |
| brightness |  |
| contrast |  |
| crop_area |  |
| flip_mode |  |
| format |  |
| gamma |  |
| grayscale |  |
| height |  |
| horizontal_resolution |  |
| jpeg_options |  |
| page_number |  |
| pages |  |
| pages_count |  |
| psd_options |  |
| rotate_angle |  |
| tiff_options |  |
| use_pdf |  |
| vertical_resolution |  |
| watermark |  |
| webp_options |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/background_color.md

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### brightness property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/brightness.md

##### Definition:
```python
@property
def brightness(self):
    ...
@brightness.setter
def brightness(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### contrast property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/contrast.md

##### Definition:
```python
@property
def contrast(self):
    ...
@contrast.setter
def contrast(self, value):
    ...
```

### crop_area property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/crop_area.md

##### Definition:
```python
@property
def crop_area(self):
    ...
@crop_area.setter
def crop_area(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### flip_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/flip_mode.md

##### Definition:
```python
@property
def flip_mode(self):
    ...
@flip_mode.setter
def flip_mode(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### gamma property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/gamma.md

##### Definition:
```python
@property
def gamma(self):
    ...
@gamma.setter
def gamma(self, value):
    ...
```

### grayscale property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/grayscale.md

##### Definition:
```python
@property
def grayscale(self):
    ...
@grayscale.setter
def grayscale(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### horizontal_resolution property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/horizontal_resolution.md

##### Definition:
```python
@property
def horizontal_resolution(self):
    ...
@horizontal_resolution.setter
def horizontal_resolution(self, value):
    ...
```

### jpeg_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/jpeg_options.md

##### Definition:
```python
@property
def jpeg_options(self):
    ...
@jpeg_options.setter
def jpeg_options(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### psd_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/psd_options.md

##### Definition:
```python
@property
def psd_options(self):
    ...
@psd_options.setter
def psd_options(self, value):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/rotate_angle.md

##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### tiff_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/tiff_options.md

##### Definition:
```python
@property
def tiff_options(self):
    ...
@tiff_options.setter
def tiff_options(self, value):
    ...
```

### use_pdf property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/use_pdf.md

##### Definition:
```python
@property
def use_pdf(self):
    ...
@use_pdf.setter
def use_pdf(self, value):
    ...
```

### vertical_resolution property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/vertical_resolution.md

##### Definition:
```python
@property
def vertical_resolution(self):
    ...
@vertical_resolution.setter
def vertical_resolution(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### webp_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/webp_options.md

##### Definition:
```python
@property
def webp_options(self):
    ...
@webp_options.setter
def webp_options(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageconvertoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### ImageFlipModes class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes.md

#### ImageFlipModes class

The ImageFlipModes type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### ImageFlipModes constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### FLIP_X property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/flip_x.md

#### FLIP_X property

Horizontal flip.

### FLIP_XY property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/flip_xy.md

#### FLIP_XY property

Flip horizontal and vertical.

### FLIP_Y property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/flip_y.md

#### FLIP_Y property

Flip vertical.

### FlipX field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/flipx.md

### FlipXY field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/flipxy.md

### FlipY field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/flipy.md

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/imageflipmodes/none.md

### IPagedConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagedconvertoptions.md

#### IPagedConvertOptions class

The IPagedConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_number |  |
| pages_count |  |

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagedconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagedconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### IPageMarginConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagemarginconvertoptions.md

#### IPageMarginConvertOptions class

Represents convert options that support page margins

The IPageMarginConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| margin_top | Desired page top margin in points after conversion. |
| margin_bottom | Desired page bottom margin in points after conversion. |
| margin_left | Desired page left margin in points after conversion. |
| margin_right | Desired page right margin in points after conversion. |

### margin_bottom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagemarginconvertoptions/margin_bottom.md

#### margin_bottom property

Desired page bottom margin in points after conversion.
##### Definition:
```python
@property
def margin_bottom(self):
    ...
@margin_bottom.setter
def margin_bottom(self, value):
    ...
```

### margin_left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagemarginconvertoptions/margin_left.md

#### margin_left property

Desired page left margin in points after conversion.
##### Definition:
```python
@property
def margin_left(self):
    ...
@margin_left.setter
def margin_left(self, value):
    ...
```

### margin_right property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagemarginconvertoptions/margin_right.md

#### margin_right property

Desired page right margin in points after conversion.
##### Definition:
```python
@property
def margin_right(self):
    ...
@margin_right.setter
def margin_right(self, value):
    ...
```

### margin_top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagemarginconvertoptions/margin_top.md

#### margin_top property

Desired page top margin in points after conversion.
##### Definition:
```python
@property
def margin_top(self):
    ...
@margin_top.setter
def margin_top(self, value):
    ...
```

### IPageOrientationConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipageorientationconvertoptions.md

#### IPageOrientationConvertOptions class

Represents convert options that support page orientation

The IPageOrientationConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_orientation | Desired page orientation after conversion |

### page_orientation property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipageorientationconvertoptions/page_orientation.md

#### page_orientation property

Desired page orientation after conversion
##### Definition:
```python
@property
def page_orientation(self):
    ...
@page_orientation.setter
def page_orientation(self, value):
    ...
```

### IPageRangedConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagerangedconvertoptions.md

#### IPageRangedConvertOptions class

The IPageRangedConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagerangedconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### IPageSizeConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagesizeconvertoptions.md

#### IPageSizeConvertOptions class

Represents convert options that support page size

The IPageSizeConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_size | Desired page size after conversion |
| page_width | Specified page width in points if `IPageSizeConvertOptions.page_size` is set to PageSize.Custom |
| page_height | Specified page height in points if `IPageSizeConvertOptions.page_size` is set to PageSize.Custom |

### page_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagesizeconvertoptions/page_height.md

#### page_height property

Specified page height in points if `IPageSizeConvertOptions.page_size` is set to PageSize.Custom
##### Definition:
```python
@property
def page_height(self):
    ...
@page_height.setter
def page_height(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagesizeconvertoptions/page_size.md

#### page_size property

Desired page size after conversion
##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipagesizeconvertoptions/page_width.md

#### page_width property

Specified page width in points if `IPageSizeConvertOptions.page_size` is set to PageSize.Custom
##### Definition:
```python
@property
def page_width(self):
    ...
@page_width.setter
def page_width(self, value):
    ...
```

### IPasswordConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipasswordconvertoptions.md

#### IPasswordConvertOptions class

The IPasswordConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipasswordconvertoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### IPdfRecognitionModeOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipdfrecognitionmodeoptions.md

#### IPdfRecognitionModeOptions class

The IPdfRecognitionModeOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pdf_recognition_mode |  |

### pdf_recognition_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/ipdfrecognitionmodeoptions/pdf_recognition_mode.md

##### Definition:
```python
@property
def pdf_recognition_mode(self):
    ...
@pdf_recognition_mode.setter
def pdf_recognition_mode(self, value):
    ...
```

### IUsePdfConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/iusepdfconvertoptions.md

#### IUsePdfConvertOptions class

The IUsePdfConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| use_pdf |  |

### use_pdf property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/iusepdfconvertoptions/use_pdf.md

##### Definition:
```python
@property
def use_pdf(self):
    ...
@use_pdf.setter
def use_pdf(self, value):
    ...
```

### IWatermarkedConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/iwatermarkedconvertoptions.md

#### IWatermarkedConvertOptions class

The IWatermarkedConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| watermark |  |

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/iwatermarkedconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### IZoomConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/izoomconvertoptions.md

#### IZoomConvertOptions class

The IZoomConvertOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| zoom |  |

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/izoomconvertoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### JpegOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions.md

#### JpegOptions class

The JpegOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| color_mode |  |
| compression |  |
| quality |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### color_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions/color_mode.md

##### Definition:
```python
@property
def color_mode(self):
    ...
@color_mode.setter
def color_mode(self, value):
    ...
```

### compression property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions/compression.md

##### Definition:
```python
@property
def compression(self):
    ...
@compression.setter
def compression(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### quality property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpegoptions/quality.md

##### Definition:
```python
@property
def quality(self):
    ...
@quality.setter
def quality(self, value):
    ...
```

### JpgColorModes class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes.md

#### JpgColorModes class

The JpgColorModes type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### JpgColorModes constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### Cmyk field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/cmyk.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### Grayscale field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/grayscale.md

### Rgb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/rgb.md

### Y_CB_CR property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/y_cb_cr.md

#### Y_CB_CR property

YCbCr image. Standard option for jpeg images.

### YCbCr field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/ycbcr.md

### Ycck field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcolormodes/ycck.md

### JpgCompressionMethods class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods.md

#### JpgCompressionMethods class

The JpgCompressionMethods type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### JpgCompressionMethods constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### Baseline field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/baseline.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### JPEG_LS property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/jpeg_ls.md

#### JPEG_LS property

JpegLs compression.

### JpegLs field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/jpegls.md

### Lossless field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/lossless.md

### Progressive field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/jpgcompressionmethods/progressive.md

### MarkdownOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/markdownoptions.md

#### MarkdownOptions class

The MarkdownOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| export_images_as_base64 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/markdownoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/markdownoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/markdownoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### export_images_as_base64 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/markdownoptions/export_images_as_base64.md

##### Definition:
```python
@property
def export_images_as_base64(self):
    ...
@export_images_as_base64.setter
def export_images_as_base64(self, value):
    ...
```

### NoConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/noconvertoptions.md

#### NoConvertOptions class

The NoConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/noconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/noconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/noconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/noconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/noconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### PageDescriptionLanguageConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions.md

#### PageDescriptionLanguageConvertOptions class

The PageDescriptionLanguageConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| height |  |
| page_number |  |
| pages |  |
| pages_count |  |
| watermark |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagedescriptionlanguageconvertoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PageOrientation class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation.md

#### PageOrientation class

The PageOrientation type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PageOrientation constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Default field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation/default.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### Landscape field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation/landscape.md

### Portrait field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageorientation/portrait.md

### PageResizeMode class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageresizemode.md

#### PageResizeMode class

The PageResizeMode type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### AlignTopLeft field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageresizemode/aligntopleft.md

### ScaleToFill field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageresizemode/scaletofill.md

### ScaleToFit field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageresizemode/scaletofit.md

### ScaleToHeight field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageresizemode/scaletoheight.md

### ScaleToWidth field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pageresizemode/scaletowidth.md

### PageSize class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize.md

#### PageSize class

Specifies page size

**Inheritance:** `PageSize` →
`Enumeration`

The PageSize type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Serialization constructor |

##### Properties
| Property | Description |
| :- | :- |
| A3 | 297 x 420 mm. |
| A4 | 210 x 297 mm. |
| A5 | 148 x 210 mm. |
| B4 | 250 x 353 mm |
| B5 | 176 x 250 mm. |
| CUSTOM | Custom paper size. |
| ENVELOPE_DL | 110 x 220 mm. |
| EXECUTIVE | 7.25 x 10.5 inches. |
| FOLIO | 8.5 x 13 inches. |
| LEDGER | 17 x 11 inches. |
| LEGAL | 8.5 x 14 inches. |
| LETTER | 8.5 x 11 inches. |
| PAPER_10X14 | 10 x 14 inches. |
| PAPER_11X17 | 11 x 17 inches. |
| QUARTO | 8.47 x 10.83 inches. |
| STATEMENT | 8.5 x 5.5 inches. |
| TABLOID | 11 x 17 inches. |
| UNSET | Unset paper size. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether two object instances are equal. |
| compare_to | Compares current object to other. |

### PageSize constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### A3 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/a3.md

#### A3 property

297 x 420 mm.

### A4 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/a4.md

#### A4 property

210 x 297 mm.

### A5 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/a5.md

#### A5 property

148 x 210 mm.

### B4 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/b4.md

#### B4 property

250 x 353 mm

### B5 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/b5.md

#### B5 property

176 x 250 mm.

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### CUSTOM property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/custom.md

#### CUSTOM property

Custom paper size.

### ENVELOPE_DL property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/envelope_dl.md

#### ENVELOPE_DL property

110 x 220 mm.

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### EXECUTIVE property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/executive.md

#### EXECUTIVE property

7.25 x 10.5 inches.

### FOLIO property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/folio.md

#### FOLIO property

8.5 x 13 inches.

### LEDGER property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/ledger.md

#### LEDGER property

17 x 11 inches.

### LEGAL property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/legal.md

#### LEGAL property

8.5 x 14 inches.

### LETTER property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/letter.md

#### LETTER property

8.5 x 11 inches.

### PAPER_10X14 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/paper_10x14.md

#### PAPER_10X14 property

10 x 14 inches.

### PAPER_11X17 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/paper_11x17.md

#### PAPER_11X17 property

11 x 17 inches.

### QUARTO property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/quarto.md

#### QUARTO property

8.47 x 10.83 inches.

### STATEMENT property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/statement.md

#### STATEMENT property

8.5 x 5.5 inches.

### TABLOID property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/tabloid.md

#### TABLOID property

11 x 17 inches.

### UNSET property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pagesize/unset.md

#### UNSET property

Unset paper size.

### PdfConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions.md

#### PdfConvertOptions class

The PdfConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| dpi |  |
| embed_full_fonts |  |
| fallback_page_size |  |
| format |  |
| margin_settings |  |
| orientation_settings |  |
| page_number |  |
| pages |  |
| pages_count |  |
| password |  |
| pdf_options |  |
| resize_mode |  |
| rotate |  |
| size_settings |  |
| watermark |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### dpi property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/dpi.md

##### Definition:
```python
@property
def dpi(self):
    ...
@dpi.setter
def dpi(self, value):
    ...
```

### embed_full_fonts property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/embed_full_fonts.md

##### Definition:
```python
@property
def embed_full_fonts(self):
    ...
@embed_full_fonts.setter
def embed_full_fonts(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### fallback_page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/fallback_page_size.md

##### Definition:
```python
@property
def fallback_page_size(self):
    ...
@fallback_page_size.setter
def fallback_page_size(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### margin_bottom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/margin_bottom.md

#### margin_bottom property

Implements `IPageMarginConvertOptions.margin_bottom`
##### Definition:
```python
@property
def margin_bottom(self):
    ...
@margin_bottom.setter
def margin_bottom(self, value):
    ...
```

### margin_left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/margin_left.md

#### margin_left property

Implements `IPageMarginConvertOptions.margin_left`
##### Definition:
```python
@property
def margin_left(self):
    ...
@margin_left.setter
def margin_left(self, value):
    ...
```

### margin_right property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/margin_right.md

#### margin_right property

Implements `IPageMarginConvertOptions.margin_right`
##### Definition:
```python
@property
def margin_right(self):
    ...
@margin_right.setter
def margin_right(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### margin_top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/margin_top.md

#### margin_top property

Implements `IPageMarginConvertOptions.margin_top`
##### Definition:
```python
@property
def margin_top(self):
    ...
@margin_top.setter
def margin_top(self, value):
    ...
```

### orientation_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/orientation_settings.md

##### Definition:
```python
@property
def orientation_settings(self):
    ...
@orientation_settings.setter
def orientation_settings(self, value):
    ...
```

### page_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/page_height.md

#### page_height property

Implements `IPageSizeConvertOptions.page_height`
##### Definition:
```python
@property
def page_height(self):
    ...
@page_height.setter
def page_height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### page_orientation property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/page_orientation.md

#### page_orientation property

Implements `IPageOrientationConvertOptions.page_orientation`
##### Definition:
```python
@property
def page_orientation(self):
    ...
@page_orientation.setter
def page_orientation(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/page_size.md

#### page_size property

Implements `IPageSizeConvertOptions.page_size`
##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/page_width.md

#### page_width property

Implements `IPageSizeConvertOptions.page_width`
##### Definition:
```python
@property
def page_width(self):
    ...
@page_width.setter
def page_width(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### pdf_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/pdf_options.md

##### Definition:
```python
@property
def pdf_options(self):
    ...
@pdf_options.setter
def pdf_options(self, value):
    ...
```

### resize_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/resize_mode.md

##### Definition:
```python
@property
def resize_mode(self):
    ...
@resize_mode.setter
def resize_mode(self, value):
    ...
```

### rotate property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/rotate.md

##### Definition:
```python
@property
def rotate(self):
    ...
@rotate.setter
def rotate(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### PdfDirection class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection.md

#### PdfDirection class

The PdfDirection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PdfDirection constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### L2R field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection/l2r.md

### R2L field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdirection/r2l.md

### PdfDocumentInfo class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo.md

#### PdfDocumentInfo class

The PdfDocumentInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| author |  |
| creation_date |  |
| creation_time_zone |  |
| creator |  |
| keywords |  |
| mod_date |  |
| mod_time_zone |  |
| producer |  |
| subject |  |
| title |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### author property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/author.md

##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/creation_date.md

##### Definition:
```python
@property
def creation_date(self):
    ...
@creation_date.setter
def creation_date(self, value):
    ...
```

### creation_time_zone property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/creation_time_zone.md

##### Definition:
```python
@property
def creation_time_zone(self):
    ...
@creation_time_zone.setter
def creation_time_zone(self, value):
    ...
```

### creator property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/creator.md

##### Definition:
```python
@property
def creator(self):
    ...
@creator.setter
def creator(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### keywords property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/keywords.md

##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### mod_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/mod_date.md

##### Definition:
```python
@property
def mod_date(self):
    ...
@mod_date.setter
def mod_date(self, value):
    ...
```

### mod_time_zone property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/mod_time_zone.md

##### Definition:
```python
@property
def mod_time_zone(self):
    ...
@mod_time_zone.setter
def mod_time_zone(self, value):
    ...
```

### producer property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/producer.md

##### Definition:
```python
@property
def producer(self):
    ...
@producer.setter
def producer(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/subject.md

##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfdocumentinfo/title.md

##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### PdfFontSubsetStrategy class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy.md

#### PdfFontSubsetStrategy class

The PdfFontSubsetStrategy type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PdfFontSubsetStrategy constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/none.md

### subset_all_fonts property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/subset_all_fonts.md

#### subset_all_fonts property

Subset all fonts, used in a document.

### subset_embedded_fonts_only property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/subset_embedded_fonts_only.md

#### subset_embedded_fonts_only property

Portrait page orientation (narrow and tall).

### SubsetAllFonts field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/subsetallfonts.md

### SubsetEmbeddedFontsOnly field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdffontsubsetstrategy/subsetembeddedfontsonly.md

### PdfFormats class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats.md

#### PdfFormats class

The PdfFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PdfFormats constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Default field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/default.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### PDF_A_1A property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_1a.md

#### PDF_A_1A property

PDF/A-1a – Level A (accessible) conformance.

### PDF_A_1B property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_1b.md

#### PDF_A_1B property

PDF/A-1b – Level B (basic) conformance.

### PDF_A_2A property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_2a.md

#### PDF_A_2A property

PDF/A-2a conformance.

### PDF_A_2B property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_2b.md

#### PDF_A_2B property

PDF/A-2b conformance.

### PDF_A_2U property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_2u.md

#### PDF_A_2U property

PDF/A-2u conformance.

### PDF_A_3A property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_3a.md

#### PDF_A_3A property

PDF/A-3a conformance.

### PDF_A_3B property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_3b.md

#### PDF_A_3B property

PDF/A-3b conformance.

### PDF_A_3U property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_a_3u.md

#### PDF_A_3U property

PDF/A-3u conformance.

### PDF_UA_1 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_ua_1.md

#### PDF_UA_1 property

PDF/UA-1 conformance.

### PDF_X_1A property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_x_1a.md

#### PDF_X_1A property

PDF/X-1a conformance.

### PDF_X_3 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdf_x_3.md

#### PDF_X_3 property

PDF/X-3 conformance.

### PdfA_1A field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_1a.md

### PdfA_1B field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_1b.md

### PdfA_2A field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_2a.md

### PdfA_2B field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_2b.md

### PdfA_2U field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_2u.md

### PdfA_3A field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_3a.md

### PdfA_3B field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_3b.md

### PdfA_3U field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_3u.md

### PdfA_4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_4.md

### PdfA_4E field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_4e.md

### PdfA_4F field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfa_4f.md

### PdfUA_1 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfua_1.md

### PdfX_1A field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfx_1a.md

### PdfX_3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/pdfx_3.md

### v1_3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v1_3.md

### v1_4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v1_4.md

### v1_5 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v1_5.md

### v1_6 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v1_6.md

### v1_7 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v1_7.md

### V_1_3 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v_1_3.md

#### V_1_3 property

PDF version 1.3.

### V_1_4 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v_1_4.md

#### V_1_4 property

PDF version 1.4.

### V_1_5 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v_1_5.md

#### V_1_5 property

PDF version 1.5.

### V_1_6 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v_1_6.md

#### V_1_6 property

PDF version 1.6.

### V_1_7 property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformats/v_1_7.md

#### V_1_7 property

PDF version 1.7.

### PdfFormattingOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions.md

#### PdfFormattingOptions class

The PdfFormattingOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| center_window |  |
| direction |  |
| display_doc_title |  |
| fit_window |  |
| hide_menu_bar |  |
| hide_tool_bar |  |
| hide_window_ui |  |
| non_full_screen_page_mode |  |
| page_layout |  |
| page_mode |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### center_window property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/center_window.md

##### Definition:
```python
@property
def center_window(self):
    ...
@center_window.setter
def center_window(self, value):
    ...
```

### direction property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/direction.md

##### Definition:
```python
@property
def direction(self):
    ...
@direction.setter
def direction(self, value):
    ...
```

### display_doc_title property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/display_doc_title.md

##### Definition:
```python
@property
def display_doc_title(self):
    ...
@display_doc_title.setter
def display_doc_title(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### fit_window property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/fit_window.md

##### Definition:
```python
@property
def fit_window(self):
    ...
@fit_window.setter
def fit_window(self, value):
    ...
```

### hide_menu_bar property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/hide_menu_bar.md

##### Definition:
```python
@property
def hide_menu_bar(self):
    ...
@hide_menu_bar.setter
def hide_menu_bar(self, value):
    ...
```

### hide_tool_bar property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/hide_tool_bar.md

##### Definition:
```python
@property
def hide_tool_bar(self):
    ...
@hide_tool_bar.setter
def hide_tool_bar(self, value):
    ...
```

### hide_window_ui property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/hide_window_ui.md

##### Definition:
```python
@property
def hide_window_ui(self):
    ...
@hide_window_ui.setter
def hide_window_ui(self, value):
    ...
```

### non_full_screen_page_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/non_full_screen_page_mode.md

##### Definition:
```python
@property
def non_full_screen_page_mode(self):
    ...
@non_full_screen_page_mode.setter
def non_full_screen_page_mode(self, value):
    ...
```

### page_layout property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/page_layout.md

##### Definition:
```python
@property
def page_layout(self):
    ...
@page_layout.setter
def page_layout(self, value):
    ...
```

### page_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfformattingoptions/page_mode.md

##### Definition:
```python
@property
def page_mode(self):
    ...
@page_mode.setter
def page_mode(self, value):
    ...
```

### PdfOptimizationOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions.md

#### PdfOptimizationOptions class

The PdfOptimizationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| compress_images |  |
| font_subset_strategy |  |
| image_quality |  |
| link_duplicate_streams |  |
| remove_unused_objects |  |
| remove_unused_streams |  |
| unembed_fonts |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compress_images property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/compress_images.md

##### Definition:
```python
@property
def compress_images(self):
    ...
@compress_images.setter
def compress_images(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_subset_strategy property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/font_subset_strategy.md

##### Definition:
```python
@property
def font_subset_strategy(self):
    ...
@font_subset_strategy.setter
def font_subset_strategy(self, value):
    ...
```

### image_quality property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/image_quality.md

##### Definition:
```python
@property
def image_quality(self):
    ...
@image_quality.setter
def image_quality(self, value):
    ...
```

### link_duplicate_streams property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/link_duplicate_streams.md

##### Definition:
```python
@property
def link_duplicate_streams(self):
    ...
@link_duplicate_streams.setter
def link_duplicate_streams(self, value):
    ...
```

### remove_unused_objects property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/remove_unused_objects.md

##### Definition:
```python
@property
def remove_unused_objects(self):
    ...
@remove_unused_objects.setter
def remove_unused_objects(self, value):
    ...
```

### remove_unused_streams property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/remove_unused_streams.md

##### Definition:
```python
@property
def remove_unused_streams(self):
    ...
@remove_unused_streams.setter
def remove_unused_streams(self, value):
    ...
```

### unembed_fonts property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptimizationoptions/unembed_fonts.md

##### Definition:
```python
@property
def unembed_fonts(self):
    ...
@unembed_fonts.setter
def unembed_fonts(self, value):
    ...
```

### PdfOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions.md

#### PdfOptions class

The PdfOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| document_info |  |
| formatting_options |  |
| grayscale |  |
| linearize |  |
| optimization_options |  |
| pdf_format |  |
| remove_pdf_acompliance |  |
| zoom |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### document_info property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/document_info.md

##### Definition:
```python
@property
def document_info(self):
    ...
@document_info.setter
def document_info(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### formatting_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/formatting_options.md

##### Definition:
```python
@property
def formatting_options(self):
    ...
@formatting_options.setter
def formatting_options(self, value):
    ...
```

### grayscale property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/grayscale.md

##### Definition:
```python
@property
def grayscale(self):
    ...
@grayscale.setter
def grayscale(self, value):
    ...
```

### linearize property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/linearize.md

##### Definition:
```python
@property
def linearize(self):
    ...
@linearize.setter
def linearize(self, value):
    ...
```

### optimization_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/optimization_options.md

##### Definition:
```python
@property
def optimization_options(self):
    ...
@optimization_options.setter
def optimization_options(self, value):
    ...
```

### pdf_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/pdf_format.md

##### Definition:
```python
@property
def pdf_format(self):
    ...
@pdf_format.setter
def pdf_format(self, value):
    ...
```

### remove_pdf_a_compliance property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/remove_pdf_a_compliance.md

#### remove_pdf_a_compliance property

The setting that removes PDF/A compliance.

##### Definition:
```python
@property
def remove_pdf_a_compliance(self):
    ...
@remove_pdf_a_compliance.setter
def remove_pdf_a_compliance(self, value):
    ...
```

### remove_pdf_acompliance property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/remove_pdf_acompliance.md

##### Definition:
```python
@property
def remove_pdf_acompliance(self):
    ...
@remove_pdf_acompliance.setter
def remove_pdf_acompliance(self, value):
    ...
```

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### PdfPageLayout class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout.md

#### PdfPageLayout class

The PdfPageLayout type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PdfPageLayout constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Default field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/default.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### ONE_COLUMN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/one_column.md

#### ONE_COLUMN property

Display pages in one column.

### OneColumn field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/onecolumn.md

### SINGLE_PAGE property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/single_page.md

#### SINGLE_PAGE property

Single page.

### SinglePage field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/singlepage.md

### TWO_COLUMN_LEFT property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/two_column_left.md

#### TWO_COLUMN_LEFT property

Display the pages in two columns, with odd-numbered pages on the left.

### TWO_COLUMN_RIGHT property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/two_column_right.md

#### TWO_COLUMN_RIGHT property

Display the pages in two columns, with odd-numbered pages on the right.

### TWO_PAGES_LEFT property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/two_pages_left.md

#### TWO_PAGES_LEFT property

Display the pages two at a time, with odd-numbered pages on the left.

### TWO_PAGES_RIGHT property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/two_pages_right.md

#### TWO_PAGES_RIGHT property

Display the pages two at a time, with odd-numbered pages on the right.

### TwoColumnLeft field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/twocolumnleft.md

### TwoColumnRight field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/twocolumnright.md

### TwoPagesLeft field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/twopagesleft.md

### TwoPagesRight field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagelayout/twopagesright.md

### PdfPageMode class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode.md

#### PdfPageMode class

The PdfPageMode type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PdfPageMode constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### FULL_SCREEN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/full_screen.md

#### FULL_SCREEN property

FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.

### FullScreen field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/fullscreen.md

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### USE_ATTACHMENTS property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/use_attachments.md

#### USE_ATTACHMENTS property

Attachments panel visible.

### USE_NONE property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/use_none.md

#### USE_NONE property

Don't use any components.

### USE_OC property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/use_oc.md

#### USE_OC property

Optional content group panel visible.

### USE_OUTLINES property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/use_outlines.md

#### USE_OUTLINES property

Document outline visible.

### USE_THUMBS property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/use_thumbs.md

#### USE_THUMBS property

Thumbnail images visible.

### UseAttachments field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/useattachments.md

### UseNone field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/usenone.md

### UseOC field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/useoc.md

### UseOutlines field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/useoutlines.md

### UseThumbs field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfpagemode/usethumbs.md

### PdfRecognitionMode class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfrecognitionmode.md

#### PdfRecognitionMode class

The PdfRecognitionMode type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PdfRecognitionMode constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfrecognitionmode/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfrecognitionmode/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfrecognitionmode/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### Flow field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfrecognitionmode/flow.md

### Textbox field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/pdfrecognitionmode/textbox.md

### PresentationConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions.md

#### PresentationConvertOptions class

The PresentationConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| page_number |  |
| pages |  |
| pages_count |  |
| password |  |
| watermark |  |
| zoom |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/presentationconvertoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### ProjectManagementConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/projectmanagementconvertoptions.md

#### ProjectManagementConvertOptions class

The ProjectManagementConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/projectmanagementconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/projectmanagementconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/projectmanagementconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/projectmanagementconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/projectmanagementconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### PsdColorModes class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes.md

#### PsdColorModes class

The PsdColorModes type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PsdColorModes constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### Bitmap field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/bitmap.md

### Cmyk field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/cmyk.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### Duotone field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/duotone.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### Grayscale field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/grayscale.md

### Indexed field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/indexed.md

### Lab field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/lab.md

### Multichannel field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/multichannel.md

### Rgb field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcolormodes/rgb.md

### PsdCompressionMethods class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods.md

#### PsdCompressionMethods class

The PsdCompressionMethods type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PsdCompressionMethods constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### Raw field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/raw.md

### Rle field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/rle.md

### ZIP_WITH_PREDICTION property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/zip_with_prediction.md

#### ZIP_WITH_PREDICTION property

ZipWithPrediction.

### ZIP_WITHOUT_PREDICTION property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/zip_without_prediction.md

#### ZIP_WITHOUT_PREDICTION property

ZipWithoutPrediction.

### ZipWithoutPrediction field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/zipwithoutprediction.md

### ZipWithPrediction field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdcompressionmethods/zipwithprediction.md

### PsdOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions.md

#### PsdOptions class

The PsdOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| channel_bits_count |  |
| channels_count |  |
| color_mode |  |
| compression |  |
| version |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### channel_bits_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/channel_bits_count.md

##### Definition:
```python
@property
def channel_bits_count(self):
    ...
@channel_bits_count.setter
def channel_bits_count(self, value):
    ...
```

### channels_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/channels_count.md

##### Definition:
```python
@property
def channels_count(self):
    ...
@channels_count.setter
def channels_count(self, value):
    ...
```

### color_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/color_mode.md

##### Definition:
```python
@property
def color_mode(self):
    ...
@color_mode.setter
def color_mode(self, value):
    ...
```

### compression property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/compression.md

##### Definition:
```python
@property
def compression(self):
    ...
@compression.setter
def compression(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### version property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/psdoptions/version.md

##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### Rotation class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation.md

#### Rotation class

The Rotation type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### Rotation constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/none.md

### On180 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/on180.md

### On270 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/on270.md

### On90 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rotation/on90.md

### RtfOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rtfoptions.md

#### RtfOptions class

The RtfOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| export_images_for_old_readers |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rtfoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rtfoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rtfoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### export_images_for_old_readers property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/rtfoptions/export_images_for_old_readers.md

##### Definition:
```python
@property
def export_images_for_old_readers(self):
    ...
@export_images_for_old_readers.setter
def export_images_for_old_readers(self, value):
    ...
```

### SpreadsheetConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions.md

#### SpreadsheetConvertOptions class

The SpreadsheetConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| encoding |  |
| format |  |
| page_number |  |
| pages |  |
| pages_count |  |
| password |  |
| separator |  |
| watermark |  |
| zoom |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### separator property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/separator.md

##### Definition:
```python
@property
def separator(self):
    ...
@separator.setter
def separator(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/spreadsheetconvertoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### ThreeDConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions.md

#### ThreeDConvertOptions class

The ThreeDConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| page_number |  |
| pages_count |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/threedconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### TiffCompressionMethods class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods.md

#### TiffCompressionMethods class

The TiffCompressionMethods type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### TiffCompressionMethods constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### Ccitt3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/ccitt3.md

### Ccitt4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/ccitt4.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### Lzw field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/lzw.md

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/none.md

### Rle field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffcompressionmethods/rle.md

### TiffOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffoptions.md

#### TiffOptions class

The TiffOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| compression |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compression property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffoptions/compression.md

##### Definition:
```python
@property
def compression(self):
    ...
@compression.setter
def compression(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/tiffoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### VideoConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions.md

#### VideoConvertOptions class

The VideoConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| audio_format |  |
| extract_audio_only |  |
| format |  |
| frames_per_second |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### audio_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions/audio_format.md

##### Definition:
```python
@property
def audio_format(self):
    ...
@audio_format.setter
def audio_format(self, value):
    ...
```

### extract_audio_only property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions/extract_audio_only.md

##### Definition:
```python
@property
def extract_audio_only(self):
    ...
@extract_audio_only.setter
def extract_audio_only(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### frames_per_second property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/videoconvertoptions/frames_per_second.md

##### Definition:
```python
@property
def frames_per_second(self):
    ...
@frames_per_second.setter
def frames_per_second(self, value):
    ...
```

### WatermarkImageOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions.md

#### WatermarkImageOptions class

The WatermarkImageOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte_array |  |
| _clone_noargs |  (inherited from `WatermarkOptions`) |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| clone |  (inherited from `WatermarkOptions`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| image |  |
| auto_align |  (inherited from `WatermarkOptions`) |
| background |  (inherited from `WatermarkOptions`) |
| height |  (inherited from `WatermarkOptions`) |
| left |  (inherited from `WatermarkOptions`) |
| rotation_angle |  (inherited from `WatermarkOptions`) |
| top |  (inherited from `WatermarkOptions`) |
| transparency |  (inherited from `WatermarkOptions`) |
| width |  (inherited from `WatermarkOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte_array method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/_init_byte_array.md

#### _init_byte_array

```python
def _init_byte_array(self, image):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image | `bytes` |  |

### auto_align property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/auto_align.md

#### auto_align property

Auto scale the watermark. If the value is true the position and size is automatically calculated to fit the page size.

### background property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/background.md

#### background property

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/clone.md

#### clone

Clone current instance

##### Returns

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/height.md

#### height property

Watermark height

### image property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/image.md

##### Definition:
```python
@property
def image(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/left.md

#### left property

Watermark left position

### rotation_angle property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/rotation_angle.md

#### rotation_angle property

Watermark rotation angle

### top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/top.md

#### top property

Watermark top position

### transparency property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/transparency.md

#### transparency property

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkimageoptions/width.md

#### width property

Watermark width

### WatermarkOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions.md

#### WatermarkOptions class

The WatermarkOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| auto_align |  |
| background |  |
| height |  |
| left |  |
| rotation_angle |  |
| top |  |
| transparency |  |
| width |  |

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### auto_align property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/auto_align.md

##### Definition:
```python
@property
def auto_align(self):
    ...
@auto_align.setter
def auto_align(self, value):
    ...
```

### background property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/background.md

##### Definition:
```python
@property
def background(self):
    ...
@background.setter
def background(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/left.md

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### rotation_angle property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/rotation_angle.md

##### Definition:
```python
@property
def rotation_angle(self):
    ...
@rotation_angle.setter
def rotation_angle(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/top.md

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/transparency.md

##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarkoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### WatermarkTextOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions.md

#### WatermarkTextOptions class

The WatermarkTextOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |
| _clone_noargs |  (inherited from `WatermarkOptions`) |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| clone |  (inherited from `WatermarkOptions`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| color |  |
| text |  |
| watermark_font |  |
| auto_align |  (inherited from `WatermarkOptions`) |
| background |  (inherited from `WatermarkOptions`) |
| height |  (inherited from `WatermarkOptions`) |
| left |  (inherited from `WatermarkOptions`) |
| rotation_angle |  (inherited from `WatermarkOptions`) |
| top |  (inherited from `WatermarkOptions`) |
| transparency |  (inherited from `WatermarkOptions`) |
| width |  (inherited from `WatermarkOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/_init_string.md

#### _init_string

```python
def _init_string(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` |  |

### auto_align property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/auto_align.md

#### auto_align property

Auto scale the watermark. If the value is true the position and size is automatically calculated to fit the page size.

### background property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/background.md

#### background property

Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/clone.md

#### clone

Clone current instance

##### Returns

```python
def clone(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/color.md

##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/height.md

#### height property

Watermark height

### left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/left.md

#### left property

Watermark left position

### rotation_angle property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/rotation_angle.md

#### rotation_angle property

Watermark rotation angle

### text property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/text.md

##### Definition:
```python
@property
def text(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/top.md

#### top property

Watermark top position

### transparency property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/transparency.md

#### transparency property

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.

### watermark_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/watermark_font.md

##### Definition:
```python
@property
def watermark_font(self):
    ...
@watermark_font.setter
def watermark_font(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/watermarktextoptions/width.md

#### width property

Watermark width

### WebConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions.md

#### WebConvertOptions class

The WebConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| embed_font_resources |  |
| fixed_layout |  |
| fixed_layout_show_borders |  |
| format |  |
| page_number |  |
| pages |  |
| pages_count |  |
| use_pdf |  |
| watermark |  |
| zoom |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### embed_font_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/embed_font_resources.md

##### Definition:
```python
@property
def embed_font_resources(self):
    ...
@embed_font_resources.setter
def embed_font_resources(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### fixed_layout property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/fixed_layout.md

##### Definition:
```python
@property
def fixed_layout(self):
    ...
@fixed_layout.setter
def fixed_layout(self, value):
    ...
```

### fixed_layout_show_borders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/fixed_layout_show_borders.md

##### Definition:
```python
@property
def fixed_layout_show_borders(self):
    ...
@fixed_layout_show_borders.setter
def fixed_layout_show_borders(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### use_pdf property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/use_pdf.md

##### Definition:
```python
@property
def use_pdf(self):
    ...
@use_pdf.setter
def use_pdf(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webconvertoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### WebpOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webpoptions.md

#### WebpOptions class

The WebpOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| lossless |  |
| quality |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webpoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webpoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webpoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### lossless property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webpoptions/lossless.md

##### Definition:
```python
@property
def lossless(self):
    ...
@lossless.setter
def lossless(self, value):
    ...
```

### quality property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/webpoptions/quality.md

##### Definition:
```python
@property
def quality(self):
    ...
@quality.setter
def quality(self, value):
    ...
```

### WordProcessingConvertOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions.md

#### WordProcessingConvertOptions class

The WordProcessingConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| dpi |  |
| fallback_page_size |  |
| format |  |
| margin_settings |  |
| markdown_options |  |
| orientation_settings |  |
| page_number |  |
| pages |  |
| pages_count |  |
| password |  |
| pdf_recognition_mode |  |
| rtf_options |  |
| size_settings |  |
| watermark |  |
| zoom |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/clone.md

#### clone

Clones current options instance.

##### Returns

```python
def clone(self):
    ...
```

### dpi property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/dpi.md

##### Definition:
```python
@property
def dpi(self):
    ...
@dpi.setter
def dpi(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### fallback_page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/fallback_page_size.md

##### Definition:
```python
@property
def fallback_page_size(self):
    ...
@fallback_page_size.setter
def fallback_page_size(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### margin_bottom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/margin_bottom.md

#### margin_bottom property

Implements `IPageMarginConvertOptions.margin_bottom`
##### Definition:
```python
@property
def margin_bottom(self):
    ...
@margin_bottom.setter
def margin_bottom(self, value):
    ...
```

### margin_left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/margin_left.md

#### margin_left property

Implements `IPageMarginConvertOptions.margin_left`
##### Definition:
```python
@property
def margin_left(self):
    ...
@margin_left.setter
def margin_left(self, value):
    ...
```

### margin_right property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/margin_right.md

#### margin_right property

Implements `IPageMarginConvertOptions.margin_right`
##### Definition:
```python
@property
def margin_right(self):
    ...
@margin_right.setter
def margin_right(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### margin_top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/margin_top.md

#### margin_top property

Implements `IPageMarginConvertOptions.margin_top`
##### Definition:
```python
@property
def margin_top(self):
    ...
@margin_top.setter
def margin_top(self, value):
    ...
```

### markdown_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/markdown_options.md

##### Definition:
```python
@property
def markdown_options(self):
    ...
@markdown_options.setter
def markdown_options(self, value):
    ...
```

### orientation_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/orientation_settings.md

##### Definition:
```python
@property
def orientation_settings(self):
    ...
@orientation_settings.setter
def orientation_settings(self, value):
    ...
```

### page_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/page_height.md

#### page_height property

Implements `IPageSizeConvertOptions.page_height`
##### Definition:
```python
@property
def page_height(self):
    ...
@page_height.setter
def page_height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### page_orientation property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/page_orientation.md

#### page_orientation property

Implements `IPageOrientationConvertOptions.page_orientation`
##### Definition:
```python
@property
def page_orientation(self):
    ...
@page_orientation.setter
def page_orientation(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/page_size.md

#### page_size property

Implements `IPageSizeConvertOptions.page_size`
##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/page_width.md

#### page_width property

Implements `IPageSizeConvertOptions.page_width`
##### Definition:
```python
@property
def page_width(self):
    ...
@page_width.setter
def page_width(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### pages_count property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/pages_count.md

##### Definition:
```python
@property
def pages_count(self):
    ...
@pages_count.setter
def pages_count(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### pdf_recognition_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/pdf_recognition_mode.md

##### Definition:
```python
@property
def pdf_recognition_mode(self):
    ...
@pdf_recognition_mode.setter
def pdf_recognition_mode(self, value):
    ...
```

### rtf_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/rtf_options.md

##### Definition:
```python
@property
def rtf_options(self):
    ...
@rtf_options.setter
def rtf_options(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.convert/wordprocessingconvertoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### groupdocs.conversion.options.load
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load.md

Types under `groupdocs.conversion.options.load`.

##### Classes
| Class | Description |
| :- | :- |
| `AttachmentIcon` |  |
| `AudioLoadOptions` |  |
| `BaseImageLoadOptions` |  |
| `CadLoadOptions` |  |
| `CompressionLoadOptions` |  |
| `CsvLoadOptions` |  |
| `DatabaseLoadOptions` |  |
| `DiagramLoadOptions` |  |
| `EBookLoadOptions` |  |
| `EmailLoadOptions` |  |
| `EpubLoadOptions` |  |
| `FinanceLoadOptions` |  |
| `FontLoadOptions` |  |
| `GisLoadOptions` |  |
| `GmlLoadOptions` |  |
| `HyphenationOptions` |  |
| `ICustomCssStyleOptions` |  |
| `IFontSubstituteLoadOptions` |  |
| `IFontTransformationLoadOptions` |  |
| `IMetadataLoadOptions` |  |
| `IPageNumberingLoadOptions` |  |
| `IResourceLoadingOptions` |  |
| `ImageLoadOptions` |  |
| `LoadOptions` |  |
| `MboxLoadOptions` |  |
| `NoteLoadOptions` |  |
| `NsfLoadOptions` |  |
| `OlmLoadOptions` |  |
| `PageDescriptionLanguageLoadOptions` |  |
| `PclLoadOptions` |  |
| `PdfLoadOptions` |  |
| `PersonalStorageLoadOptions` |  |
| `PresentationLoadOptions` |  |
| `PublisherLoadOptions` |  |
| `RasterImageLoadOptions` |  |
| `SpreadsheetLoadOptions` |  |
| `SvgLoadOptions` |  |
| `ThreeDLoadOptions` |  |
| `TsvLoadOptions` |  |
| `TxtLoadOptions` |  |
| `VcfLoadOptions` |  |
| `VectorizationOptions` |  |
| `VideoLoadOptions` |  |
| `WebLoadOptions` |  |
| `WordProcessingBookmarksOptions` |  |
| `WordProcessingLoadOptions` |  |
| `XmlLoadOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `CadDrawTypeMode` |  |
| `EmailField` |  |
| `HtmlRenderingModes` |  |
| `PageLayoutOptions` |  |
| `PresentationCommentsPosition` |  |
| `PresentationNotesPosition` |  |
| `SpreadsheetPrintComments` |  |
| `TxtLeadingSpacesOptions` |  |
| `TxtTrailingSpacesOptions` |  |
| `WordProcessingCommentDisplay` |  |

### AttachmentIcon class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon.md

#### AttachmentIcon class

The AttachmentIcon type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_object_data_serialization_info_streaming_context |  |
| _init_string_byte_array |  |
| get_object_data |  |
| get_object_data_serialization_info |  |

##### Properties
| Property | Description |
| :- | :- |
| file_extension |  |
| icon_data |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_object_data_serialization_info_streaming_context method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/_get_object_data_serialization_info_streaming_context.md

#### _get_object_data_serialization_info_streaming_context

```python
def _get_object_data_serialization_info_streaming_context(self, info, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| info | `SerializationInfo` |  |
| context | `StreamingContext` |  |

### _init_string_byte_array method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/_init_string_byte_array.md

#### _init_string_byte_array

```python
def _init_string_byte_array(self, file_extension, icon_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | `str` |  |
| icon_data | `bytes` |  |

### file_extension property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/file_extension.md

##### Definition:
```python
@property
def file_extension(self):
    ...
```

### get_object_data method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/get_object_data.md

#### get_object_data

```python
def get_object_data(self):
    ...
```

### get_object_data_serialization_info method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/get_object_data_serialization_info.md

#### get_object_data_serialization_info

```python
def get_object_data_serialization_info(self):
    ...
```

### icon_data property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/attachmenticon/icon_data.md

##### Definition:
```python
@property
def icon_data(self):
    ...
```

### AudioLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions.md

#### AudioLoadOptions class

The AudioLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _set_audio_connector_iaudio_connector |  |
| set_audio_connector |  |
| set_audio_connector_iaudio_connector |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _set_audio_connector_iaudio_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions/_set_audio_connector_iaudio_connector.md

#### _set_audio_connector_iaudio_connector

```python
def _set_audio_connector_iaudio_connector(self, audio_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| audio_connector | `IAudioConnector` |  |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### set_audio_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions/set_audio_connector.md

#### set_audio_connector

```python
def set_audio_connector(self):
    ...
```

### set_audio_connector_iaudio_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/audioloadoptions/set_audio_connector_iaudio_connector.md

#### set_audio_connector_iaudio_connector

```python
def set_audio_connector_iaudio_connector(self):
    ...
```

### BaseImageLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/baseimageloadoptions.md

#### BaseImageLoadOptions class

The BaseImageLoadOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| default_font |  |
| format |  |
| reset_font_folders |  |

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/baseimageloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/baseimageloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/baseimageloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### reset_font_folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/baseimageloadoptions/reset_font_folders.md

##### Definition:
```python
@property
def reset_font_folders(self):
    ...
@reset_font_folders.setter
def reset_font_folders(self, value):
    ...
```

### CadDrawTypeMode class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode.md

#### CadDrawTypeMode class

The CadDrawTypeMode type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### CadDrawTypeMode constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### USE_DRAW_COLOR property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/use_draw_color.md

#### USE_DRAW_COLOR property

Allows to use common color.

### USE_OBJECT_COLOR property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/use_object_color.md

#### USE_OBJECT_COLOR property

Allows to use separate color for every object.

### UseDrawColor field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/usedrawcolor.md

### UseObjectColor field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/caddrawtypemode/useobjectcolor.md

### CadLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions.md

#### CadLoadOptions class

The CadLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color |  |
| ctb_sources |  |
| draw_color |  |
| draw_type |  |
| format |  |
| layout_names |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/background_color.md

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### ctb_sources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/ctb_sources.md

##### Definition:
```python
@property
def ctb_sources(self):
    ...
@ctb_sources.setter
def ctb_sources(self, value):
    ...
```

### draw_color property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/draw_color.md

##### Definition:
```python
@property
def draw_color(self):
    ...
@draw_color.setter
def draw_color(self, value):
    ...
```

### draw_type property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/draw_type.md

##### Definition:
```python
@property
def draw_type(self):
    ...
@draw_type.setter
def draw_type(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### layout_names property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/cadloadoptions/layout_names.md

##### Definition:
```python
@property
def layout_names(self):
    ...
@layout_names.setter
def layout_names(self, value):
    ...
```

### CompressionLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions.md

#### CompressionLoadOptions class

The CompressionLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| convert_owned |  |
| convert_owner |  |
| depth |  |
| format |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/compressionloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### CsvLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions.md

#### CsvLoadOptions class

The CsvLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _clone_noargs |  (inherited from `SpreadsheetLoadOptions`) |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| clone |  (inherited from `SpreadsheetLoadOptions`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |
| convert_date_time_data |  |
| convert_numeric_data |  |
| convert_owned |  |
| convert_owner |  |
| default_font |  |
| depth |  |
| encoding |  |
| font_substitutes |  |
| format |  |
| has_formula |  |
| is_multi_encoded |  |
| margin_settings |  |
| separator |  |
| size_settings |  |
| skip_external_resources |  |
| whitelisted_resources |  |
| all_columns_in_one_page_per_sheet |  (inherited from `SpreadsheetLoadOptions`) |
| auto_fit_rows |  (inherited from `SpreadsheetLoadOptions`) |
| check_excel_restriction |  (inherited from `SpreadsheetLoadOptions`) |
| columns_per_page |  (inherited from `SpreadsheetLoadOptions`) |
| convert_range |  (inherited from `SpreadsheetLoadOptions`) |
| culture_info |  (inherited from `SpreadsheetLoadOptions`) |
| ignore_formula_calculation_errors |  (inherited from `SpreadsheetLoadOptions`) |
| one_page_per_sheet |  (inherited from `SpreadsheetLoadOptions`) |
| optimize_pdf_size |  (inherited from `SpreadsheetLoadOptions`) |
| password |  (inherited from `SpreadsheetLoadOptions`) |
| preserve_document_structure |  (inherited from `SpreadsheetLoadOptions`) |
| print_comments |  (inherited from `SpreadsheetLoadOptions`) |
| reset_font_folders |  (inherited from `SpreadsheetLoadOptions`) |
| rows_per_page |  (inherited from `SpreadsheetLoadOptions`) |
| sheet_indexes |  (inherited from `SpreadsheetLoadOptions`) |
| sheets |  (inherited from `SpreadsheetLoadOptions`) |
| show_grid_lines |  (inherited from `SpreadsheetLoadOptions`) |
| show_hidden_sheets |  (inherited from `SpreadsheetLoadOptions`) |
| skip_empty_rows_and_columns |  (inherited from `SpreadsheetLoadOptions`) |
| skip_footers |  (inherited from `SpreadsheetLoadOptions`) |
| skip_headers |  (inherited from `SpreadsheetLoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### all_columns_in_one_page_per_sheet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/all_columns_in_one_page_per_sheet.md

#### all_columns_in_one_page_per_sheet property

If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

### auto_fit_rows property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/auto_fit_rows.md

#### auto_fit_rows property

Autofits all rows when converting

### check_excel_restriction property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/check_excel_restriction.md

#### check_excel_restriction property

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/clone.md

#### clone

Clones current instance.

##### Returns

```python
def clone(self):
    ...
```

### columns_per_page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/columns_per_page.md

#### columns_per_page property

Split a worksheet into pages by columns. Default is 0, no pagination.

### convert_date_time_data property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/convert_date_time_data.md

##### Definition:
```python
@property
def convert_date_time_data(self):
    ...
@convert_date_time_data.setter
def convert_date_time_data(self, value):
    ...
```

### convert_numeric_data property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/convert_numeric_data.md

##### Definition:
```python
@property
def convert_numeric_data(self):
    ...
@convert_numeric_data.setter
def convert_numeric_data(self, value):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### convert_range property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/convert_range.md

#### convert_range property

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

### culture_info property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/culture_info.md

#### culture_info property

Get or set the system culture info at the time file is loaded, e.g. "en-US".

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### has_formula property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/has_formula.md

##### Definition:
```python
@property
def has_formula(self):
    ...
@has_formula.setter
def has_formula(self, value):
    ...
```

### hide_comments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/hide_comments.md

#### hide_comments property

Hide comments.

### is_multi_encoded property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/is_multi_encoded.md

##### Definition:
```python
@property
def is_multi_encoded(self):
    ...
@is_multi_encoded.setter
def is_multi_encoded(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### one_page_per_sheet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/one_page_per_sheet.md

#### one_page_per_sheet property

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.

### optimize_pdf_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/optimize_pdf_size.md

#### optimize_pdf_size property

If True and converting to Pdf the conversion is optimized for better file size than print quality.

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/password.md

#### password property

Set password to unprotect protected document.

### rows_per_page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/rows_per_page.md

#### rows_per_page property

Split a worksheet into pages by rows. Default is 0, no pagination.

### separator property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/separator.md

##### Definition:
```python
@property
def separator(self):
    ...
@separator.setter
def separator(self, value):
    ...
```

### sheet_indexes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/sheet_indexes.md

#### sheet_indexes property

List of sheet indexes to convert.
The indexes must be zero-based

### sheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/sheets.md

#### sheets property

Sheet name to convert

### show_grid_lines property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/show_grid_lines.md

#### show_grid_lines property

Show grid lines when converting Excel files.

### show_hidden_sheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/show_hidden_sheets.md

#### show_hidden_sheets property

Show hidden sheets when converting Excel files.

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### skip_empty_rows_and_columns property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/skip_empty_rows_and_columns.md

#### skip_empty_rows_and_columns property

Skips empty rows and columns when converting. Default is True.

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/csvloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### CtbSource class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ctbsource.md

#### CtbSource class

Represents a CTB source with a name and associated data stream.

The CtbSource type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `CtbSource` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the CTB source. |
| data | Gets the data stream associated with the CTB source. |

### CtbSource constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ctbsource/__init__.md

#### __init__

Initializes a new instance of the `CtbSource` class.

```python
def __init__(self, name, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the CTB source. |
| data | io.RawIOBase | The data stream associated with the CTB source. |

### data property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ctbsource/data.md

#### data property

Gets the data stream associated with the CTB source.
##### Definition:
```python
@property
def data(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ctbsource/name.md

#### name property

Gets the name of the CTB source.
##### Definition:
```python
@property
def name(self):
    ...
```

### DatabaseLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/databaseloadoptions.md

#### DatabaseLoadOptions class

The DatabaseLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/databaseloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/databaseloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/databaseloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/databaseloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### DiagramLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/diagramloadoptions.md

#### DiagramLoadOptions class

The DiagramLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| default_font |  |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/diagramloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/diagramloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/diagramloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/diagramloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/diagramloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### EBookLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ebookloadoptions.md

#### EBookLoadOptions class

The EBookLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ebookloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ebookloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ebookloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ebookloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### EmailField class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield.md

#### EmailField class

The EmailField type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### EmailField constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### Attachments field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/attachments.md

### Bcc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/bcc.md

### Cc field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/cc.md

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### End field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/end.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### From field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/from.md

### Importance field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/importance.md

### Location field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/location.md

### Organizer field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/organizer.md

### PAGE_HEADER property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/page_header.md

#### PAGE_HEADER property

Default field text is "PageHeader".

### PageHeader field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/pageheader.md

### Recurrence field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/recurrence.md

### RECURRENCE_PATTERN property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/recurrence_pattern.md

#### RECURRENCE_PATTERN property

Default field text is "RecurrencePattern".

### RecurrencePattern field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/recurrencepattern.md

### REQUIRED_ATTENDEES property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/required_attendees.md

#### REQUIRED_ATTENDEES property

Default field text is "RequiredAttendees".

### RequiredAttendees field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/requiredattendees.md

### Sent field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/sent.md

### SHOW_TIME_AS property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/show_time_as.md

#### SHOW_TIME_AS property

Default field text is "ShowTimeAs".

### ShowTimeAs field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/showtimeas.md

### Start field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/start.md

### Subject field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/subject.md

### TAB_FIELD property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/tab_field.md

#### TAB_FIELD property

Default field text is "TabField".

### TabField field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/tabfield.md

### To field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfield/to.md

### EmailFieldText class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfieldtext.md

#### EmailFieldText class

Represents a mapping between an email field and its text representation.

The EmailFieldText type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EmailFieldText` class. |

##### Properties
| Property | Description |
| :- | :- |
| email_field | Gets the email field. |
| text_representation | Gets the text representation of the email field. |

### EmailFieldText constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfieldtext/__init__.md

#### __init__

Initializes a new instance of the `EmailFieldText` class.

```python
def __init__(self, email_field, text_representation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| email_field | groupdocs.conversion.options.load.EmailField | The email field. |
| text_representation | System.String | The text representation of the email field. |

### email_field property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfieldtext/email_field.md

#### email_field property

Gets the email field.
##### Definition:
```python
@property
def email_field(self):
    ...
```

### text_representation property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailfieldtext/text_representation.md

#### text_representation property

Gets the text representation of the email field.
##### Definition:
```python
@property
def text_representation(self):
    ...
```

### EmailLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions.md

#### EmailLoadOptions class

The EmailLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| attachment_icons |  |
| convert_owned |  |
| convert_owner |  |
| custom_css_style |  |
| default_font |  |
| depth |  |
| display_attachments |  |
| display_bcc_email_address |  |
| display_cc_email_address |  |
| display_email_addresses |  |
| display_from_email_address |  |
| display_header |  |
| display_sent |  |
| display_subject |  |
| display_to_email_address |  |
| field_text_map |  |
| font_substitutes |  |
| format |  |
| margin_settings |  |
| orientation_settings |  |
| preserve_original_date |  |
| resource_loading_timeout |  |
| size_settings |  |
| skip_external_resources |  |
| time_zone_offset |  |
| use_default_attachment_icons |  |
| whitelisted_resources |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### attachment_icons property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/attachment_icons.md

##### Definition:
```python
@property
def attachment_icons(self):
    ...
@attachment_icons.setter
def attachment_icons(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
@convert_owned.setter
def convert_owned(self, value):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
@convert_owner.setter
def convert_owner(self, value):
    ...
```

### custom_css_style property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/custom_css_style.md

##### Definition:
```python
@property
def custom_css_style(self):
    ...
@custom_css_style.setter
def custom_css_style(self, value):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### display_attachments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_attachments.md

##### Definition:
```python
@property
def display_attachments(self):
    ...
@display_attachments.setter
def display_attachments(self, value):
    ...
```

### display_bcc_email_address property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_bcc_email_address.md

##### Definition:
```python
@property
def display_bcc_email_address(self):
    ...
@display_bcc_email_address.setter
def display_bcc_email_address(self, value):
    ...
```

### display_cc_email_address property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_cc_email_address.md

##### Definition:
```python
@property
def display_cc_email_address(self):
    ...
@display_cc_email_address.setter
def display_cc_email_address(self, value):
    ...
```

### display_email_addresses property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_email_addresses.md

##### Definition:
```python
@property
def display_email_addresses(self):
    ...
@display_email_addresses.setter
def display_email_addresses(self, value):
    ...
```

### display_from_email_address property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_from_email_address.md

##### Definition:
```python
@property
def display_from_email_address(self):
    ...
@display_from_email_address.setter
def display_from_email_address(self, value):
    ...
```

### display_header property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_header.md

##### Definition:
```python
@property
def display_header(self):
    ...
@display_header.setter
def display_header(self, value):
    ...
```

### display_sent property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_sent.md

##### Definition:
```python
@property
def display_sent(self):
    ...
@display_sent.setter
def display_sent(self, value):
    ...
```

### display_subject property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_subject.md

##### Definition:
```python
@property
def display_subject(self):
    ...
@display_subject.setter
def display_subject(self, value):
    ...
```

### display_to_email_address property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/display_to_email_address.md

##### Definition:
```python
@property
def display_to_email_address(self):
    ...
@display_to_email_address.setter
def display_to_email_address(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### field_text_map property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/field_text_map.md

##### Definition:
```python
@property
def field_text_map(self):
    ...
@field_text_map.setter
def field_text_map(self, value):
    ...
```

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### orientation_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/orientation_settings.md

##### Definition:
```python
@property
def orientation_settings(self):
    ...
@orientation_settings.setter
def orientation_settings(self, value):
    ...
```

### preserve_original_date property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/preserve_original_date.md

##### Definition:
```python
@property
def preserve_original_date(self):
    ...
@preserve_original_date.setter
def preserve_original_date(self, value):
    ...
```

### resource_loading_timeout property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/resource_loading_timeout.md

##### Definition:
```python
@property
def resource_loading_timeout(self):
    ...
@resource_loading_timeout.setter
def resource_loading_timeout(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### time_zone_offset property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/time_zone_offset.md

##### Definition:
```python
@property
def time_zone_offset(self):
    ...
@time_zone_offset.setter
def time_zone_offset(self, value):
    ...
```

### use_default_attachment_icons property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/use_default_attachment_icons.md

##### Definition:
```python
@property
def use_default_attachment_icons(self):
    ...
@use_default_attachment_icons.setter
def use_default_attachment_icons(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/emailloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### EpubLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/epubloadoptions.md

#### EpubLoadOptions class

The EpubLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/epubloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/epubloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/epubloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/epubloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### FinanceLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/financeloadoptions.md

#### FinanceLoadOptions class

The FinanceLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/financeloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/financeloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/financeloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/financeloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### FontLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/fontloadoptions.md

#### FontLoadOptions class

The FontLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/fontloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/fontloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/fontloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/fontloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### GisLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions.md

#### GisLoadOptions class

The GisLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| height |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gisloadoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### GmlLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions.md

#### GmlLoadOptions class

The GmlLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| load_schemas_from_internet |  |
| restore_schema |  |
| schema_location |  |
| height |  (inherited from `GisLoadOptions`) |
| width |  (inherited from `GisLoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/height.md

#### height property

Sets desired page height for converting GIS document. Default is 1000.

### load_schemas_from_internet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/load_schemas_from_internet.md

##### Definition:
```python
@property
def load_schemas_from_internet(self):
    ...
@load_schemas_from_internet.setter
def load_schemas_from_internet(self, value):
    ...
```

### restore_schema property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/restore_schema.md

##### Definition:
```python
@property
def restore_schema(self):
    ...
@restore_schema.setter
def restore_schema(self, value):
    ...
```

### schema_location property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/schema_location.md

##### Definition:
```python
@property
def schema_location(self):
    ...
@schema_location.setter
def schema_location(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/gmlloadoptions/width.md

#### width property

Sets desired page width for converting GIS document. Default is 1000.

### Header class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/header.md

#### Header class

Represents a header with a name and value.

The Header type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Header` class with the specified header name and header value. |

##### Properties
| Property | Description |
| :- | :- |
| header_name | Gets the header name. |
| header_value | Gets the header value. |

### Header constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/header/__init__.md

#### __init__

Initializes a new instance of the `Header` class with the specified header name and header value.

```python
def __init__(self, header_name, header_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| header_name | System.String | The header name to set. |
| header_value | System.String | The header value to set. |

### header_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/header/header_name.md

#### header_name property

Gets the header name.
##### Definition:
```python
@property
def header_name(self):
    ...
```

### header_value property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/header/header_value.md

#### header_value property

Gets the header value.
##### Definition:
```python
@property
def header_value(self):
    ...
```

### HtmlRenderingModes class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/htmlrenderingmodes.md

#### HtmlRenderingModes class

The HtmlRenderingModes type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### AbsolutePositioning field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/htmlrenderingmodes/absolutepositioning.md

### Flow field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/htmlrenderingmodes/flow.md

### HyphenationDictionary class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationdictionary.md

#### HyphenationDictionary class

Represents a mapping between an ISO language code and its associated hyphenation dictionary stream.

The HyphenationDictionary type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `HyphenationDictionary` class. |

##### Properties
| Property | Description |
| :- | :- |
| language_code | Gets the ISO language code. |
| dictionary_stream | Gets the stream of the hyphenation dictionary. |

### HyphenationDictionary constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationdictionary/__init__.md

#### __init__

Initializes a new instance of the `HyphenationDictionary` class.

```python
def __init__(self, language_code, dictionary_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| language_code | System.String | The ISO language code. |
| dictionary_stream | io.RawIOBase | The stream of the hyphenation dictionary associated with the language code. |

### dictionary_stream property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationdictionary/dictionary_stream.md

#### dictionary_stream property

Gets the stream of the hyphenation dictionary.
##### Definition:
```python
@property
def dictionary_stream(self):
    ...
```

### language_code property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationdictionary/language_code.md

#### language_code property

Gets the ISO language code.
##### Definition:
```python
@property
def language_code(self):
    ...
```

### HyphenationOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions.md

#### HyphenationOptions class

The HyphenationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| auto_hyphenation |  |
| hyphenate_caps |  |
| hyphenation_dictionaries |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### auto_hyphenation property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions/auto_hyphenation.md

##### Definition:
```python
@property
def auto_hyphenation(self):
    ...
@auto_hyphenation.setter
def auto_hyphenation(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### hyphenate_caps property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions/hyphenate_caps.md

##### Definition:
```python
@property
def hyphenate_caps(self):
    ...
@hyphenate_caps.setter
def hyphenate_caps(self, value):
    ...
```

### hyphenation_dictionaries property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/hyphenationoptions/hyphenation_dictionaries.md

##### Definition:
```python
@property
def hyphenation_dictionaries(self):
    ...
@hyphenation_dictionaries.setter
def hyphenation_dictionaries(self, value):
    ...
```

### ICredentialsProvider class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/icredentialsprovider.md

#### ICredentialsProvider class

Interface for providing credentials for a given URI.

The ICredentialsProvider type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_credentials | Gets the credentials associated with the specified URI. |

### get_credentials method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/icredentialsprovider/get_credentials.md

#### get_credentials

Gets the credentials associated with the specified URI.

##### Returns

The credentials for the specified URI.

```python
def get_credentials(self, uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| uri | System.String | The URI for which to get credentials. |

### ICustomCssStyleOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/icustomcssstyleoptions.md

#### ICustomCssStyleOptions class

The ICustomCssStyleOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| custom_css_style |  |

### custom_css_style property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/icustomcssstyleoptions/custom_css_style.md

##### Definition:
```python
@property
def custom_css_style(self):
    ...
@custom_css_style.setter
def custom_css_style(self, value):
    ...
```

### IFontSubstituteLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ifontsubstituteloadoptions.md

#### IFontSubstituteLoadOptions class

The IFontSubstituteLoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| default_font |  |
| font_substitutes |  |

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ifontsubstituteloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ifontsubstituteloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### IFontTransformationLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ifonttransformationloadoptions.md

#### IFontTransformationLoadOptions class

The IFontTransformationLoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| font_transformations |  |

### font_transformations property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ifonttransformationloadoptions/font_transformations.md

##### Definition:
```python
@property
def font_transformations(self):
    ...
@font_transformations.setter
def font_transformations(self, value):
    ...
```

### IHeaderConfigurator class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/iheaderconfigurator.md

#### IHeaderConfigurator class

Interface for configuring request headers.

The IHeaderConfigurator type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| configure | Configures the request headers for the given URI. |

### configure method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/iheaderconfigurator/configure.md

#### configure

Configures the request headers for the given URI.

```python
def configure(self, uri, headers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| uri | System.String | The URI for which headers are being configured. |
| headers | list | The collection of headers to configure. |

### ImageLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imageloadoptions.md

#### ImageLoadOptions class

The ImageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| default_font |  (inherited from `BaseImageLoadOptions`) |
| reset_font_folders |  (inherited from `BaseImageLoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imageloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imageloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imageloadoptions/default_font.md

#### default_font property

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imageloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imageloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### IMetadataLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imetadataloadoptions.md

#### IMetadataLoadOptions class

The IMetadataLoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imetadataloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/imetadataloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### IPageNumberingLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ipagenumberingloadoptions.md

#### IPageNumberingLoadOptions class

The IPageNumberingLoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_numbering |  |

### page_numbering property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ipagenumberingloadoptions/page_numbering.md

##### Definition:
```python
@property
def page_numbering(self):
    ...
@page_numbering.setter
def page_numbering(self, value):
    ...
```

### IResourceLoadingOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/iresourceloadingoptions.md

#### IResourceLoadingOptions class

The IResourceLoadingOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| skip_external_resources |  |
| whitelisted_resources |  |

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/iresourceloadingoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/iresourceloadingoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### IXslFoFactory class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ixslfofactory.md

#### IXslFoFactory class

Interface for creating an XSL-FO document stream.

The IXslFoFactory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_xsl_fo_stream | Creates a stream for the XSL-FO document. |

### create_xsl_fo_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ixslfofactory/create_xsl_fo_stream.md

#### create_xsl_fo_stream

Creates a stream for the XSL-FO document.

##### Returns

A stream representing the XSL-FO document.

```python
def create_xsl_fo_stream(self):
    ...
```

### IXsltFactory class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ixsltfactory.md

#### IXsltFactory class

Interface for creating an XSLT document stream.

The IXsltFactory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_xslt_stream | Creates a stream for the XSLT document. |

### create_xslt_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/ixsltfactory/create_xslt_stream.md

#### create_xslt_stream

Creates a stream for the XSLT document.

##### Returns

A stream representing the XSLT document.

```python
def create_xslt_stream(self):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/loadoptions.md

#### LoadOptions class

The LoadOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/loadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/loadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### MboxLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions.md

#### MboxLoadOptions class

The MboxLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| convert_owned |  |
| convert_owner |  |
| depth |  |
| format |  (inherited from `LoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/mboxloadoptions/format.md

#### format property

Input document file type.

### NetworkCredentials class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/networkcredentials.md

#### NetworkCredentials class

Represents network credentials with a username, password, and domain.

The NetworkCredentials type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `NetworkCredentials` class. |

##### Properties
| Property | Description |
| :- | :- |
| user_name | Gets the username. |
| password | Gets the password. |
| domain | Gets the domain. |

### NetworkCredentials constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/networkcredentials/__init__.md

#### __init__

Initializes a new instance of the `NetworkCredentials` class.

```python
def __init__(self, user_name, password, domain):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| user_name | System.String | The username. |
| password | System.String | The password. |
| domain | System.String | The domain. |

### domain property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/networkcredentials/domain.md

#### domain property

Gets the domain.
##### Definition:
```python
@property
def domain(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/networkcredentials/password.md

#### password property

Gets the password.
##### Definition:
```python
@property
def password(self):
    ...
```

### user_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/networkcredentials/user_name.md

#### user_name property

Gets the username.
##### Definition:
```python
@property
def user_name(self):
    ...
```

### NoteLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions.md

#### NoteLoadOptions class

The NoteLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| default_font |  |
| font_substitutes |  |
| format |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/noteloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### NsfLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions.md

#### NsfLoadOptions class

The NsfLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| convert_owned |  |
| convert_owner |  |
| depth |  |
| format |  (inherited from `LoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/nsfloadoptions/format.md

#### format property

Input document file type.

### OlmLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions.md

#### OlmLoadOptions class

The OlmLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| convert_owned |  |
| convert_owner |  |
| depth |  |
| folder |  |
| format |  (inherited from `LoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### folder property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/folder.md

##### Definition:
```python
@property
def folder(self):
    ...
@folder.setter
def folder(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/olmloadoptions/format.md

#### format property

Input document file type.

### PageDescriptionLanguageLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions.md

#### PageDescriptionLanguageLoadOptions class

The PageDescriptionLanguageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagedescriptionlanguageloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### PageLayoutOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagelayoutoptions.md

#### PageLayoutOptions class

The PageLayoutOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _has_flag_arg |  (inherited from `FlagsEnumeration`) |
| _has_flag_value_int32 |  (inherited from `FlagsEnumeration`) |
| _to_string_noargs |  (inherited from `FlagsEnumeration`) |
| combine |  (inherited from `FlagsEnumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| has_flag |  (inherited from `FlagsEnumeration`) |
| has_flag_value |  (inherited from `FlagsEnumeration`) |
| has_flag_value_int32 |  (inherited from `FlagsEnumeration`) |
| to_string |  (inherited from `FlagsEnumeration`) |

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagelayoutoptions/none.md

### ScaleToPageHeight field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagelayoutoptions/scaletopageheight.md

### ScaleToPageWidth field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pagelayoutoptions/scaletopagewidth.md

### PclLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pclloadoptions.md

#### PclLoadOptions class

The PclLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| reset_font_folders |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pclloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pclloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pclloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### reset_font_folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pclloadoptions/reset_font_folders.md

##### Definition:
```python
@property
def reset_font_folders(self):
    ...
@reset_font_folders.setter
def reset_font_folders(self, value):
    ...
```

### PdfLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions.md

#### PdfLoadOptions class

The PdfLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |
| convert_owned |  |
| convert_owner |  |
| default_font |  |
| depth |  |
| flatten_all_fields |  |
| font_substitutes |  |
| font_transformations |  |
| format |  |
| hide_pdf_annotations |  |
| page_numbering |  |
| password |  |
| remove_embedded_files |  |
| remove_javascript |  |
| reset_font_folders |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
@convert_owned.setter
def convert_owned(self, value):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
@convert_owner.setter
def convert_owner(self, value):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### flatten_all_fields property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/flatten_all_fields.md

##### Definition:
```python
@property
def flatten_all_fields(self):
    ...
@flatten_all_fields.setter
def flatten_all_fields(self, value):
    ...
```

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### font_transformations property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/font_transformations.md

##### Definition:
```python
@property
def font_transformations(self):
    ...
@font_transformations.setter
def font_transformations(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### hide_pdf_annotations property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/hide_pdf_annotations.md

##### Definition:
```python
@property
def hide_pdf_annotations(self):
    ...
@hide_pdf_annotations.setter
def hide_pdf_annotations(self, value):
    ...
```

### page_numbering property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/page_numbering.md

##### Definition:
```python
@property
def page_numbering(self):
    ...
@page_numbering.setter
def page_numbering(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### remove_embedded_files property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/remove_embedded_files.md

##### Definition:
```python
@property
def remove_embedded_files(self):
    ...
@remove_embedded_files.setter
def remove_embedded_files(self, value):
    ...
```

### remove_javascript property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/remove_javascript.md

##### Definition:
```python
@property
def remove_javascript(self):
    ...
@remove_javascript.setter
def remove_javascript(self, value):
    ...
```

### reset_font_folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/pdfloadoptions/reset_font_folders.md

##### Definition:
```python
@property
def reset_font_folders(self):
    ...
@reset_font_folders.setter
def reset_font_folders(self, value):
    ...
```

### PersonalStorageLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions.md

#### PersonalStorageLoadOptions class

The PersonalStorageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| convert_owned |  |
| convert_owner |  |
| depth |  |
| folder |  |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### folder property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/folder.md

##### Definition:
```python
@property
def folder(self):
    ...
@folder.setter
def folder(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/personalstorageloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### PresentationCommentsPosition class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationcommentsposition.md

#### PresentationCommentsPosition class

The PresentationCommentsPosition type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### Bottom field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationcommentsposition/bottom.md

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationcommentsposition/none.md

### Right field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationcommentsposition/right.md

### PresentationLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions.md

#### PresentationLoadOptions class

The PresentationLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _set_video_connector_ipresentation_video_connector |  |
| set_video_connector |  |
| set_video_connector_ipresentation_video_connector |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |
| comments_position |  |
| convert_owned |  |
| convert_owner |  |
| default_font |  |
| depth |  |
| font_substitutes |  |
| format |  |
| notes_position |  |
| password |  |
| preserve_document_structure |  |
| show_hidden_slides |  |
| skip_external_resources |  |
| whitelisted_resources |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _set_video_connector_ipresentation_video_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/_set_video_connector_ipresentation_video_connector.md

#### _set_video_connector_ipresentation_video_connector

```python
def _set_video_connector_ipresentation_video_connector(self, video_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| video_connector | `IPresentationVideoConnector` |  |

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### comments_position property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/comments_position.md

##### Definition:
```python
@property
def comments_position(self):
    ...
@comments_position.setter
def comments_position(self, value):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
@convert_owned.setter
def convert_owned(self, value):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
@convert_owner.setter
def convert_owner(self, value):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### hide_comments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/hide_comments.md

#### hide_comments property

Hide comments.
##### Definition:
```python
@property
def hide_comments(self):
    ...
@hide_comments.setter
def hide_comments(self, value):
    ...
```

### notes_position property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/notes_position.md

##### Definition:
```python
@property
def notes_position(self):
    ...
@notes_position.setter
def notes_position(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### preserve_document_structure property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/preserve_document_structure.md

##### Definition:
```python
@property
def preserve_document_structure(self):
    ...
@preserve_document_structure.setter
def preserve_document_structure(self, value):
    ...
```

### set_video_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/set_video_connector.md

#### set_video_connector

```python
def set_video_connector(self):
    ...
```

### set_video_connector_ipresentation_video_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/set_video_connector_ipresentation_video_connector.md

#### set_video_connector_ipresentation_video_connector

```python
def set_video_connector_ipresentation_video_connector(self):
    ...
```

### show_hidden_slides property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/show_hidden_slides.md

##### Definition:
```python
@property
def show_hidden_slides(self):
    ...
@show_hidden_slides.setter
def show_hidden_slides(self, value):
    ...
```

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### PresentationNotesPosition class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationnotesposition.md

#### PresentationNotesPosition class

The PresentationNotesPosition type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### BottomFull field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationnotesposition/bottomfull.md

### BottomTruncated field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationnotesposition/bottomtruncated.md

### None field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/presentationnotesposition/none.md

### PublisherLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions.md

#### PublisherLoadOptions class

The PublisherLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| default_font |  |
| font_substitutes |  |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/publisherloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### RasterImageLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions.md

#### RasterImageLoadOptions class

The RasterImageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _set_heic_connector_iheic_connector |  |
| _set_ocr_connector_iocr_connector |  |
| set_heic_connector |  |
| set_heic_connector_iheic_connector |  |
| set_ocr_connector |  |
| set_ocr_connector_iocr_connector |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| crop_area |  |
| format |  |
| vectorization_options |  |
| default_font |  (inherited from `BaseImageLoadOptions`) |
| reset_font_folders |  (inherited from `BaseImageLoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _set_heic_connector_iheic_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/_set_heic_connector_iheic_connector.md

#### _set_heic_connector_iheic_connector

```python
def _set_heic_connector_iheic_connector(self, heic_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| heic_connector | `IHeicConnector` |  |

### _set_ocr_connector_iocr_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/_set_ocr_connector_iocr_connector.md

#### _set_ocr_connector_iocr_connector

```python
def _set_ocr_connector_iocr_connector(self, ocr_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ocr_connector | `IOcrConnector` |  |

### crop_area property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/crop_area.md

##### Definition:
```python
@property
def crop_area(self):
    ...
@crop_area.setter
def crop_area(self, value):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/default_font.md

#### default_font property

Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### set_heic_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/set_heic_connector.md

#### set_heic_connector

```python
def set_heic_connector(self):
    ...
```

### set_heic_connector_iheic_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/set_heic_connector_iheic_connector.md

#### set_heic_connector_iheic_connector

```python
def set_heic_connector_iheic_connector(self):
    ...
```

### set_ocr_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/set_ocr_connector.md

#### set_ocr_connector

```python
def set_ocr_connector(self):
    ...
```

### set_ocr_connector_iocr_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/set_ocr_connector_iocr_connector.md

#### set_ocr_connector_iocr_connector

```python
def set_ocr_connector_iocr_connector(self):
    ...
```

### vectorization_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/rasterimageloadoptions/vectorization_options.md

##### Definition:
```python
@property
def vectorization_options(self):
    ...
@vectorization_options.setter
def vectorization_options(self, value):
    ...
```

### SpreadsheetLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions class

The SpreadsheetLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| clone |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| all_columns_in_one_page_per_sheet |  |
| auto_fit_rows |  |
| check_excel_restriction |  |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |
| columns_per_page |  |
| convert_owned |  |
| convert_owner |  |
| convert_range |  |
| culture_info |  |
| default_font |  |
| depth |  |
| font_substitutes |  |
| format |  |
| ignore_formula_calculation_errors |  |
| margin_settings |  |
| one_page_per_sheet |  |
| optimize_pdf_size |  |
| password |  |
| preserve_document_structure |  |
| print_comments |  |
| reset_font_folders |  |
| rows_per_page |  |
| sheet_indexes |  |
| sheets |  |
| show_grid_lines |  |
| show_hidden_sheets |  |
| size_settings |  |
| skip_empty_rows_and_columns |  |
| skip_external_resources |  |
| skip_footers |  |
| skip_headers |  |
| whitelisted_resources |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** Any

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### all_columns_in_one_page_per_sheet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/all_columns_in_one_page_per_sheet.md

##### Definition:
```python
@property
def all_columns_in_one_page_per_sheet(self):
    ...
@all_columns_in_one_page_per_sheet.setter
def all_columns_in_one_page_per_sheet(self, value):
    ...
```

### auto_fit_rows property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/auto_fit_rows.md

##### Definition:
```python
@property
def auto_fit_rows(self):
    ...
@auto_fit_rows.setter
def auto_fit_rows(self, value):
    ...
```

### check_excel_restriction property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/check_excel_restriction.md

##### Definition:
```python
@property
def check_excel_restriction(self):
    ...
@check_excel_restriction.setter
def check_excel_restriction(self, value):
    ...
```

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### columns_per_page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/columns_per_page.md

##### Definition:
```python
@property
def columns_per_page(self):
    ...
@columns_per_page.setter
def columns_per_page(self, value):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
@convert_owned.setter
def convert_owned(self, value):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
@convert_owner.setter
def convert_owner(self, value):
    ...
```

### convert_range property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/convert_range.md

##### Definition:
```python
@property
def convert_range(self):
    ...
@convert_range.setter
def convert_range(self, value):
    ...
```

### culture_info property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/culture_info.md

##### Definition:
```python
@property
def culture_info(self):
    ...
@culture_info.setter
def culture_info(self, value):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### hide_comments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/hide_comments.md

#### hide_comments property

Hide comments.
##### Definition:
```python
@property
def hide_comments(self):
    ...
@hide_comments.setter
def hide_comments(self, value):
    ...
```

### ignore_formula_calculation_errors property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/ignore_formula_calculation_errors.md

##### Definition:
```python
@property
def ignore_formula_calculation_errors(self):
    ...
@ignore_formula_calculation_errors.setter
def ignore_formula_calculation_errors(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### one_page_per_sheet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/one_page_per_sheet.md

##### Definition:
```python
@property
def one_page_per_sheet(self):
    ...
@one_page_per_sheet.setter
def one_page_per_sheet(self, value):
    ...
```

### optimize_pdf_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/optimize_pdf_size.md

##### Definition:
```python
@property
def optimize_pdf_size(self):
    ...
@optimize_pdf_size.setter
def optimize_pdf_size(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### preserve_document_structure property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/preserve_document_structure.md

##### Definition:
```python
@property
def preserve_document_structure(self):
    ...
@preserve_document_structure.setter
def preserve_document_structure(self, value):
    ...
```

### print_comments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/print_comments.md

##### Definition:
```python
@property
def print_comments(self):
    ...
@print_comments.setter
def print_comments(self, value):
    ...
```

### reset_font_folders property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/reset_font_folders.md

##### Definition:
```python
@property
def reset_font_folders(self):
    ...
@reset_font_folders.setter
def reset_font_folders(self, value):
    ...
```

### rows_per_page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/rows_per_page.md

##### Definition:
```python
@property
def rows_per_page(self):
    ...
@rows_per_page.setter
def rows_per_page(self, value):
    ...
```

### sheet_indexes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/sheet_indexes.md

##### Definition:
```python
@property
def sheet_indexes(self):
    ...
@sheet_indexes.setter
def sheet_indexes(self, value):
    ...
```

### sheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/sheets.md

##### Definition:
```python
@property
def sheets(self):
    ...
@sheets.setter
def sheets(self, value):
    ...
```

### show_grid_lines property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/show_grid_lines.md

##### Definition:
```python
@property
def show_grid_lines(self):
    ...
@show_grid_lines.setter
def show_grid_lines(self, value):
    ...
```

### show_hidden_sheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/show_hidden_sheets.md

##### Definition:
```python
@property
def show_hidden_sheets(self):
    ...
@show_hidden_sheets.setter
def show_hidden_sheets(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### skip_empty_rows_and_columns property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/skip_empty_rows_and_columns.md

##### Definition:
```python
@property
def skip_empty_rows_and_columns(self):
    ...
@skip_empty_rows_and_columns.setter
def skip_empty_rows_and_columns(self, value):
    ...
```

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### skip_footers property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/skip_footers.md

##### Definition:
```python
@property
def skip_footers(self):
    ...
@skip_footers.setter
def skip_footers(self, value):
    ...
```

### skip_headers property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/skip_headers.md

##### Definition:
```python
@property
def skip_headers(self):
    ...
@skip_headers.setter
def skip_headers(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### SpreadsheetPrintComments class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetprintcomments.md

#### SpreadsheetPrintComments class

The SpreadsheetPrintComments type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### PrintInPlace field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetprintcomments/printinplace.md

### PrintNoComments field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetprintcomments/printnocomments.md

### PrintSheetEnd field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetprintcomments/printsheetend.md

### PrintWithThreadedComments field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/spreadsheetprintcomments/printwiththreadedcomments.md

### StreamXslFoFactory class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/streamxslfofactory.md

#### StreamXslFoFactory class

Default implementation of the `IXslFoFactory` interface that accepts a stream in the constructor.

The StreamXslFoFactory type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `StreamXslFoFactory` class. |

##### Methods
| Method | Description |
| :- | :- |
| create_xsl_fo_stream | Returns the provided stream for the XSL-FO document. |

### StreamXslFoFactory constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/streamxslfofactory/__init__.md

#### __init__

Initializes a new instance of the `StreamXslFoFactory` class.

```python
def __init__(self, xsl_fo_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xsl_fo_stream | io.RawIOBase | The stream for the XSL-FO document. |

### create_xsl_fo_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/streamxslfofactory/create_xsl_fo_stream.md

#### create_xsl_fo_stream

Returns the provided stream for the XSL-FO document.

##### Returns

The stream representing the XSL-FO document.

```python
def create_xsl_fo_stream(self):
    ...
```

### StreamXsltFactory class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/streamxsltfactory.md

#### StreamXsltFactory class

Default implementation of the `IXsltFactory` interface that accepts a stream in the constructor.

The StreamXsltFactory type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `StreamXsltFactory` class. |

##### Methods
| Method | Description |
| :- | :- |
| create_xslt_stream | Returns the provided stream for the XSLT document. |

### StreamXsltFactory constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/streamxsltfactory/__init__.md

#### __init__

Initializes a new instance of the `StreamXsltFactory` class.

```python
def __init__(self, xslt_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| xslt_stream | io.RawIOBase | The stream for the XSLT document. |

### create_xslt_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/streamxsltfactory/create_xslt_stream.md

#### create_xslt_stream

Returns the provided stream for the XSLT document.

##### Returns

The stream representing the XSLT document.

```python
def create_xslt_stream(self):
    ...
```

### SvgLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions.md

#### SvgLoadOptions class

The SvgLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| crop_to_content_bounds |  |
| format |  |
| minimum_height |  |
| minimum_width |  |
| skip_external_resources |  |
| whitelisted_resources |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### crop_to_content_bounds property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/crop_to_content_bounds.md

##### Definition:
```python
@property
def crop_to_content_bounds(self):
    ...
@crop_to_content_bounds.setter
def crop_to_content_bounds(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### minimum_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/minimum_height.md

##### Definition:
```python
@property
def minimum_height(self):
    ...
@minimum_height.setter
def minimum_height(self, value):
    ...
```

### minimum_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/minimum_width.md

##### Definition:
```python
@property
def minimum_width(self):
    ...
@minimum_width.setter
def minimum_width(self, value):
    ...
```

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/svgloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### ThreeDLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/threedloadoptions.md

#### ThreeDLoadOptions class

The ThreeDLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/threedloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/threedloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/threedloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/threedloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### TsvLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions.md

#### TsvLoadOptions class

The TsvLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _clone_noargs |  (inherited from `SpreadsheetLoadOptions`) |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| clone |  (inherited from `SpreadsheetLoadOptions`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |
| convert_owned |  |
| convert_owner |  |
| default_font |  |
| depth |  |
| font_substitutes |  |
| format |  |
| margin_settings |  |
| size_settings |  |
| skip_external_resources |  |
| whitelisted_resources |  |
| all_columns_in_one_page_per_sheet |  (inherited from `SpreadsheetLoadOptions`) |
| auto_fit_rows |  (inherited from `SpreadsheetLoadOptions`) |
| check_excel_restriction |  (inherited from `SpreadsheetLoadOptions`) |
| columns_per_page |  (inherited from `SpreadsheetLoadOptions`) |
| convert_range |  (inherited from `SpreadsheetLoadOptions`) |
| culture_info |  (inherited from `SpreadsheetLoadOptions`) |
| ignore_formula_calculation_errors |  (inherited from `SpreadsheetLoadOptions`) |
| one_page_per_sheet |  (inherited from `SpreadsheetLoadOptions`) |
| optimize_pdf_size |  (inherited from `SpreadsheetLoadOptions`) |
| password |  (inherited from `SpreadsheetLoadOptions`) |
| preserve_document_structure |  (inherited from `SpreadsheetLoadOptions`) |
| print_comments |  (inherited from `SpreadsheetLoadOptions`) |
| reset_font_folders |  (inherited from `SpreadsheetLoadOptions`) |
| rows_per_page |  (inherited from `SpreadsheetLoadOptions`) |
| sheet_indexes |  (inherited from `SpreadsheetLoadOptions`) |
| sheets |  (inherited from `SpreadsheetLoadOptions`) |
| show_grid_lines |  (inherited from `SpreadsheetLoadOptions`) |
| show_hidden_sheets |  (inherited from `SpreadsheetLoadOptions`) |
| skip_empty_rows_and_columns |  (inherited from `SpreadsheetLoadOptions`) |
| skip_footers |  (inherited from `SpreadsheetLoadOptions`) |
| skip_headers |  (inherited from `SpreadsheetLoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### all_columns_in_one_page_per_sheet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/all_columns_in_one_page_per_sheet.md

#### all_columns_in_one_page_per_sheet property

If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

### auto_fit_rows property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/auto_fit_rows.md

#### auto_fit_rows property

Autofits all rows when converting

### check_excel_restriction property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/check_excel_restriction.md

#### check_excel_restriction property

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/clone.md

#### clone

Clones current instance.

##### Returns

```python
def clone(self):
    ...
```

### columns_per_page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/columns_per_page.md

#### columns_per_page property

Split a worksheet into pages by columns. Default is 0, no pagination.

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
```

### convert_range property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/convert_range.md

#### convert_range property

Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".

### culture_info property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/culture_info.md

#### culture_info property

Get or set the system culture info at the time file is loaded, e.g. "en-US".

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### hide_comments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/hide_comments.md

#### hide_comments property

Hide comments.

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### one_page_per_sheet property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/one_page_per_sheet.md

#### one_page_per_sheet property

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.

### optimize_pdf_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/optimize_pdf_size.md

#### optimize_pdf_size property

If True and converting to Pdf the conversion is optimized for better file size than print quality.

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/password.md

#### password property

Set password to unprotect protected document.

### rows_per_page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/rows_per_page.md

#### rows_per_page property

Split a worksheet into pages by rows. Default is 0, no pagination.

### sheet_indexes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/sheet_indexes.md

#### sheet_indexes property

List of sheet indexes to convert.
The indexes must be zero-based

### sheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/sheets.md

#### sheets property

Sheet name to convert

### show_grid_lines property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/show_grid_lines.md

#### show_grid_lines property

Show grid lines when converting Excel files.

### show_hidden_sheets property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/show_hidden_sheets.md

#### show_hidden_sheets property

Show hidden sheets when converting Excel files.

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### skip_empty_rows_and_columns property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/skip_empty_rows_and_columns.md

#### skip_empty_rows_and_columns property

Skips empty rows and columns when converting. Default is True.

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/tsvloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### TxtLeadingSpacesOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions.md

#### TxtLeadingSpacesOptions class

The TxtLeadingSpacesOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### TxtLeadingSpacesOptions constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### CONVERT_TO_INDENT property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/convert_to_indent.md

#### CONVERT_TO_INDENT property

Converts leading spaces to indents.

### ConvertToIndent field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/converttoindent.md

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### Preserve field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/preserve.md

### Trim field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtleadingspacesoptions/trim.md

### TxtLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions.md

#### TxtLoadOptions class

The TxtLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| default_font |  |
| detect_numbering_with_whitespaces |  |
| encoding |  |
| format |  |
| leading_spaces_options |  |
| margin_settings |  |
| size_settings |  |
| trailing_spaces_options |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### detect_numbering_with_whitespaces property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/detect_numbering_with_whitespaces.md

##### Definition:
```python
@property
def detect_numbering_with_whitespaces(self):
    ...
@detect_numbering_with_whitespaces.setter
def detect_numbering_with_whitespaces(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### leading_spaces_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/leading_spaces_options.md

##### Definition:
```python
@property
def leading_spaces_options(self):
    ...
@leading_spaces_options.setter
def leading_spaces_options(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### trailing_spaces_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txtloadoptions/trailing_spaces_options.md

##### Definition:
```python
@property
def trailing_spaces_options(self):
    ...
@trailing_spaces_options.setter
def trailing_spaces_options(self, value):
    ...
```

### TxtTrailingSpacesOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions.md

#### TxtTrailingSpacesOptions class

The TxtTrailingSpacesOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### TxtTrailingSpacesOptions constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions/__init__.md

#### __init__

Serialization constructor

```python
def __init__(self):
    ...
```

### compare_to method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions/compare_to.md

#### compare_to

Compares current object to other.

##### Returns

zero if equal

```python
def compare_to(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | System.Object | The other object |

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.Enumeration | The object to compare with the current object. |

### get_all method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions/get_all.md

#### get_all

Returns all enumeration values.

##### Returns

Enumerable of the provided type

```python
def get_all(self):
    ...
```

### Preserve field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions/preserve.md

### Trim field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/txttrailingspacesoptions/trim.md

### VcfLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vcfloadoptions.md

#### VcfLoadOptions class

The VcfLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| encoding |  |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vcfloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vcfloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vcfloadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vcfloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vcfloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### VectorizationOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions.md

#### VectorizationOptions class

The VectorizationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color |  |
| colors_limit |  |
| enable_vectorization |  |
| image_size_limit |  |
| line_width |  |
| severity |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/background_color.md

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### colors_limit property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/colors_limit.md

##### Definition:
```python
@property
def colors_limit(self):
    ...
@colors_limit.setter
def colors_limit(self, value):
    ...
```

### enable_vectorization property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/enable_vectorization.md

##### Definition:
```python
@property
def enable_vectorization(self):
    ...
@enable_vectorization.setter
def enable_vectorization(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### image_size_limit property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/image_size_limit.md

##### Definition:
```python
@property
def image_size_limit(self):
    ...
@image_size_limit.setter
def image_size_limit(self, value):
    ...
```

### line_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/line_width.md

##### Definition:
```python
@property
def line_width(self):
    ...
@line_width.setter
def line_width(self, value):
    ...
```

### severity property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/vectorizationoptions/severity.md

##### Definition:
```python
@property
def severity(self):
    ...
@severity.setter
def severity(self, value):
    ...
```

### VideoLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions.md

#### VideoLoadOptions class

The VideoLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _set_video_connector_ivideo_connector |  |
| set_video_connector |  |
| set_video_connector_ivideo_connector |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _set_video_connector_ivideo_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions/_set_video_connector_ivideo_connector.md

#### _set_video_connector_ivideo_connector

```python
def _set_video_connector_ivideo_connector(self, video_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| video_connector | `IVideoConnector` |  |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### set_video_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions/set_video_connector.md

#### set_video_connector

```python
def set_video_connector(self):
    ...
```

### set_video_connector_ivideo_connector method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/videoloadoptions/set_video_connector_ivideo_connector.md

#### set_video_connector_ivideo_connector

```python
def set_video_connector_ivideo_connector(self):
    ...
```

### WebLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions.md

#### WebLoadOptions class

The WebLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| base_path |  |
| configure_headers |  |
| credentials_provider |  |
| custom_css_style |  |
| encoding |  |
| format |  |
| html_rendering_mode |  |
| page_layout_options |  |
| page_numbering |  |
| resource_loading_timeout |  |
| skip_external_resources |  |
| use_pdf |  |
| whitelisted_resources |  |
| zoom |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### base_path property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/base_path.md

##### Definition:
```python
@property
def base_path(self):
    ...
@base_path.setter
def base_path(self, value):
    ...
```

### configure_headers property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/configure_headers.md

##### Definition:
```python
@property
def configure_headers(self):
    ...
@configure_headers.setter
def configure_headers(self, value):
    ...
```

### credentials_provider property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/credentials_provider.md

##### Definition:
```python
@property
def credentials_provider(self):
    ...
@credentials_provider.setter
def credentials_provider(self, value):
    ...
```

### custom_css_style property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/custom_css_style.md

##### Definition:
```python
@property
def custom_css_style(self):
    ...
@custom_css_style.setter
def custom_css_style(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### html_rendering_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/html_rendering_mode.md

##### Definition:
```python
@property
def html_rendering_mode(self):
    ...
@html_rendering_mode.setter
def html_rendering_mode(self, value):
    ...
```

### page_layout_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/page_layout_options.md

##### Definition:
```python
@property
def page_layout_options(self):
    ...
@page_layout_options.setter
def page_layout_options(self, value):
    ...
```

### page_numbering property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/page_numbering.md

##### Definition:
```python
@property
def page_numbering(self):
    ...
@page_numbering.setter
def page_numbering(self, value):
    ...
```

### resource_loading_timeout property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/resource_loading_timeout.md

##### Definition:
```python
@property
def resource_loading_timeout(self):
    ...
@resource_loading_timeout.setter
def resource_loading_timeout(self, value):
    ...
```

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### use_pdf property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/use_pdf.md

##### Definition:
```python
@property
def use_pdf(self):
    ...
@use_pdf.setter
def use_pdf(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### zoom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/webloadoptions/zoom.md

##### Definition:
```python
@property
def zoom(self):
    ...
@zoom.setter
def zoom(self, value):
    ...
```

### WordProcessingBookmarksOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions.md

#### WordProcessingBookmarksOptions class

The WordProcessingBookmarksOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| bookmarks_outline_level |  |
| expanded_outline_levels |  |
| headings_outline_levels |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### bookmarks_outline_level property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/bookmarks_outline_level.md

##### Definition:
```python
@property
def bookmarks_outline_level(self):
    ...
@bookmarks_outline_level.setter
def bookmarks_outline_level(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### expanded_outline_levels property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/expanded_outline_levels.md

##### Definition:
```python
@property
def expanded_outline_levels(self):
    ...
@expanded_outline_levels.setter
def expanded_outline_levels(self, value):
    ...
```

### headings_outline_levels property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingbookmarksoptions/headings_outline_levels.md

##### Definition:
```python
@property
def headings_outline_levels(self):
    ...
@headings_outline_levels.setter
def headings_outline_levels(self, value):
    ...
```

### WordProcessingCommentDisplay class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingcommentdisplay.md

#### WordProcessingCommentDisplay class

The WordProcessingCommentDisplay type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### Annotation field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingcommentdisplay/annotation.md

### Balloon field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingcommentdisplay/balloon.md

### Hidden field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingcommentdisplay/hidden.md

### WordProcessingLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

The WordProcessingLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| bookmark_options |  |
| clear_built_in_document_properties |  |
| clear_custom_document_properties |  |
| comment_display_mode |  |
| convert_owned |  |
| convert_owner |  |
| default_font |  |
| depth |  |
| embed_true_type_fonts |  |
| font_config_substitution_enabled |  |
| font_info_substitution_enabled |  |
| font_name_substitution_enabled |  |
| font_substitutes |  |
| font_transformations |  |
| format |  |
| hide_word_tracked_changes |  |
| hyphenation_options |  |
| keep_date_field_original_value |  |
| margin_settings |  |
| page_numbering |  |
| password |  |
| preserve_document_structure |  |
| preserve_form_fields |  |
| show_full_commenter_name |  |
| size_settings |  |
| skip_external_resources |  |
| update_fields |  |
| update_page_layout |  |
| use_text_shaper |  |
| whitelisted_resources |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### auto_font_substitution property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/auto_font_substitution.md

#### auto_font_substitution property

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled,
GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources.
Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.
##### Definition:
```python
@property
def auto_font_substitution(self):
    ...
@auto_font_substitution.setter
def auto_font_substitution(self, value):
    ...
```

### bookmark_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/bookmark_options.md

##### Definition:
```python
@property
def bookmark_options(self):
    ...
@bookmark_options.setter
def bookmark_options(self, value):
    ...
```

### clear_built_in_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/clear_built_in_document_properties.md

##### Definition:
```python
@property
def clear_built_in_document_properties(self):
    ...
@clear_built_in_document_properties.setter
def clear_built_in_document_properties(self, value):
    ...
```

### clear_custom_document_properties property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/clear_custom_document_properties.md

##### Definition:
```python
@property
def clear_custom_document_properties(self):
    ...
@clear_custom_document_properties.setter
def clear_custom_document_properties(self, value):
    ...
```

### comment_display_mode property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/comment_display_mode.md

##### Definition:
```python
@property
def comment_display_mode(self):
    ...
@comment_display_mode.setter
def comment_display_mode(self, value):
    ...
```

### convert_owned property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/convert_owned.md

##### Definition:
```python
@property
def convert_owned(self):
    ...
@convert_owned.setter
def convert_owned(self, value):
    ...
```

### convert_owner property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/convert_owner.md

##### Definition:
```python
@property
def convert_owner(self):
    ...
@convert_owner.setter
def convert_owner(self, value):
    ...
```

### default_font property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/default_font.md

##### Definition:
```python
@property
def default_font(self):
    ...
@default_font.setter
def default_font(self, value):
    ...
```

### depth property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/depth.md

##### Definition:
```python
@property
def depth(self):
    ...
@depth.setter
def depth(self, value):
    ...
```

### embed_true_type_fonts property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/embed_true_type_fonts.md

##### Definition:
```python
@property
def embed_true_type_fonts(self):
    ...
@embed_true_type_fonts.setter
def embed_true_type_fonts(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### font_config_substitution_enabled property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/font_config_substitution_enabled.md

##### Definition:
```python
@property
def font_config_substitution_enabled(self):
    ...
@font_config_substitution_enabled.setter
def font_config_substitution_enabled(self, value):
    ...
```

### font_info_substitution_enabled property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/font_info_substitution_enabled.md

##### Definition:
```python
@property
def font_info_substitution_enabled(self):
    ...
@font_info_substitution_enabled.setter
def font_info_substitution_enabled(self, value):
    ...
```

### font_name_substitution_enabled property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/font_name_substitution_enabled.md

##### Definition:
```python
@property
def font_name_substitution_enabled(self):
    ...
@font_name_substitution_enabled.setter
def font_name_substitution_enabled(self, value):
    ...
```

### font_substitutes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/font_substitutes.md

##### Definition:
```python
@property
def font_substitutes(self):
    ...
@font_substitutes.setter
def font_substitutes(self, value):
    ...
```

### font_transformations property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/font_transformations.md

##### Definition:
```python
@property
def font_transformations(self):
    ...
@font_transformations.setter
def font_transformations(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### hide_comments property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/hide_comments.md

#### hide_comments property

Hide comments.
##### Definition:
```python
@property
def hide_comments(self):
    ...
@hide_comments.setter
def hide_comments(self, value):
    ...
```

### hide_word_tracked_changes property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/hide_word_tracked_changes.md

##### Definition:
```python
@property
def hide_word_tracked_changes(self):
    ...
@hide_word_tracked_changes.setter
def hide_word_tracked_changes(self, value):
    ...
```

### hyphenation_options property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/hyphenation_options.md

##### Definition:
```python
@property
def hyphenation_options(self):
    ...
@hyphenation_options.setter
def hyphenation_options(self, value):
    ...
```

### keep_date_field_original_value property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/keep_date_field_original_value.md

##### Definition:
```python
@property
def keep_date_field_original_value(self):
    ...
@keep_date_field_original_value.setter
def keep_date_field_original_value(self, value):
    ...
```

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### page_numbering property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/page_numbering.md

##### Definition:
```python
@property
def page_numbering(self):
    ...
@page_numbering.setter
def page_numbering(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### preserve_document_structure property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/preserve_document_structure.md

##### Definition:
```python
@property
def preserve_document_structure(self):
    ...
@preserve_document_structure.setter
def preserve_document_structure(self, value):
    ...
```

### preserve_form_fields property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/preserve_form_fields.md

##### Definition:
```python
@property
def preserve_form_fields(self):
    ...
@preserve_form_fields.setter
def preserve_form_fields(self, value):
    ...
```

### show_full_commenter_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/show_full_commenter_name.md

##### Definition:
```python
@property
def show_full_commenter_name(self):
    ...
@show_full_commenter_name.setter
def show_full_commenter_name(self, value):
    ...
```

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### update_fields property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/update_fields.md

##### Definition:
```python
@property
def update_fields(self):
    ...
@update_fields.setter
def update_fields(self, value):
    ...
```

### update_page_layout property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/update_page_layout.md

##### Definition:
```python
@property
def update_page_layout(self):
    ...
@update_page_layout.setter
def update_page_layout(self, value):
    ...
```

### use_text_shaper property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/use_text_shaper.md

##### Definition:
```python
@property
def use_text_shaper(self):
    ...
@use_text_shaper.setter
def use_text_shaper(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/wordprocessingloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### XmlLoadOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions.md

#### XmlLoadOptions class

The XmlLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| custom_css_style |  |
| format |  |
| page_numbering |  |
| skip_external_resources |  |
| use_as_data_source |  |
| whitelisted_resources |  |
| xsl_fo_factory |  |
| xslt_factory |  |
| base_path |  (inherited from `WebLoadOptions`) |
| configure_headers |  (inherited from `WebLoadOptions`) |
| credentials_provider |  (inherited from `WebLoadOptions`) |
| encoding |  (inherited from `WebLoadOptions`) |
| html_rendering_mode |  (inherited from `WebLoadOptions`) |
| page_layout_options |  (inherited from `WebLoadOptions`) |
| resource_loading_timeout |  (inherited from `WebLoadOptions`) |
| use_pdf |  (inherited from `WebLoadOptions`) |
| zoom |  (inherited from `WebLoadOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### base_path property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/base_path.md

#### base_path property

The base path/url for the html

### configure_headers property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/configure_headers.md

#### configure_headers property

Interface for configuring request headers. The implementation should define the behavior for configuring headers based on the URI.

### credentials_provider property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/credentials_provider.md

#### credentials_provider property

Credentials provider for the URI.

### custom_css_style property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/custom_css_style.md

##### Definition:
```python
@property
def custom_css_style(self):
    ...
@custom_css_style.setter
def custom_css_style(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/encoding.md

#### encoding property

Get or sets the encoding to be used when loading the web document.
If the property is null the encoding will be determined from document character set attribute

### equals method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/equals.md

#### equals

Determines whether two object instances are equal.

##### Returns

`true` if the specified object is equal to the current object; otherwise, `false`.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.conversion.contracts.ValueObject | The object to compare with the current object. |

### format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### page_numbering property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/page_numbering.md

##### Definition:
```python
@property
def page_numbering(self):
    ...
@page_numbering.setter
def page_numbering(self, value):
    ...
```

### resource_loading_timeout property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/resource_loading_timeout.md

#### resource_loading_timeout property

Timeout for loading external resources

### skip_external_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### use_as_data_source property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/use_as_data_source.md

##### Definition:
```python
@property
def use_as_data_source(self):
    ...
@use_as_data_source.setter
def use_as_data_source(self, value):
    ...
```

### use_pdf property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/use_pdf.md

#### use_pdf property

Use pdf for the conversion. Default: false

### whitelisted_resources property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### xsl_fo_factory property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/xsl_fo_factory.md

##### Definition:
```python
@property
def xsl_fo_factory(self):
    ...
@xsl_fo_factory.setter
def xsl_fo_factory(self, value):
    ...
```

### xslt_factory property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.load/xmlloadoptions/xslt_factory.md

##### Definition:
```python
@property
def xslt_factory(self):
    ...
@xslt_factory.setter
def xslt_factory(self, value):
    ...
```

### groupdocs.conversion.options
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `IPageMarginOptions` |  |
| `IPageOrientationOptions` |  |
| `IPageSizeOptions` |  |
| `PageMarginOptions` |  |
| `PageSizeOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `PageSize` |  |

### IPageMarginOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/ipagemarginoptions.md

#### IPageMarginOptions class

The IPageMarginOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| margin_settings |  |

### margin_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/ipagemarginoptions/margin_settings.md

##### Definition:
```python
@property
def margin_settings(self):
    ...
@margin_settings.setter
def margin_settings(self, value):
    ...
```

### IPageOrientationOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/ipageorientationoptions.md

#### IPageOrientationOptions class

The IPageOrientationOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| orientation_settings |  |

### orientation_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/ipageorientationoptions/orientation_settings.md

##### Definition:
```python
@property
def orientation_settings(self):
    ...
@orientation_settings.setter
def orientation_settings(self, value):
    ...
```

### IPageSizeOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/ipagesizeoptions.md

#### IPageSizeOptions class

The IPageSizeOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| size_settings |  |

### size_settings property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/ipagesizeoptions/size_settings.md

##### Definition:
```python
@property
def size_settings(self):
    ...
@size_settings.setter
def size_settings(self, value):
    ...
```

### PageMarginOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions.md

#### PageMarginOptions class

The PageMarginOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| bottom |  |
| left |  |
| right |  |
| top |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### bottom property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions/bottom.md

##### Definition:
```python
@property
def bottom(self):
    ...
@bottom.setter
def bottom(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions/left.md

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### right property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions/right.md

##### Definition:
```python
@property
def right(self):
    ...
@right.setter
def right(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagemarginoptions/top.md

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### PageSize class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize.md

#### PageSize class

The PageSize type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _compare_to_object |  (inherited from `Enumeration`) |
| _equals_enumeration |  (inherited from `Enumeration`) |
| _equals_object |  (inherited from `Enumeration`) |
| _get_hash_code_noargs |  (inherited from `Enumeration`) |
| _to_string_noargs |  (inherited from `Enumeration`) |
| compare_to |  (inherited from `Enumeration`) |
| compare_to_object |  (inherited from `Enumeration`) |
| equals |  (inherited from `Enumeration`) |
| equals_enumeration |  (inherited from `Enumeration`) |
| equals_object |  (inherited from `Enumeration`) |
| from_display_name |  (inherited from `Enumeration`) |
| from_value |  (inherited from `Enumeration`) |
| get_all |  (inherited from `Enumeration`) |
| get_hash_code |  (inherited from `Enumeration`) |
| to_string |  (inherited from `Enumeration`) |

### A3 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/a3.md

### A4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/a4.md

### A5 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/a5.md

### B4 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/b4.md

### B5 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/b5.md

### Custom field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/custom.md

### EnvelopeDL field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/envelopedl.md

### Executive field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/executive.md

### Folio field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/folio.md

### Ledger field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/ledger.md

### Legal field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/legal.md

### Letter field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/letter.md

### Paper10x14 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/paper10x14.md

### Paper11x17 field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/paper11x17.md

### Quarto field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/quarto.md

### Statement field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/statement.md

### Tabloid field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/tabloid.md

### Unset field
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesize/unset.md

### PageSizeOptions class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesizeoptions.md

#### PageSizeOptions class

The PageSizeOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _equals_object |  (inherited from `ValueObject`) |
| _equals_value_object |  (inherited from `ValueObject`) |
| _get_hash_code_noargs |  (inherited from `ValueObject`) |
| equals |  (inherited from `ValueObject`) |
| equals_object |  (inherited from `ValueObject`) |
| equals_value_object |  (inherited from `ValueObject`) |
| get_hash_code |  (inherited from `ValueObject`) |

##### Properties
| Property | Description |
| :- | :- |
| page_height |  |
| page_size |  |
| page_width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesizeoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesizeoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### page_height property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesizeoptions/page_height.md

##### Definition:
```python
@property
def page_height(self):
    ...
@page_height.setter
def page_height(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesizeoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.options/pagesizeoptions/page_width.md

##### Definition:
```python
@property
def page_width(self):
    ...
@page_width.setter
def page_width(self, value):
    ...
```

### groupdocs.conversion.reporting
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting.md

Types under `groupdocs.conversion.reporting`.

##### Classes
| Class | Description |
| :- | :- |
| `IConverterListener` |  |

### IConverterListener class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener.md

#### IConverterListener class

The IConverterListener type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _completed_noargs |  |
| _progress_byte |  |
| _started_noargs |  |
| completed |  |
| progress |  |
| progress_byte |  |
| started |  |

### _completed_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/_completed_noargs.md

#### _completed_noargs

```python
def _completed_noargs(self):
    ...
```

### _progress_byte method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/_progress_byte.md

#### _progress_byte

```python
def _progress_byte(self, current):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| current | `int` |  |

### _started_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/_started_noargs.md

#### _started_noargs

```python
def _started_noargs(self):
    ...
```

### completed method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/completed.md

#### completed

```python
def completed(self):
    ...
```

### progress method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/progress.md

#### progress

```python
def progress(self):
    ...
```

### progress_byte method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/progress_byte.md

#### progress_byte

```python
def progress_byte(self):
    ...
```

### started method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.reporting/iconverterlistener/started.md

#### started

```python
def started(self):
    ...
```

### groupdocs.conversion
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion.md

Main GroupDocs.Conversion namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `ConvertContext` |  |
| `ConvertedContext` |  |
| `ConvertedPageContext` |  |
| `Converter` |  |
| `ConverterSettings` |  |
| `FluentConverter` |  |
| `License` | Manages GroupDocs.Conversion licensing. |
| `LoadContext` |  |
| `Metered` | Manages metered (pay-per-use) licensing. |
| `SaveContext` |  |
| `SavePageContext` |  |

##### Exceptions
| Exception | Description |
| :- | :- |
| `ConversionByPageFailedException` |  |
| `ConversionFailedException` |  |
| `ConversionNotSupportedException` |  |
| `CorruptOrDamagedFileException` |  |
| `FileTypeNotSupportedException` |  |
| `FontSubstituteException` |  |
| `GroupDocsConversionException` |  |
| `IncorrectPasswordException` |  |
| `InvalidConvertOptionsException` |  |
| `InvalidConverterSettingsException` |  |
| `InvalidLoadOptionsException` |  |
| `PasswordRequiredException` |  |
| `SourceDocumentFactoryNotProvidedException` |  |

### ConversionByPageFailedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/conversionbypagefailedexception.md

#### ConversionByPageFailedException class

The ConversionByPageFailedException type exposes the following members:

### ConversionFailedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/conversionfailedexception.md

#### ConversionFailedException class

The ConversionFailedException type exposes the following members:

### ConversionNotSupportedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/conversionnotsupportedexception.md

#### ConversionNotSupportedException class

The ConversionNotSupportedException type exposes the following members:

### ConvertContext class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertcontext.md

#### ConvertContext class

The ConvertContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| cancellation_token |  |
| source_file_name |  |
| source_format |  |

### cancellation_token property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertcontext/cancellation_token.md

##### Definition:
```python
@property
def cancellation_token(self):
    ...
@cancellation_token.setter
def cancellation_token(self, value):
    ...
```

### source_file_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertcontext/source_file_name.md

##### Definition:
```python
@property
def source_file_name(self):
    ...
```

### source_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertcontext/source_format.md

##### Definition:
```python
@property
def source_format(self):
    ...
```

### ConvertedContext class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext.md

#### ConvertedContext class

The ConvertedContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| converted_format |  |
| converted_stream |  |
| hierarchy_level |  |
| item_index |  |
| source_file_name |  |
| source_format |  |

### converted_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext/converted_format.md

##### Definition:
```python
@property
def converted_format(self):
    ...
```

### converted_stream property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext/converted_stream.md

##### Definition:
```python
@property
def converted_stream(self):
    ...
```

### hierarchy_level property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext/hierarchy_level.md

##### Definition:
```python
@property
def hierarchy_level(self):
    ...
```

### item_index property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext/item_index.md

##### Definition:
```python
@property
def item_index(self):
    ...
```

### source_file_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext/source_file_name.md

##### Definition:
```python
@property
def source_file_name(self):
    ...
```

### source_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedcontext/source_format.md

##### Definition:
```python
@property
def source_format(self):
    ...
```

### ConvertedPageContext class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedpagecontext.md

#### ConvertedPageContext class

The ConvertedPageContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| converted_format |  |
| converted_stream |  |
| page |  |
| source_file_name |  |
| source_format |  |

### converted_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedpagecontext/converted_format.md

##### Definition:
```python
@property
def converted_format(self):
    ...
```

### converted_stream property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedpagecontext/converted_stream.md

##### Definition:
```python
@property
def converted_stream(self):
    ...
```

### page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedpagecontext/page.md

##### Definition:
```python
@property
def page(self):
    ...
```

### source_file_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedpagecontext/source_file_name.md

##### Definition:
```python
@property
def source_file_name(self):
    ...
```

### source_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertedpagecontext/source_format.md

##### Definition:
```python
@property
def source_format(self):
    ...
```

### Converter class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter.md

#### Converter class

The Converter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _convert_convert_options_action_1_174a |  |
| _convert_convert_options_action_1_dd_8b |  |
| _convert_func_2_1f04_convert_options |  |
| _convert_func_2_1f04_func_2_8b05 |  |
| _convert_func_2_83b4_convert_options |  |
| _convert_func_2_83b4_func_2_8b05 |  |
| _convert_func_2_8b05_action_1_174a |  |
| _convert_func_2_8b05_action_1_dd_8b |  |
| _convert_string_convert_options |  |
| _dispose_noargs |  |
| _get_document_info_noargs |  |
| _get_possible_conversions_noargs |  |
| _init_func_1_e_2e2 |  |
| _init_func_1_e_2e2_func_1_ec_4e |  |
| _init_func_1_e_2e2_func_2_cc52_func_1_ec_4e |  |
| _init_string |  |
| _init_string_func_1_ec_4e |  |
| _init_string_func_2_cc52_func_1_ec_4e |  |
| _is_document_password_protected_noargs |  |
| convert |  |
| convert_convert_options |  |
| convert_file |  |
| convert_func |  |
| convert_string |  |
| dispose |  |
| get_all_possible_conversions |  |
| get_document_info |  |
| get_possible_conversions |  |
| get_possible_conversions_by_extension |  |
| is_document_password_protected |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _convert_convert_options_action_1_174a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_convert_options_action_1_174a.md

#### _convert_convert_options_action_1_174a

```python
def _convert_convert_options_action_1_174a(self, convert_options, document_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` |  |
| document_completed | `ConvertedPageContext` |  |

### _convert_convert_options_action_1_dd_8b method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_convert_options_action_1_dd_8b.md

#### _convert_convert_options_action_1_dd_8b

```python
def _convert_convert_options_action_1_dd_8b(self, convert_options, document_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` |  |
| document_completed | `ConvertedContext` |  |

### _convert_func_2_1f04_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_func_2_1f04_convert_options.md

#### _convert_func_2_1f04_convert_options

```python
def _convert_func_2_1f04_convert_options(self, target_stream_provider, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| target_stream_provider | `Stream` |  |
| convert_options | `ConvertOptions` |  |

### _convert_func_2_1f04_func_2_8b05 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_func_2_1f04_func_2_8b05.md

#### _convert_func_2_1f04_func_2_8b05

```python
def _convert_func_2_1f04_func_2_8b05(self, target_stream_provider, convert_options_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| target_stream_provider | `Stream` |  |
| convert_options_provider | `ConvertOptions` |  |

### _convert_func_2_83b4_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_func_2_83b4_convert_options.md

#### _convert_func_2_83b4_convert_options

```python
def _convert_func_2_83b4_convert_options(self, target_stream_provider, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| target_stream_provider | `Stream` |  |
| convert_options | `ConvertOptions` |  |

### _convert_func_2_83b4_func_2_8b05 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_func_2_83b4_func_2_8b05.md

#### _convert_func_2_83b4_func_2_8b05

```python
def _convert_func_2_83b4_func_2_8b05(self, target_stream_provider, convert_options_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| target_stream_provider | `Stream` |  |
| convert_options_provider | `ConvertOptions` |  |

### _convert_func_2_8b05_action_1_174a method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_func_2_8b05_action_1_174a.md

#### _convert_func_2_8b05_action_1_174a

```python
def _convert_func_2_8b05_action_1_174a(self, convert_options_provider, document_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options_provider | `ConvertOptions` |  |
| document_completed | `ConvertedPageContext` |  |

### _convert_func_2_8b05_action_1_dd_8b method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_func_2_8b05_action_1_dd_8b.md

#### _convert_func_2_8b05_action_1_dd_8b

```python
def _convert_func_2_8b05_action_1_dd_8b(self, convert_options_provider, document_completed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options_provider | `ConvertOptions` |  |
| document_completed | `ConvertedContext` |  |

### _convert_string_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_convert_string_convert_options.md

#### _convert_string_convert_options

```python
def _convert_string_convert_options(self, file_path, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| convert_options | `ConvertOptions` |  |

### _dispose_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _get_document_info_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_get_document_info_noargs.md

#### _get_document_info_noargs

```python
def _get_document_info_noargs(self):
    ...
```

**Returns:** IDocumentInfo

### _get_possible_conversions_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_get_possible_conversions_noargs.md

#### _get_possible_conversions_noargs

```python
def _get_possible_conversions_noargs(self):
    ...
```

**Returns:** PossibleConversions

### _init_func_1_e_2e2 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_init_func_1_e_2e2.md

#### _init_func_1_e_2e2

```python
def _init_func_1_e_2e2(self, source_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream_provider | `Stream` |  |

### _init_func_1_e_2e2_func_1_ec_4e method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_init_func_1_e_2e2_func_1_ec_4e.md

#### _init_func_1_e_2e2_func_1_ec_4e

```python
def _init_func_1_e_2e2_func_1_ec_4e(self, source_stream_provider, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream_provider | `Stream` |  |
| settings | `ConverterSettings` |  |

### _init_func_1_e_2e2_func_2_cc52_func_1_ec_4e method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_init_func_1_e_2e2_func_2_cc52_func_1_ec_4e.md

#### _init_func_1_e_2e2_func_2_cc52_func_1_ec_4e

```python
def _init_func_1_e_2e2_func_2_cc52_func_1_ec_4e(self, source_stream_provider, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream_provider | `Stream` |  |
| load_options | `LoadOptions` |  |
| settings | `Optional[ConverterSettings]` |  |

### _init_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_func_1_ec_4e method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_init_string_func_1_ec_4e.md

#### _init_string_func_1_ec_4e

```python
def _init_string_func_1_ec_4e(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| settings | `ConverterSettings` |  |

### _init_string_func_2_cc52_func_1_ec_4e method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_init_string_func_2_cc52_func_1_ec_4e.md

#### _init_string_func_2_cc52_func_1_ec_4e

```python
def _init_string_func_2_cc52_func_1_ec_4e(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `LoadOptions` |  |
| settings | `Optional[ConverterSettings]` |  |

### _is_document_password_protected_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/_is_document_password_protected_noargs.md

#### _is_document_password_protected_noargs

```python
def _is_document_password_protected_noargs(self):
    ...
```

**Returns:** bool

### convert method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert.md

#### convert

```python
def convert(self):
    ...
```

### convert_by_page method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_by_page.md

#### convert_by_page

Converts the source document and saves the converted document page by page.

Learn more

- More about document conversion basic scenarios: https://docs.groupdocs.com/display/conversionnet/Convert+document
- Conversion use cases, advanced settings and customizations: https://docs.groupdocs.com/display/conversionnet/Converting

```python
def convert_by_page(self, output_dir, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_dir | `System.Func`2[[GroupDocs.Conversion.SavePageContext, GroupDocs.Conversion, Version=26.3.0.0, Culture=neutral, PublicKeyToken=716fcc553a201e56],[System.IO.Stream, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]` |  |
| convert_options | `ConvertOptions` | The convert options specific to desired target file type. |

### convert_convert_options method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_convert_options.md

#### convert_convert_options

```python
def convert_convert_options(self):
    ...
```

### convert_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_file.md

#### convert_file

```python
def convert_file(self):
    ...
```

### convert_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_func.md

#### convert_func

```python
def convert_func(self):
    ...
```

### convert_multiple method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_multiple.md

#### convert_multiple

Converts source document to multiple documents of the output format.

```python
def convert_multiple(self, output_folder, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_folder | System.String | Output folder path. File |
| convert_options | groupdocs.conversion.options.convert.ConvertOptions | The convert options specific to desired target file type. |

### convert_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_string.md

#### convert_string

```python
def convert_string(self):
    ...
```

### convert_to_stream method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_to_stream.md

#### convert_to_stream

Converts the source document and saves the whole converted document.

Learn more

- More about document conversion basic scenarios: [How to convert document in 3 steps](https://docs.groupdocs.com/display/conversionnet/Convert+document)
- Conversion use cases, advanced settings and customizations: [Convert document with advanced settings](https://docs.groupdocs.com/display/conversionnet/Converting)

```python
def convert_to_stream(self, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `System.Func`2[[GroupDocs.Conversion.SaveContext, GroupDocs.Conversion, Version=26.3.0.0, Culture=neutral, PublicKeyToken=716fcc553a201e56],[System.IO.Stream, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]` | The convert options specific to desired target file type. |

### convert_with_callback method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_with_callback.md

#### convert_with_callback

Converts source document. Saves the whole converted document.

Learn more

- More about document conversion basic scenarios: [How to convert document in 3 steps](https://docs.groupdocs.com/display/conversionnet/Convert+document)
- Conversion use cases, advanced settings and customizations: [Convert document with advanced settings](https://docs.groupdocs.com/display/conversionnet/Converting)

```python
def convert_with_callback(self, convert_options, callback):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` | The convert options specific to desired target file type. |
| callback | `System.Action`1[[GroupDocs.Conversion.ConvertedContext, GroupDocs.Conversion, Version=26.3.0.0, Culture=neutral, PublicKeyToken=716fcc553a201e56]]` |  |

### convert_with_callback_per_page method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/convert_with_callback_per_page.md

#### convert_with_callback_per_page

Converts the source document and saves the converted document page by page.

Learn more

- More about document conversion basic scenarios: https://docs.groupdocs.com/display/conversionnet/Convert+document
- Conversion use cases, advanced settings and customizations: https://docs.groupdocs.com/display/conversionnet/Converting

```python
def convert_with_callback_per_page(self, convert_options, callback):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` | GroupDocs.Conversion.ConvertOptions – The convert options specific to desired target file type. |
| callback | `System.Action`1[[GroupDocs.Conversion.ConvertedPageContext, GroupDocs.Conversion, Version=26.3.0.0, Culture=neutral, PublicKeyToken=716fcc553a201e56]]` |  |

### dispose method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### get_all_possible_conversions method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/get_all_possible_conversions.md

#### get_all_possible_conversions

```python
def get_all_possible_conversions(cls):
    ...
```

**Returns:** List[Any]

### get_document_info method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### get_possible_conversions method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/get_possible_conversions.md

#### get_possible_conversions

```python
def get_possible_conversions(self):
    ...
```

### get_possible_conversions_by_extension method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/get_possible_conversions_by_extension.md

#### get_possible_conversions_by_extension

```python
def get_possible_conversions_by_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** PossibleConversions

### is_document_password_protected method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/converter/is_document_password_protected.md

#### is_document_password_protected

```python
def is_document_password_protected(self):
    ...
```

### ConverterSettings class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings.md

#### ConverterSettings class

The ConverterSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| cache |  |
| font_directories |  |
| listener |  |
| logger |  |
| on_compression_completed |  |
| on_conversion_by_page_failed |  |
| on_conversion_failed |  |
| scan_font_directories_recursively |  |
| temp_folder |  |

### __init__ constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### cache property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/cache.md

##### Definition:
```python
@property
def cache(self):
    ...
@cache.setter
def cache(self, value):
    ...
```

### font_directories property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/font_directories.md

##### Definition:
```python
@property
def font_directories(self):
    ...
```

### listener property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/listener.md

##### Definition:
```python
@property
def listener(self):
    ...
@listener.setter
def listener(self, value):
    ...
```

### logger property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/logger.md

##### Definition:
```python
@property
def logger(self):
    ...
@logger.setter
def logger(self, value):
    ...
```

### on_compression_completed property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/on_compression_completed.md

##### Definition:
```python
@property
def on_compression_completed(self):
    ...
@on_compression_completed.setter
def on_compression_completed(self, value):
    ...
```

### on_conversion_by_page_failed property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/on_conversion_by_page_failed.md

##### Definition:
```python
@property
def on_conversion_by_page_failed(self):
    ...
@on_conversion_by_page_failed.setter
def on_conversion_by_page_failed(self, value):
    ...
```

### on_conversion_failed property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/on_conversion_failed.md

##### Definition:
```python
@property
def on_conversion_failed(self):
    ...
@on_conversion_failed.setter
def on_conversion_failed(self, value):
    ...
```

### scan_font_directories_recursively property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/scan_font_directories_recursively.md

##### Definition:
```python
@property
def scan_font_directories_recursively(self):
    ...
@scan_font_directories_recursively.setter
def scan_font_directories_recursively(self, value):
    ...
```

### temp_folder property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/convertersettings/temp_folder.md

##### Definition:
```python
@property
def temp_folder(self):
    ...
@temp_folder.setter
def temp_folder(self, value):
    ...
```

### CorruptOrDamagedFileException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/corruptordamagedfileexception.md

#### CorruptOrDamagedFileException class

The CorruptOrDamagedFileException type exposes the following members:

### FileTypeNotSupportedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

The FileTypeNotSupportedException type exposes the following members:

### FluentConverter class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter.md

#### FluentConverter class

The FluentConverter type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _load_func_1_4427 |  |
| _load_func_1_e_2e2 |  |
| _load_string |  |
| _load_string_array |  |
| load |  |
| load_file |  |
| load_files |  |
| load_func |  |
| load_string |  |
| load_strings |  |
| with_settings |  |

### _load_func_1_4427 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/_load_func_1_4427.md

#### _load_func_1_4427

```python
def _load_func_1_4427(cls, document_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream_provider | `List[Stream]` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### _load_func_1_e_2e2 method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/_load_func_1_e_2e2.md

#### _load_func_1_e_2e2

```python
def _load_func_1_e_2e2(cls, document_stream_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_stream_provider | `Stream` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### _load_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/_load_string.md

#### _load_string

```python
def _load_string(cls, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### _load_string_array method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/_load_string_array.md

#### _load_string_array

```python
def _load_string_array(cls):
    ...
```

**Returns:** IConversionLoadOptionsOrSourceDocumentLoaded

### load method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/load.md

#### load

```python
def load(cls):
    ...
```

### load_file method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/load_file.md

#### load_file

```python
def load_file(cls):
    ...
```

### load_files method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/load_files.md

#### load_files

```python
def load_files(cls):
    ...
```

### load_func method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/load_func.md

#### load_func

```python
def load_func(cls):
    ...
```

### load_string method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/load_string.md

#### load_string

```python
def load_string(cls):
    ...
```

### load_strings method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/load_strings.md

#### load_strings

```python
def load_strings(cls):
    ...
```

### with_settings method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fluentconverter/with_settings.md

#### with_settings

```python
def with_settings(cls, settings_provider):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| settings_provider | `ConverterSettings` |  |

**Returns:** IConversionFrom

### FontSubstituteException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/fontsubstituteexception.md

#### FontSubstituteException class

The FontSubstituteException type exposes the following members:

### GroupDocsConversionException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/groupdocsconversionexception.md

#### GroupDocsConversionException class

The GroupDocsConversionException type exposes the following members:

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/incorrectpasswordexception.md

#### IncorrectPasswordException class

The IncorrectPasswordException type exposes the following members:

### InvalidConverterSettingsException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/invalidconvertersettingsexception.md

#### InvalidConverterSettingsException class

The InvalidConverterSettingsException type exposes the following members:

### InvalidConvertOptionsException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/invalidconvertoptionsexception.md

#### InvalidConvertOptionsException class

The InvalidConvertOptionsException type exposes the following members:

### InvalidLoadOptionsException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/invalidloadoptionsexception.md

#### InvalidLoadOptionsException class

The InvalidLoadOptionsException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/license.md

#### License class

Manages GroupDocs.Conversion licensing.

Licensed builds unlock the full feature set of the wrapper at
runtime. Unlicensed builds run in evaluation mode with the same API
surface but with limits on output size and watermarked content.

The License type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| set_license | Apply a license to the current process. |

### License constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/license/__init__.md

#### __init__

Constructs a new instance of License

```python
def __init__(self):
    ...
```

### is_licensed property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/license/is_licensed.md

#### is_licensed property

Returns true if a valid license has been applied; false if the component is running in evaluation mode.
##### Definition:
```python
@property
def is_licensed(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/license/set_license.md

#### set_license

Apply a license to the current process.

```python
def set_license(self, license_source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_source |  | Either a string path to a ``.lic`` file or a readable file-like object that yields the license bytes. File-like inputs are written to a temporary file before being passed to the bridge. |

| Raises | Description |
| :- | :- |
| `TypeError` | If ``license_source`` is neither a string path nor a readable file-like object. |

### LoadContext class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/loadcontext.md

#### LoadContext class

The LoadContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| hierarchy_level |  |
| item_index |  |
| source_file_name |  |
| source_format |  |
| source_stream |  |

### hierarchy_level property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/loadcontext/hierarchy_level.md

##### Definition:
```python
@property
def hierarchy_level(self):
    ...
```

### item_index property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/loadcontext/item_index.md

##### Definition:
```python
@property
def item_index(self):
    ...
```

### source_file_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/loadcontext/source_file_name.md

##### Definition:
```python
@property
def source_file_name(self):
    ...
```

### source_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/loadcontext/source_format.md

##### Definition:
```python
@property
def source_format(self):
    ...
```

### source_stream property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/loadcontext/source_stream.md

##### Definition:
```python
@property
def source_stream(self):
    ...
```

### Metered class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/metered.md

#### Metered class

Manages metered (pay-per-use) licensing.

Metered licenses bill on actual consumption (typically pages or
documents processed). Set the public/private key pair once at
application startup; the wrapper reports usage back to the GroupDocs
license server in the background.

The Metered type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_consumption_credit | Return the remaining metered credit for the current key. |
| get_consumption_quantity | Return the total metered quantity consumed so far. |
| set_metered_key | Activate metered billing with the given public/private key pair. |

### Metered constructor
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/metered/__init__.md

#### __init__

Constructs a new instance of Metered

```python
def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/metered/get_consumption_credit.md

#### get_consumption_credit

Return the remaining metered credit for the current key.

```python
def get_consumption_credit():
    ...
```

**Returns:** float: The remaining credit balance reported by the license
server.

### get_consumption_quantity method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/metered/get_consumption_quantity.md

#### get_consumption_quantity

Return the total metered quantity consumed so far.

```python
def get_consumption_quantity():
    ...
```

**Returns:** float: The cumulative usage (typically in pages or documents)
recorded against the current metered key.

### set_metered_key method
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/metered/set_metered_key.md

#### set_metered_key

Activate metered billing with the given public/private key pair.

```python
def set_metered_key(self, public_key, private_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| public_key |  | The public key half of the metered credentials. |
| private_key |  | The private key half of the metered credentials. |

### PasswordRequiredException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/passwordrequiredexception.md

#### PasswordRequiredException class

The PasswordRequiredException type exposes the following members:

### SaveContext class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savecontext.md

#### SaveContext class

The SaveContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| hierarchy_level |  |
| item_index |  |
| source_file_name |  |
| source_format |  |
| target_format |  |

### hierarchy_level property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savecontext/hierarchy_level.md

##### Definition:
```python
@property
def hierarchy_level(self):
    ...
```

### item_index property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savecontext/item_index.md

##### Definition:
```python
@property
def item_index(self):
    ...
```

### source_file_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savecontext/source_file_name.md

##### Definition:
```python
@property
def source_file_name(self):
    ...
```

### source_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savecontext/source_format.md

##### Definition:
```python
@property
def source_format(self):
    ...
```

### target_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savecontext/target_format.md

##### Definition:
```python
@property
def target_format(self):
    ...
```

### SavePageContext class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savepagecontext.md

#### SavePageContext class

The SavePageContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page |  |
| source_file_name |  |
| source_format |  |
| target_format |  |

### page property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savepagecontext/page.md

##### Definition:
```python
@property
def page(self):
    ...
```

### source_file_name property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savepagecontext/source_file_name.md

##### Definition:
```python
@property
def source_file_name(self):
    ...
```

### source_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savepagecontext/source_format.md

##### Definition:
```python
@property
def source_format(self):
    ...
```

### target_format property
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/savepagecontext/target_format.md

##### Definition:
```python
@property
def target_format(self):
    ...
```

### SourceDocumentFactoryNotProvidedException class
Path: https://reference.groupdocs.com/conversion/python-net/groupdocs.conversion/sourcedocumentfactorynotprovidedexception.md

#### SourceDocumentFactoryNotProvidedException class

The SourceDocumentFactoryNotProvidedException type exposes the following members:


# GroupDocs.Editor

> Load, edit, and save documents through an HTML round-trip.

## Java

### GroupDocs.Editor for Java
Path: https://reference.groupdocs.com/editor/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.editor | The **com.groupdocs.editor** namespace is a root namespace, which provides classes for editing multiple document formats in your Java applications. |
| com.groupdocs.editor.formats | The **com.groupdocs.editor.formats** namespace provides interfaces and classes that describes supported document formats. |
| com.groupdocs.editor.formats.abstraction | The **com.groupdocs.editor.formats.abstraction** namespace provides interfaces and classes that describe supported document formats in the GroupDocs.Editor library. |
| com.groupdocs.editor.htmlcss.css.datatypes | The **com.groupdocs.editor.htmlcss.css.datatypes** namespace provides classes that represent CSS data types. |
| com.groupdocs.editor.htmlcss.css.properties |  |
| com.groupdocs.editor.htmlcss.exceptions | The **com.groupdocs.editor.htmlcss.exceptions** namespace provides exceptions that is thrown when trying to open, load, save or process somehow else some content. |
| com.groupdocs.editor.htmlcss.resources | The **com.groupdocs.editor.htmlcss.resources** namespace provides classes that represent all kinds of the HTML resources. |
| com.groupdocs.editor.htmlcss.resources.audio | The **com.groupdocs.editor.htmlcss.resources.audio** namespace provides classes that represent audio resources. |
| com.groupdocs.editor.htmlcss.resources.fonts | The **com.groupdocs.editor.htmlcss.resources.fonts** namespace provides classes that represent font resources. |
| com.groupdocs.editor.htmlcss.resources.images | The **com.groupdocs.editor.htmlcss.resources.images** namespace provides classes that represent image resources of all types in general. |
| com.groupdocs.editor.htmlcss.resources.images.raster | The **com.groupdocs.editor.htmlcss.resources.images.raster** namespace provides classes that represent only raster image resources. |
| com.groupdocs.editor.htmlcss.resources.images.vector | The **com.groupdocs.editor.htmlcss.resources.images.vector** namespace provides classes that represent only vector image resources. |
| com.groupdocs.editor.htmlcss.resources.textual | The **com.groupdocs.editor.htmlcss.resources.textual** namespace provides classes that represent text resources. |
| com.groupdocs.editor.htmlcss.serialization | The **com.groupdocs.editor.htmlcss.serialization** namespace provides types, that are responsible for tuning HTML and CSS markup serialization process.. |
| com.groupdocs.editor.license | The **com.groupdocs.editor.license** Provides methods to license the component. |
| com.groupdocs.editor.metadata | The **com.groupdocs.editor.metadata** namespace provides classes for describing basic document properties dependent on document type. |
| com.groupdocs.editor.options | The **com.groupdocs.editor.options** namespace provides interfaces for load and save options. |
| com.groupdocs.editor.words.fieldmanagement | The **com.groupdocs.editor.words.fieldmanagement** namespace contains classes and interfaces related to the management and manipulation of form fields within documents. |

### com.groupdocs.editor.formats.abstraction
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats.abstraction.md

The **com.groupdocs.editor.formats.abstraction** namespace provides interfaces and classes that describe supported document formats in the GroupDocs.Editor library.

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentFormat | Represents the root interface for all supporting document formats. |

### IDocumentFormat
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats.abstraction/idocumentformat.md

### com.groupdocs.editor.formats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats.md

The **com.groupdocs.editor.formats** namespace provides interfaces and classes that describes supported document formats.

#### Classes

| Class | Description |
| --- | --- |
| EBookFormats | Encapsulates all eBook formats. |
| EmailFormats | Encapsulates all emails formats. |
| FixedLayoutFormats | Encapsulates all fixed-layout (also know as "fixed-page") formats, which includes PDF and XPS (this does not include raster images) |
| PresentationFormats | Encapsulates all Presentation formats. |
| SpreadsheetFormats | Encapsulates all binary, XML and textual Spreadsheet formats (excluding all textual delimiter-based formats with separator like CSV, TSV, semicolon-delimited etc.), in which the workbook can be saved. |
| TextualFormats | Encapsulates all textual (text-based) formats, including markup (XML, HTML) and others. |
| WordProcessingFormats | Encapsulates all WordProcessing formats. |

### EBookFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/ebookformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class EBookFormats extends DocumentFormatBase
```

Encapsulates all eBook formats. Includes the following file types: Mobi, Epub Learn more about Mobi format [here][], and about ePub format [here][here 1].

[here]: https://docs.fileformat.com/ebook/mobi/
[here 1]: https://docs.fileformat.com/ebook/epub/
#### Fields

| Field | Description |
| --- | --- |
| Mobi | MOBI is the name given to the format developed for the MobiPocket Reader. |
| Epub | Electronic Publication (IDPF ePub) format is an e-book file format that provides a standard digital publication format for publishers and consumers. |
| Azw3 | AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all EBookFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type EBookFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a EBookFormats object. |
##### Mobi
```
public static final EBookFormats Mobi
```

MOBI is the name given to the format developed for the MobiPocket Reader. Also called PRC, AZW. It is currently used by Amazon with a slightly different DRM scheme and called AZW. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/ebook/mobi/

##### Epub
```
public static final EBookFormats Epub
```

Electronic Publication (IDPF ePub) format is an e-book file format that provides a standard digital publication format for publishers and consumers. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/ebook/epub/

##### Azw3
```
public static final EBookFormats Azw3
```

AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices. The format is an enhancement to older AZW files. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/ebook/azw3/

##### getAll()
```
public static List<EBookFormats> getAll()
```

Gets an enumerable collection of all EBookFormats.

Value: An  IEnumerable\{EBookFormats\}  containing all instances of EBookFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.EBookFormats>
##### fromExtension(String extension)
```
public static EBookFormats fromExtension(String extension)
```

Retrieves an instance of the specified type EBookFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
EBookFormats - An instance of the specified type EBookFormats with the specified file extension.
##### fromString(String extension)
```
public static EBookFormats fromString(String extension)
```

Converts a string representing a file extension to a EBookFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
EBookFormats - A EBookFormats object corresponding to the specified file extension.

### EmailFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/emailformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class EmailFormats extends DocumentFormatBase
```

Encapsulates all emails formats. Includes the following file types: Tnef, Eml, Emlx, Msg, Html, Mhtml.

Learn more about emails format [here][].

[here]: https://docs.fileformat.com/email/
#### Fields

| Field | Description |
| --- | --- |
| Tnef | Transport Neutral Encapsulation Format (TNEF) is a Microsoft proprietary format for encapsulating email attachments based on Messaging Application Programming Interface (MAPI). |
| Eml | EML file format represents email messages saved using Outlook and other relevant applications. |
| Emlx | The EMLX file format is implemented and developed by Apple. |
| Msg | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. |
| Html | HTML formatted emails. |
| Mhtml | MHTML, an initialism of "MIME encapsulation of aggregate HTML documents". |
| Ics | The Internet Calendaring and Scheduling Core Object Specification (iCalendar) is an internet standard (RFC 2445) for exchanging and deploying calendaring events and scheduling. |
| Vcf | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. |
| Pst | Files with .pst extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. |
| Mbox | MBox file format is a generic term that represents a container for collection of electronic mail messages. |
| Oft | Files with .oft extension are template files that are created using Microsoft Outlook. |
| Ost | Offline Storage Table (OST) file represents user\\u2019s mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all EmailFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type EmailFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a EmailFormats object. |
##### Tnef
```
public static final EmailFormats Tnef
```

Transport Neutral Encapsulation Format (TNEF) is a Microsoft proprietary format for encapsulating email attachments based on Messaging Application Programming Interface (MAPI). Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/tnef/

##### Eml
```
public static final EmailFormats Eml
```

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/eml/

##### Emlx
```
public static final EmailFormats Emlx
```

The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/emlx/

##### Msg
```
public static final EmailFormats Msg
```

MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/msg/

##### Html
```
public static final EmailFormats Html
```

HTML formatted emails.

##### Mhtml
```
public static final EmailFormats Mhtml
```

MHTML, an initialism of "MIME encapsulation of aggregate HTML documents".

##### Ics
```
public static final EmailFormats Ics
```

The Internet Calendaring and Scheduling Core Object Specification (iCalendar) is an internet standard (RFC 2445) for exchanging and deploying calendaring events and scheduling. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/ics/

##### Vcf
```
public static final EmailFormats Vcf
```

VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/vcf/

##### Pst
```
public static final EmailFormats Pst
```

Files with .pst extension represent Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/pst/

##### Mbox
```
public static final EmailFormats Mbox
```

MBox file format is a generic term that represents a container for collection of electronic mail messages. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/mbox/

##### Oft
```
public static final EmailFormats Oft
```

Files with .oft extension are template files that are created using Microsoft Outlook. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/oft/

##### Ost
```
public static final EmailFormats Ost
```

Offline Storage Table (OST) file represents user\\u2019s mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/email/ost/

##### getAll()
```
public static List<EmailFormats> getAll()
```

Gets an enumerable collection of all EmailFormats.

Value: An  IEnumerable\{EmailFormats\}  containing all instances of EmailFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.EmailFormats>
##### fromExtension(String extension)
```
public static EmailFormats fromExtension(String extension)
```

Retrieves an instance of the specified type EmailFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
EmailFormats - An instance of the specified type EmailFormats with the specified file extension.
##### fromString(String extension)
```
public static EmailFormats fromString(String extension)
```

Converts a string representing a file extension to a EmailFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
EmailFormats - A EmailFormats object corresponding to the specified file extension.

### FixedLayoutFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/fixedlayoutformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class FixedLayoutFormats extends DocumentFormatBase
```

Encapsulates all fixed-layout (also know as "fixed-page") formats, which includes PDF and XPS (this does not include raster images)

Various document viewing or publishing applications allow users to open (Adobe Acrobat, XPS Viewer), and sometimes edit (Adobe InDesign) documents of specific formats. These applications typically produce so-called \\u201cfixed-page\\u201d format documents. Such a document format describes precisely where a document\\u2019s content is placed on every page. Internally, the PDF or XPS format contains a description of every page, as well as drawing instructions, specifying the layout of the content on the page. This is similar to image formats, describing where the content is shown either in raster or vector form.
#### Fields

| Field | Description |
| --- | --- |
| Pdf | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all FixedLayoutFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type FixedLayoutFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a FixedLayoutFormats object. |
##### Pdf
```
public static final FixedLayoutFormats Pdf
```

Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/pdf/

##### getAll()
```
public static List<FixedLayoutFormats> getAll()
```

Gets an enumerable collection of all FixedLayoutFormats.

Value: An  IEnumerable\{FixedLayoutFormats\}  containing all instances of FixedLayoutFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.FixedLayoutFormats>
##### fromExtension(String extension)
```
public static FixedLayoutFormats fromExtension(String extension)
```

Retrieves an instance of the specified type FixedLayoutFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
FixedLayoutFormats - An instance of the specified type FixedLayoutFormats with the specified file extension.
##### fromString(String extension)
```
public static FixedLayoutFormats fromString(String extension)
```

Converts a string representing a file extension to a FixedLayoutFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
FixedLayoutFormats - A FixedLayoutFormats object corresponding to the specified file extension.

### PresentationFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/presentationformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class PresentationFormats extends DocumentFormatBase
```

Encapsulates all Presentation formats. Includes the following formats: Odp, Otp, Pot, Potm, Potx, Pps, Ppsm, Ppsx, Ppt, Ppt95, Pptm, Pptx. Learn more about Presentation formats [here][].

[here]: https://wiki.fileformat.com/presentation
#### Fields

| Field | Description |
| --- | --- |
| Ppt | Microsoft PowerPoint 97-2003 Presentation (PPT). |
| Ppt95 | Microsoft PowerPoint 95 Presentation (PPT). |
| Pptx | Microsoft Office Open XML PresentationML Macro-Free Document (PPTX). |
| Pptm | Microsoft Office Open XML PresentationML Macro-Enabled Document (PPTM). |
| Pps | Microsoft PowerPoint 97-2003 SlideShow (PPS). |
| Ppsx | Microsoft Office Open XML PresentationML Macro-Free SlideShow (PPSX). |
| Ppsm | Microsoft Office Open XML PresentationML Macro-Enabled SlideShow (PPSM). |
| Pot | Microsoft PowerPoint 97-2003 Presentation Template (POT). |
| Potx | Microsoft Office Open XML PresentationML Macro-Free Template (POTX). |
| Potm | Microsoft Office Open XML PresentationML Macro-Enabled Template (POTM). |
| Odp | OpenDocument Presentation (ODP). |
| Otp | OpenDocument Presentation template (OTP). |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all PresentationFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type PresentationFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a PresentationFormats object. |
##### Ppt
```
public static final PresentationFormats Ppt
```

Microsoft PowerPoint 97-2003 Presentation (PPT). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppt

##### Ppt95
```
public static final PresentationFormats Ppt95
```

Microsoft PowerPoint 95 Presentation (PPT).

##### Pptx
```
public static final PresentationFormats Pptx
```

Microsoft Office Open XML PresentationML Macro-Free Document (PPTX). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pptx

##### Pptm
```
public static final PresentationFormats Pptm
```

Microsoft Office Open XML PresentationML Macro-Enabled Document (PPTM). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pptm

##### Pps
```
public static final PresentationFormats Pps
```

Microsoft PowerPoint 97-2003 SlideShow (PPS). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pps

##### Ppsx
```
public static final PresentationFormats Ppsx
```

Microsoft Office Open XML PresentationML Macro-Free SlideShow (PPSX). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppsx

##### Ppsm
```
public static final PresentationFormats Ppsm
```

Microsoft Office Open XML PresentationML Macro-Enabled SlideShow (PPSM). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppsm

##### Pot
```
public static final PresentationFormats Pot
```

Microsoft PowerPoint 97-2003 Presentation Template (POT). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pot

##### Potx
```
public static final PresentationFormats Potx
```

Microsoft Office Open XML PresentationML Macro-Free Template (POTX). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/potx

##### Potm
```
public static final PresentationFormats Potm
```

Microsoft Office Open XML PresentationML Macro-Enabled Template (POTM). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/potm

##### Odp
```
public static final PresentationFormats Odp
```

OpenDocument Presentation (ODP). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/odp

##### Otp
```
public static final PresentationFormats Otp
```

OpenDocument Presentation template (OTP). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/otp

##### getAll()
```
public static List<PresentationFormats> getAll()
```

Gets an enumerable collection of all PresentationFormats.

Value: An  IEnumerable\{PresentationFormats\}  containing all instances of PresentationFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.PresentationFormats>
##### fromExtension(String extension)
```
public static PresentationFormats fromExtension(String extension)
```

Retrieves an instance of the specified type PresentationFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
PresentationFormats - An instance of the specified type PresentationFormats with the specified file extension.
##### fromString(String extension)
```
public static PresentationFormats fromString(String extension)
```

Converts a string representing a file extension to a PresentationFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
PresentationFormats - A PresentationFormats object corresponding to the specified file extension.

### SpreadsheetFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/spreadsheetformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class SpreadsheetFormats extends DocumentFormatBase
```

Encapsulates all binary, XML and textual Spreadsheet formats (excluding all textual delimiter-based formats with separator like CSV, TSV, semicolon-delimited etc.), in which the workbook can be saved. Includes the following formats: Dif, Fods, Ods, Sxc, Xlam, Xls, Xlsb, Xlsm, Xlsx, Xlt, Xltm, Xltx. Learn more about Spreadsheet formats [here][].

[here]: https://wiki.fileformat.com/spreadsheet
#### Fields

| Field | Description |
| --- | --- |
| Xls | Excel 97-2003 Binary File Format (XLS). |
| Xlt | Excel 97-2003 Template (XLT). |
| Xlsx | Office Open XML Workbook Macro-Free (XLSX). |
| Xlsm | Office Open XML Workbook Macro-Enabled (XLSM). |
| Xlsb | Excel Binary Workbook (XLSB). |
| Xltx | Office Open XML Template Macro-Free (XLTX). |
| Xltm | Office Open XML Template Macro-Enabled (XLTM). |
| Xlam | Excel Add-in (XLAM). |
| SpreadsheetML | SpreadsheetML \\u2014 Microsoft Office Excel 2002 and Excel 2003 XML Format. |
| Ods | OpenDocument Spreadsheet (ODS). |
| Fods | Flat OpenDocument Spreadsheet (FODS). |
| Sxc | StarOffice or OpenOffice.org Calc XML Spreadsheet (SXC). |
| Dif | Data Interchange Format (DIF). |
| Csv | Comma Separated Values (CSV). |
| Tsv | Tab-Separated Values (TSV). |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all SpreadsheetFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type SpreadsheetFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a SpreadsheetFormats object. |
##### Xls
```
public static final SpreadsheetFormats Xls
```

Excel 97-2003 Binary File Format (XLS). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xls

##### Xlt
```
public static final SpreadsheetFormats Xlt
```

Excel 97-2003 Template (XLT). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlt

##### Xlsx
```
public static final SpreadsheetFormats Xlsx
```

Office Open XML Workbook Macro-Free (XLSX). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsx

##### Xlsm
```
public static final SpreadsheetFormats Xlsm
```

Office Open XML Workbook Macro-Enabled (XLSM). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsm

##### Xlsb
```
public static final SpreadsheetFormats Xlsb
```

Excel Binary Workbook (XLSB). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsb

##### Xltx
```
public static final SpreadsheetFormats Xltx
```

Office Open XML Template Macro-Free (XLTX). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xltx

##### Xltm
```
public static final SpreadsheetFormats Xltm
```

Office Open XML Template Macro-Enabled (XLTM). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xltm

##### Xlam
```
public static final SpreadsheetFormats Xlam
```

Excel Add-in (XLAM).

##### SpreadsheetML
```
public static final SpreadsheetFormats SpreadsheetML
```

SpreadsheetML \\u2014 Microsoft Office Excel 2002 and Excel 2003 XML Format.

##### Ods
```
public static final SpreadsheetFormats Ods
```

OpenDocument Spreadsheet (ODS). Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/ods

##### Fods
```
public static final SpreadsheetFormats Fods
```

Flat OpenDocument Spreadsheet (FODS).

##### Sxc
```
public static final SpreadsheetFormats Sxc
```

StarOffice or OpenOffice.org Calc XML Spreadsheet (SXC).

##### Dif
```
public static final SpreadsheetFormats Dif
```

Data Interchange Format (DIF).

##### Csv
```
public static final SpreadsheetFormats Csv
```

Comma Separated Values (CSV). Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/spreadsheet/csv/

##### Tsv
```
public static final SpreadsheetFormats Tsv
```

Tab-Separated Values (TSV). Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/spreadsheet/tsv/

##### getAll()
```
public static List<SpreadsheetFormats> getAll()
```

Gets an enumerable collection of all SpreadsheetFormats.

Value: An  IEnumerable\{SpreadsheetFormats\}  containing all instances of SpreadsheetFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.SpreadsheetFormats>
##### fromExtension(String extension)
```
public static SpreadsheetFormats fromExtension(String extension)
```

Retrieves an instance of the specified type SpreadsheetFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
SpreadsheetFormats - An instance of the specified type SpreadsheetFormats with the specified file extension.
##### fromString(String extension)
```
public static SpreadsheetFormats fromString(String extension)
```

Converts a string representing a file extension to a SpreadsheetFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
SpreadsheetFormats - A SpreadsheetFormats object corresponding to the specified file extension.

### TextualFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/textualformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class TextualFormats extends DocumentFormatBase
```

Encapsulates all textual (text-based) formats, including markup (XML, HTML) and others. Includes the following formats: Html, Txt, Xml. Md, Json.
#### Fields

| Field | Description |
| --- | --- |
| Html | HyperText Markup Language document (HTML) is the extension for web pages created for display in browsers. |
| Xml | eXtensible Markup Language document (XML) that is similar to HTML but different in using tags for defining objects. |
| Txt | Plain Text Document (TXT) represents a text document that contains plain text in the form of lines. |
| Md | Markdown is a lightweight markup language for creating formatted text using a plain-text editor. |
| Json | JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. |
| Mhtml | MIME encapsulation of aggregate HTML documents is a web page archive format used to combine, in a single computer file, the HTML code and its companion resources. |
| Chm | Microsoft Compiled HTML Help is a Microsoft proprietary online help binary format, consisting of a collection of HTML pages, an index and other navigation tools. |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all TextualFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type TextualFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a TextualFormats object. |
##### Html
```
public static final TextualFormats Html
```

HyperText Markup Language document (HTML) is the extension for web pages created for display in browsers. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/web/html

##### Xml
```
public static final TextualFormats Xml
```

eXtensible Markup Language document (XML) that is similar to HTML but different in using tags for defining objects. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/web/xml

##### Txt
```
public static final TextualFormats Txt
```

Plain Text Document (TXT) represents a text document that contains plain text in the form of lines. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/txt

##### Md
```
public static final TextualFormats Md
```

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/word-processing/md/

##### Json
```
public static final TextualFormats Json
```

JSON (JavaScript Object Notation) is an open standard file format for sharing data that uses human-readable text to store and transmit data. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/web/json/

##### Mhtml
```
public static final TextualFormats Mhtml
```

MIME encapsulation of aggregate HTML documents is a web page archive format used to combine, in a single computer file, the HTML code and its companion resources. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/web/mhtml/

##### Chm
```
public static final TextualFormats Chm
```

Microsoft Compiled HTML Help is a Microsoft proprietary online help binary format, consisting of a collection of HTML pages, an index and other navigation tools. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/web/chm/

##### getAll()
```
public static List<TextualFormats> getAll()
```

Gets an enumerable collection of all TextualFormats.

Value: An  IEnumerable\{TextualFormats\}  containing all instances of TextualFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.TextualFormats>
##### fromExtension(String extension)
```
public static TextualFormats fromExtension(String extension)
```

Retrieves an instance of the specified type TextualFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
TextualFormats - An instance of the specified type TextualFormats with the specified file extension.
##### fromString(String extension)
```
public static TextualFormats fromString(String extension)
```

Converts a string representing a file extension to a TextualFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
TextualFormats - A TextualFormats object corresponding to the specified file extension.

### WordProcessingFormats
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.formats/wordprocessingformats.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.formats.abstraction.FormatFamilyBase, com.groupdocs.editor.formats.abstraction.DocumentFormatBase
```
public class WordProcessingFormats extends DocumentFormatBase
```

Encapsulates all WordProcessing formats. Includes the following file types: Doc, Docm, Docx, Dot, Dotm, Dotx, FlatOpc, Odt, Ott, Rtf, WordML. Learn more about Word Processing formats [here][].

MIME codes are grabbed from the given resources: https://filext.com/faq/office\_mime\_types.html https://docs.microsoft.com/en-us/previous-versions//cc179224(v=technet.10)

[here]: https://wiki.fileformat.com/word-processing
#### Fields

| Field | Description |
| --- | --- |
| Doc | MS Word 97-2007 Binary File Format (DOC) represents documents generated by Microsoft Word or other word processing documents in binary file format. |
| Docx | Office Open XML WordProcessingML Macro-Free Document (DOCX) is a well-known format for Microsoft Word documents. |
| Dot | MS Word 97-2007 Template (DOT) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. |
| Docm | Office Open XML WordProcessingML Macro-Enabled Document (DOCM) files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| Dotx | Office Open XML WordprocessingML Macro-Free Template (DOTX) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| Dotm | Office Open XML WordprocessingML Macro-Enabled Template (DOTM) represents template files created with Microsoft Word 2007 or higher. |
| FlatOpc | Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package. |
| Rtf | Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. |
| Odt | Open Document Format Text Document (ODT) files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| Ott | Open Document Format Text Document Template (OTT) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. |
| WordML | Microsoft Office Word 2003 XML Format \\u2014 WordProcessingML or WordML (.XML). |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets an enumerable collection of all WordProcessingFormats. |
| fromExtension(String extension) | Retrieves an instance of the specified type WordProcessingFormats that has the specified file extension. |
| fromString(String extension) | Converts a string representing a file extension to a WordProcessingFormats object. |
##### Doc
```
public static final WordProcessingFormats Doc
```

MS Word 97-2007 Binary File Format (DOC) represents documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/doc

##### Docx
```
public static final WordProcessingFormats Docx
```

Office Open XML WordProcessingML Macro-Free Document (DOCX) is a well-known format for Microsoft Word documents. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/docx

##### Dot
```
public static final WordProcessingFormats Dot
```

MS Word 97-2007 Template (DOT) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dot

##### Docm
```
public static final WordProcessingFormats Docm
```

Office Open XML WordProcessingML Macro-Enabled Document (DOCM) files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/docm

##### Dotx
```
public static final WordProcessingFormats Dotx
```

Office Open XML WordprocessingML Macro-Free Template (DOTX) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dotx

##### Dotm
```
public static final WordProcessingFormats Dotm
```

Office Open XML WordprocessingML Macro-Enabled Template (DOTM) represents template files created with Microsoft Word 2007 or higher. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dotm

##### FlatOpc
```
public static final WordProcessingFormats FlatOpc
```

Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.

##### Rtf
```
public static final WordProcessingFormats Rtf
```

Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/rtf

##### Odt
```
public static final WordProcessingFormats Odt
```

Open Document Format Text Document (ODT) files are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/odt

##### Ott
```
public static final WordProcessingFormats Ott
```

Open Document Format Text Document Template (OTT) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/ott

##### WordML
```
public static final WordProcessingFormats WordML
```

Microsoft Office Word 2003 XML Format \\u2014 WordProcessingML or WordML (.XML).

https://en.wikipedia.org/wiki/Microsoft\_Office\_XML\_formats

##### getAll()
```
public static List<WordProcessingFormats> getAll()
```

Gets an enumerable collection of all WordProcessingFormats.

Value: An  IEnumerable\{WordProcessingFormats\}  containing all instances of WordProcessingFormats.

**Returns:**
java.util.List<com.groupdocs.editor.formats.WordProcessingFormats>
##### fromExtension(String extension)
```
public static WordProcessingFormats fromExtension(String extension)
```

Retrieves an instance of the specified type WordProcessingFormats that has the specified file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension of the document format. |

**Returns:**
WordProcessingFormats - An instance of the specified type WordProcessingFormats with the specified file extension.
##### fromString(String extension)
```
public static WordProcessingFormats fromString(String extension)
```

Converts a string representing a file extension to a WordProcessingFormats object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

**Returns:**
WordProcessingFormats - A WordProcessingFormats object corresponding to the specified file extension.

### com.groupdocs.editor.htmlcss.css.datatypes
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes.md

The **com.groupdocs.editor.htmlcss.css.datatypes** namespace provides classes that represent CSS data types.

#### Classes

| Class | Description |
| --- | --- |
| ArgbColor | Represents one color value in ARGB format with converters and serializers |
| ArgbColors | Contains all "known colors", that have fixed unique name and value in CSS standart |
| Length | Represents a CSS length value in any supportable unit, including percentage and unitless type. |
| LengthUnit | All supported length units |
| Ratio | Represents a "ratio" CSS data type, which is used for describing aspect ratios in media queries and for raster images by denoting the proportion between two unitless values called "numerator" and "denominator". |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICssDataType | Common interface for all CSS data types, which are used in the CSS properties |

### ArgbColor
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes/argbcolor.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.lang.Struct

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType
```
public class ArgbColor extends Struct<ArgbColor> implements ICssDataType
```

Represents one color value in ARGB format with converters and serializers

This type is designed to be useful for (but not limited to) CSS operations. See more: https://developer.mozilla.org/en-US/docs/Web/CSS/color\_value
#### Constructors

| Constructor | Description |
| --- | --- |
| ArgbColor() |  |
| ArgbColor(int r, int g, int b) |  |
#### Methods

| Method | Description |
| --- | --- |
| fromRgba(int red, int green, int blue, int alpha) | Creates one ArgbColor value from specified Red, Green, Blue, and Alpha channels |
| fromRgb(int red, int green, int blue) | Creates one ArgbColor value from specified Red, Green, Blue channels, while Alpha channel is fully opaque |
| fromSingleValueRgb(byte value) | Creates a fully opaque (A=255) color from single value, which will be applied to all channels |
| fromColor(Color color) | Creates one ArgbColor value from specified Color |
| getValue() | Gets the Int32 value of the color. |
| getA() | Gets the alpha part of the color. |
| getAlpha() | Gets the alpha part of the color in percent (0..1). |
| getR() | Gets the red part of the color. |
| getG() | Gets the green part of the color. |
| getB() | Gets the blue part of the color. |
| isEmpty() | Uninitialized color - all 4 channels are set to 0. |
| isDefault() | Indicates whether this ArgbColor instance is default (Transparent) - all 4 channels are set to 0 |
| isFullyTransparent() | Indicates whether this ArgbColor instance is fully transparent - its Alpha channel has the min (0) value, so other R, G, and B channels has no visible effect. |
| isTranslucent() | Indicates whether this ArgbColor instance is translucent (not fully transparent, but also not fully opaque) |
| isFullyOpaque() | Indicates whether this ArgbColor instance is fully opaque, without transparency (its Alpha channel has max value) |
| toSystemColor() | Converts a value of this ArgbColor instance to the Color instance and returns it |
| toRGBA() | Serializes this ArgbColor instance to the 'rgba' CSS function notation |
| toRGB() | Serializes this ArgbColor instance to the 'rgb' CSS function notation |
| serializeDefault() | Serializes this ArgbColor instance to the most appropriate CSS function notation depending on translucency |
| toString() | Same as \#serializeDefault.serializeDefault |
| op_Equality(ArgbColor left, ArgbColor right) | Compares two colors and returns a boolean indicating if the two do match. |
| op_Inequality(ArgbColor left, ArgbColor right) | Compares two colors and returns a boolean indicating if the two do not match. |
| equals(ArgbColor other) | Checks two ArgbColor colors for equality |
| equals(ICssDataType other) | Checks two ArgbColor colors for equality |
| equals(Object other) | Tests if another object is equal to this ArgbColor instance. |
| hashCode() | Returns a hash code that defines the current color. |
##### ArgbColor()
```
public ArgbColor()
```

##### ArgbColor(int r, int g, int b)
```
public ArgbColor(int r, int g, int b)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| r | int |  |
| g | int |  |
| b | int |  |

##### fromRgba(int red, int green, int blue, int alpha)
```
public static ArgbColor fromRgba(int red, int green, int blue, int alpha)
```

Creates one ArgbColor value from specified Red, Green, Blue, and Alpha channels

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | Red channel value |
| green | int | Green channel value |
| blue | int | Blue channel value |
| alpha | int | Alpha channel value |

**Returns:**
ArgbColor - New ArgbColor value
##### fromRgb(int red, int green, int blue)
```
public static ArgbColor fromRgb(int red, int green, int blue)
```

Creates one ArgbColor value from specified Red, Green, Blue channels, while Alpha channel is fully opaque

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | Red channel value |
| green | int | Green channel value |
| blue | int | Blue channel value |

**Returns:**
ArgbColor - New ArgbColor value
##### fromSingleValueRgb(byte value)
```
public static ArgbColor fromSingleValueRgb(byte value)
```

Creates a fully opaque (A=255) color from single value, which will be applied to all channels

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | A byte value, same for Red, Green, and Blue channels |

**Returns:**
ArgbColor - New ArgbColor instance
##### fromColor(Color color)
```
public static ArgbColor fromColor(Color color)
```

Creates one ArgbColor value from specified Color

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | java.awt.Color |  |

**Returns:**
ArgbColor -
##### getValue()
```
public final int getValue()
```

Gets the Int32 value of the color.

**Returns:**
int
##### getA()
```
public final int getA()
```

Gets the alpha part of the color.

**Returns:**
int
##### getAlpha()
```
public final double getAlpha()
```

Gets the alpha part of the color in percent (0..1).

**Returns:**
double
##### getR()
```
public final int getR()
```

Gets the red part of the color.

**Returns:**
int
##### getG()
```
public final int getG()
```

Gets the green part of the color.

**Returns:**
int
##### getB()
```
public final int getB()
```

Gets the blue part of the color.

**Returns:**
int
##### isEmpty()
```
public final boolean isEmpty()
```

Uninitialized color - all 4 channels are set to 0. Same as Default and Transparent.

**Returns:**
boolean
##### isDefault()
```
public final boolean isDefault()
```

Indicates whether this ArgbColor instance is default (Transparent) - all 4 channels are set to 0

**Returns:**
boolean
##### isFullyTransparent()
```
public final boolean isFullyTransparent()
```

Indicates whether this ArgbColor instance is fully transparent - its Alpha channel has the min (0) value, so other R, G, and B channels has no visible effect.

**Returns:**
boolean
##### isTranslucent()
```
public final boolean isTranslucent()
```

Indicates whether this ArgbColor instance is translucent (not fully transparent, but also not fully opaque)

**Returns:**
boolean
##### isFullyOpaque()
```
public final boolean isFullyOpaque()
```

Indicates whether this ArgbColor instance is fully opaque, without transparency (its Alpha channel has max value)

**Returns:**
boolean
##### toSystemColor()
```
public final Color toSystemColor()
```

Converts a value of this ArgbColor instance to the Color instance and returns it

**Returns:**
Color - New Color instance
##### toRGBA()
```
public final String toRGBA()
```

Serializes this ArgbColor instance to the 'rgba' CSS function notation

**Returns:**
java.lang.String - A string with 'rgba(r, g, b, a)' format
##### toRGB()
```
public final String toRGB()
```

Serializes this ArgbColor instance to the 'rgb' CSS function notation

**Returns:**
java.lang.String - A string with 'rgb(r, g, b)' format
##### serializeDefault()
```
public final String serializeDefault()
```

Serializes this ArgbColor instance to the most appropriate CSS function notation depending on translucency

**Returns:**
java.lang.String - A string with 'rgba(r, g, b, a)' or 'rgb(r, g, b)' format
##### toString()
```
public String toString()
```

Same as \#serializeDefault.serializeDefault

**Returns:**
java.lang.String - Same return value as in \#serializeDefault.serializeDefault
##### op_Equality(ArgbColor left, ArgbColor right)
```
public static boolean op_Equality(ArgbColor left, ArgbColor right)
```

Compares two colors and returns a boolean indicating if the two do match.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | ArgbColor | The first color to use. |
| right | ArgbColor | The second color to use. |

**Returns:**
boolean - True if both colors are equal, otherwise false.
##### op_Inequality(ArgbColor left, ArgbColor right)
```
public static boolean op_Inequality(ArgbColor left, ArgbColor right)
```

Compares two colors and returns a boolean indicating if the two do not match.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | ArgbColor | The first color to use. |
| right | ArgbColor | The second color to use. |

**Returns:**
boolean - True if both colors are not equal, otherwise false.
##### equals(ArgbColor other)
```
public final boolean equals(ArgbColor other)
```

Checks two ArgbColor colors for equality

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ArgbColor | The other ArgbColor color |

**Returns:**
boolean - True if both colors or equal, otherwise false.
##### equals(ICssDataType other)
```
public final boolean equals(ICssDataType other)
```

Checks two ArgbColor colors for equality

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ICssDataType | The other ArgbColor color, casted to the ICssDataType |

**Returns:**
boolean - True if both colors or equal, otherwise false.
##### equals(Object other)
```
public boolean equals(Object other)
```

Tests if another object is equal to this ArgbColor instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | The object to test with. |

**Returns:**
boolean - True if the two objects are equal, otherwise false.
##### hashCode()
```
public int hashCode()
```

Returns a hash code that defines the current color.

**Returns:**
int - The integer value of the hashcode.

### ArgbColors
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes/argbcolors.md

**Inheritance:**
java.lang.Object
```
public class ArgbColors
```

Contains all "known colors", that have fixed unique name and value in CSS standart

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color
#### Constructors

| Constructor | Description |
| --- | --- |
| ArgbColors() |  |
#### Fields

| Field | Description |
| --- | --- |
| Empty | Returns an empty color, which has no channels info and is fully transparent. |
| Transparent | Fully transparent empty color. |
| Black | Black color |
| Silver | Silver color |
| Gray | Gray color |
| White | White color |
| Maroon | Maroon color |
| Red | Red color |
| Purple | Purple color |
| Fuchsia | Fuchsia color, also known as Magenta |
| Green | Green color |
| Lime | Lime color, also known as Pure Green |
| Olive | Olive color |
| Yellow | Yellow color |
| Navy | Navy color |
| Blue | Blue color |
| Teal | Teal color |
| Aqua | Aqua color |
| Orange | Orange color |
| Aliceblue | Alice Blue color |
| Antiquewhite | Antique White color |
| Aquamarine | Aquamarine color |
| Azure | Azure color |
| Beige | Beige color |
| Bisque | Bisque color |
| Blanchedalmond | Blanched Almond color |
| Blueviolet | Blue Violet color |
| Brown | Brown color |
| Burlywood | Burly Wood color |
| Cadetblue | Cadet Blue color |
| Chartreuse | Chart Reuse color |
| Chocolate | Chocolate color |
| Coral | Coral color |
| Cornflowerblue | Corn flower blue color |
| Cornsilk | Corn silk color |
| Crimson | Crimson color |
| Cyan | Cyan color, also known as Aqua from CssLevel1 |
| Darkblue | Dark blue color |
| Darkcyan | Dark cyan color |
| Darkgoldenrod | Dark golden rod color |
| Darkgray | Dark gray color |
| Darkgreen | Dark green color |
| Darkgrey | Dark grey color - same as Dark gray |
| Darkkhaki | Dark khaki color |
| Darkmagenta | Dark magenta color |
| Darkolivegreen | Dark olive green color |
| Darkorange | Dark orange color |
| Darkorchid | Dark orchid color |
| Darkred | Dark red color |
| Darksalmon | Dark salmon color |
| Darkseagreen | Dark sea green color |
| Darkslateblue | Dark slate blue color |
| Darkslategray | Dark slate gray color |
| Darkslategrey | Dark slate grey color - same as Dark slate gray |
| Darkturquoise | Dark turquoise color |
| Darkviolet | Dark violet color |
| Deeppink | Deep pink color |
| Deepskyblue | Deep sky blue color |
| Dimgray | Dim gray color |
| Dimgrey | Dim grey color - same as Dim gray |
| Dodgerblue | Dodger blue color |
| Firebrick | Fire brick color |
| Floralwhite | Floral white color |
| Forestgreen | Forest green color |
| Gainsboro | Gains boro color |
| Ghostwhite | Ghost white color |
| Gold | Gold color |
| Goldenrod | Goldenrod color |
| Greenyellow | Green yellow color |
| Grey | Grey color - same as Gray from CSS Level 1 |
| Honeydew | Honey dew color |
| Hotpink | Hot pink color |
| Indianred | Indian red color |
| Indigo | Indigo color |
| Ivory | Ivory color |
| Khaki | Khaki color |
| Lavender | Lavender color |
| Lavenderblush | Lavender blush color |
| Lawngreen | Lawngreen color |
| Lemonchiffon | Lemonchiffon color |
| Lightblue | Lightblue color |
| Lightcoral | Lightcoral color |
| Lightcyan | Lightcyan color |
| Lightgoldenrodyellow | Lightgoldenrodyellow color |
| Lightgray | Lightgray color - same as Lightgrey |
| Lightgreen | Lightgreen color |
| Lightgrey | Lightgrey color - same as Lightgray |
| Lightpink | Lightpink color |
| Lightsalmon | Lightsalmon color |
| Lightseagreen | Lightseagreen color |
| Lightskyblue | Lightskyblue color |
| Lightslategray | Lightslategray color - same as Lightslategrey |
| Lightslategrey | Lightslategrey color - same as Lightslategray |
| Lightsteelblue | Lightsteelblue color |
| Lightyellow | Lightyellow color |
| Limegreen | Limegreen color |
| Linen | Linen color |
| Magenta | Magenta color, also known as Fuchsia from CssLevel1 |
| Mediumaquamarine | Mediumaquamarine color |
| Mediumblue | Mediumblue color |
| Mediumorchid | Mediumorchid color |
| Mediumpurple | Mediumpurple color |
| Mediumseagreen | Mediumseagreen color |
| Mediumslateblue | Mediumslateblue color |
| Mediumspringgreen | Mediumspringgreen color |
| Mediumturquoise | Mediumturquoise color |
| Mediumvioletred | Mediumvioletred color |
| Midnightblue | Midnightblue color |
| Mintcream | Mintcream color |
| Mistyrose | Mistyrose color |
| Moccasin | Moccasin color |
| Navajowhite | Navajowhite color |
| Oldlace | Oldlace color |
| Olivedrab | Olivedrab color |
| Orangered | Orangered color |
| Orchid | Orchid color |
| Palegoldenrod | Palegoldenrod color |
| Palegreen | Palegreen color |
| Paleturquoise | Paleturquoise color |
| Palevioletred | Palevioletred color |
| Papayawhip | Papayawhip color |
| Peachpuff | Peachpuff color |
| Peru | Peru color |
| Pink | Pink color |
| Plum | Plum color |
| Powderblue | Powderblue color |
| Rosybrown | Rosybrown color |
| Royalblue | Royalblue color |
| Saddlebrown | Saddlebrown color |
| Salmon | Salmon color |
| Sandybrown | Sandybrown color |
| Seagreen | Seagreen color |
| Seashell | Seashell color |
| Sienna | Sienna color |
| Skyblue | Skyblue color |
| Slateblue | Slateblue color |
| Slategray | Slategray color - same as Slategrey |
| Slategrey | Slategrey color - same as Slategray |
| Snow | Snow color |
| Springgreen | Springgreen color |
| Steelblue | Steelblue color |
| Tan | Tan color |
| Thistle | Thistle color |
| Tomato | Tomato color |
| Turquoise | Turquoise color |
| Violet | Violet color |
| Wheat | Wheat color |
| Whitesmoke | Whitesmoke color |
| Yellowgreen | Yellowgreen color |
| Rebeccapurple | Rebecca Purple color |
#### Methods

| Method | Description |
| --- | --- |
| tryFind(String keyword, ArgbColor[] output) | Tries to find a color by its string name |
##### ArgbColors()
```
public ArgbColors()
```

##### Empty
```
public static final ArgbColor Empty
```

Returns an empty color, which has no channels info and is fully transparent. Same as '\#Transparent.Transparent'. Default value.

##### Transparent
```
public static final ArgbColor Transparent
```

Fully transparent empty color. The same as default '\#Empty.Empty' color value.

##### Black
```
public static final ArgbColor Black
```

Black color

##### Silver
```
public static final ArgbColor Silver
```

Silver color

##### Gray
```
public static final ArgbColor Gray
```

Gray color

##### White
```
public static final ArgbColor White
```

White color

##### Maroon
```
public static final ArgbColor Maroon
```

Maroon color

##### Red
```
public static final ArgbColor Red
```

Red color

##### Purple
```
public static final ArgbColor Purple
```

Purple color

##### Fuchsia
```
public static final ArgbColor Fuchsia
```

Fuchsia color, also known as Magenta

##### Green
```
public static final ArgbColor Green
```

Green color

##### Lime
```
public static final ArgbColor Lime
```

Lime color, also known as Pure Green

##### Olive
```
public static final ArgbColor Olive
```

Olive color

##### Yellow
```
public static final ArgbColor Yellow
```

Yellow color

##### Navy
```
public static final ArgbColor Navy
```

Navy color

##### Blue
```
public static final ArgbColor Blue
```

Blue color

##### Teal
```
public static final ArgbColor Teal
```

Teal color

##### Aqua
```
public static final ArgbColor Aqua
```

Aqua color

##### Orange
```
public static final ArgbColor Orange
```

Orange color

##### Aliceblue
```
public static final ArgbColor Aliceblue
```

Alice Blue color

##### Antiquewhite
```
public static final ArgbColor Antiquewhite
```

Antique White color

##### Aquamarine
```
public static final ArgbColor Aquamarine
```

Aquamarine color

##### Azure
```
public static final ArgbColor Azure
```

Azure color

##### Beige
```
public static final ArgbColor Beige
```

Beige color

##### Bisque
```
public static final ArgbColor Bisque
```

Bisque color

##### Blanchedalmond
```
public static final ArgbColor Blanchedalmond
```

Blanched Almond color

##### Blueviolet
```
public static final ArgbColor Blueviolet
```

Blue Violet color

##### Brown
```
public static final ArgbColor Brown
```

Brown color

##### Burlywood
```
public static final ArgbColor Burlywood
```

Burly Wood color

##### Cadetblue
```
public static final ArgbColor Cadetblue
```

Cadet Blue color

##### Chartreuse
```
public static final ArgbColor Chartreuse
```

Chart Reuse color

##### Chocolate
```
public static final ArgbColor Chocolate
```

Chocolate color

##### Coral
```
public static final ArgbColor Coral
```

Coral color

##### Cornflowerblue
```
public static final ArgbColor Cornflowerblue
```

Corn flower blue color

##### Cornsilk
```
public static final ArgbColor Cornsilk
```

Corn silk color

##### Crimson
```
public static final ArgbColor Crimson
```

Crimson color

##### Cyan
```
public static final ArgbColor Cyan
```

Cyan color, also known as Aqua from CssLevel1

##### Darkblue
```
public static final ArgbColor Darkblue
```

Dark blue color

##### Darkcyan
```
public static final ArgbColor Darkcyan
```

Dark cyan color

##### Darkgoldenrod
```
public static final ArgbColor Darkgoldenrod
```

Dark golden rod color

##### Darkgray
```
public static final ArgbColor Darkgray
```

Dark gray color

##### Darkgreen
```
public static final ArgbColor Darkgreen
```

Dark green color

##### Darkgrey
```
public static final ArgbColor Darkgrey
```

Dark grey color - same as Dark gray

##### Darkkhaki
```
public static final ArgbColor Darkkhaki
```

Dark khaki color

##### Darkmagenta
```
public static final ArgbColor Darkmagenta
```

Dark magenta color

##### Darkolivegreen
```
public static final ArgbColor Darkolivegreen
```

Dark olive green color

##### Darkorange
```
public static final ArgbColor Darkorange
```

Dark orange color

##### Darkorchid
```
public static final ArgbColor Darkorchid
```

Dark orchid color

##### Darkred
```
public static final ArgbColor Darkred
```

Dark red color

##### Darksalmon
```
public static final ArgbColor Darksalmon
```

Dark salmon color

##### Darkseagreen
```
public static final ArgbColor Darkseagreen
```

Dark sea green color

##### Darkslateblue
```
public static final ArgbColor Darkslateblue
```

Dark slate blue color

##### Darkslategray
```
public static final ArgbColor Darkslategray
```

Dark slate gray color

##### Darkslategrey
```
public static final ArgbColor Darkslategrey
```

Dark slate grey color - same as Dark slate gray

##### Darkturquoise
```
public static final ArgbColor Darkturquoise
```

Dark turquoise color

##### Darkviolet
```
public static final ArgbColor Darkviolet
```

Dark violet color

##### Deeppink
```
public static final ArgbColor Deeppink
```

Deep pink color

##### Deepskyblue
```
public static final ArgbColor Deepskyblue
```

Deep sky blue color

##### Dimgray
```
public static final ArgbColor Dimgray
```

Dim gray color

##### Dimgrey
```
public static final ArgbColor Dimgrey
```

Dim grey color - same as Dim gray

##### Dodgerblue
```
public static final ArgbColor Dodgerblue
```

Dodger blue color

##### Firebrick
```
public static final ArgbColor Firebrick
```

Fire brick color

##### Floralwhite
```
public static final ArgbColor Floralwhite
```

Floral white color

##### Forestgreen
```
public static final ArgbColor Forestgreen
```

Forest green color

##### Gainsboro
```
public static final ArgbColor Gainsboro
```

Gains boro color

##### Ghostwhite
```
public static final ArgbColor Ghostwhite
```

Ghost white color

##### Gold
```
public static final ArgbColor Gold
```

Gold color

##### Goldenrod
```
public static final ArgbColor Goldenrod
```

Goldenrod color

##### Greenyellow
```
public static final ArgbColor Greenyellow
```

Green yellow color

##### Grey
```
public static final ArgbColor Grey
```

Grey color - same as Gray from CSS Level 1

##### Honeydew
```
public static final ArgbColor Honeydew
```

Honey dew color

##### Hotpink
```
public static final ArgbColor Hotpink
```

Hot pink color

##### Indianred
```
public static final ArgbColor Indianred
```

Indian red color

##### Indigo
```
public static final ArgbColor Indigo
```

Indigo color

##### Ivory
```
public static final ArgbColor Ivory
```

Ivory color

##### Khaki
```
public static final ArgbColor Khaki
```

Khaki color

##### Lavender
```
public static final ArgbColor Lavender
```

Lavender color

##### Lavenderblush
```
public static final ArgbColor Lavenderblush
```

Lavender blush color

##### Lawngreen
```
public static final ArgbColor Lawngreen
```

Lawngreen color

##### Lemonchiffon
```
public static final ArgbColor Lemonchiffon
```

Lemonchiffon color

##### Lightblue
```
public static final ArgbColor Lightblue
```

Lightblue color

##### Lightcoral
```
public static final ArgbColor Lightcoral
```

Lightcoral color

##### Lightcyan
```
public static final ArgbColor Lightcyan
```

Lightcyan color

##### Lightgoldenrodyellow
```
public static final ArgbColor Lightgoldenrodyellow
```

Lightgoldenrodyellow color

##### Lightgray
```
public static final ArgbColor Lightgray
```

Lightgray color - same as Lightgrey

##### Lightgreen
```
public static final ArgbColor Lightgreen
```

Lightgreen color

##### Lightgrey
```
public static final ArgbColor Lightgrey
```

Lightgrey color - same as Lightgray

##### Lightpink
```
public static final ArgbColor Lightpink
```

Lightpink color

##### Lightsalmon
```
public static final ArgbColor Lightsalmon
```

Lightsalmon color

##### Lightseagreen
```
public static final ArgbColor Lightseagreen
```

Lightseagreen color

##### Lightskyblue
```
public static final ArgbColor Lightskyblue
```

Lightskyblue color

##### Lightslategray
```
public static final ArgbColor Lightslategray
```

Lightslategray color - same as Lightslategrey

##### Lightslategrey
```
public static final ArgbColor Lightslategrey
```

Lightslategrey color - same as Lightslategray

##### Lightsteelblue
```
public static final ArgbColor Lightsteelblue
```

Lightsteelblue color

##### Lightyellow
```
public static final ArgbColor Lightyellow
```

Lightyellow color

##### Limegreen
```
public static final ArgbColor Limegreen
```

Limegreen color

##### Linen
```
public static final ArgbColor Linen
```

Linen color

##### Magenta
```
public static final ArgbColor Magenta
```

Magenta color, also known as Fuchsia from CssLevel1

##### Mediumaquamarine
```
public static final ArgbColor Mediumaquamarine
```

Mediumaquamarine color

##### Mediumblue
```
public static final ArgbColor Mediumblue
```

Mediumblue color

##### Mediumorchid
```
public static final ArgbColor Mediumorchid
```

Mediumorchid color

##### Mediumpurple
```
public static final ArgbColor Mediumpurple
```

Mediumpurple color

##### Mediumseagreen
```
public static final ArgbColor Mediumseagreen
```

Mediumseagreen color

##### Mediumslateblue
```
public static final ArgbColor Mediumslateblue
```

Mediumslateblue color

##### Mediumspringgreen
```
public static final ArgbColor Mediumspringgreen
```

Mediumspringgreen color

##### Mediumturquoise
```
public static final ArgbColor Mediumturquoise
```

Mediumturquoise color

##### Mediumvioletred
```
public static final ArgbColor Mediumvioletred
```

Mediumvioletred color

##### Midnightblue
```
public static final ArgbColor Midnightblue
```

Midnightblue color

##### Mintcream
```
public static final ArgbColor Mintcream
```

Mintcream color

##### Mistyrose
```
public static final ArgbColor Mistyrose
```

Mistyrose color

##### Moccasin
```
public static final ArgbColor Moccasin
```

Moccasin color

##### Navajowhite
```
public static final ArgbColor Navajowhite
```

Navajowhite color

##### Oldlace
```
public static final ArgbColor Oldlace
```

Oldlace color

##### Olivedrab
```
public static final ArgbColor Olivedrab
```

Olivedrab color

##### Orangered
```
public static final ArgbColor Orangered
```

Orangered color

##### Orchid
```
public static final ArgbColor Orchid
```

Orchid color

##### Palegoldenrod
```
public static final ArgbColor Palegoldenrod
```

Palegoldenrod color

##### Palegreen
```
public static final ArgbColor Palegreen
```

Palegreen color

##### Paleturquoise
```
public static final ArgbColor Paleturquoise
```

Paleturquoise color

##### Palevioletred
```
public static final ArgbColor Palevioletred
```

Palevioletred color

##### Papayawhip
```
public static final ArgbColor Papayawhip
```

Papayawhip color

##### Peachpuff
```
public static final ArgbColor Peachpuff
```

Peachpuff color

##### Peru
```
public static final ArgbColor Peru
```

Peru color

##### Pink
```
public static final ArgbColor Pink
```

Pink color

##### Plum
```
public static final ArgbColor Plum
```

Plum color

##### Powderblue
```
public static final ArgbColor Powderblue
```

Powderblue color

##### Rosybrown
```
public static final ArgbColor Rosybrown
```

Rosybrown color

##### Royalblue
```
public static final ArgbColor Royalblue
```

Royalblue color

##### Saddlebrown
```
public static final ArgbColor Saddlebrown
```

Saddlebrown color

##### Salmon
```
public static final ArgbColor Salmon
```

Salmon color

##### Sandybrown
```
public static final ArgbColor Sandybrown
```

Sandybrown color

##### Seagreen
```
public static final ArgbColor Seagreen
```

Seagreen color

##### Seashell
```
public static final ArgbColor Seashell
```

Seashell color

##### Sienna
```
public static final ArgbColor Sienna
```

Sienna color

##### Skyblue
```
public static final ArgbColor Skyblue
```

Skyblue color

##### Slateblue
```
public static final ArgbColor Slateblue
```

Slateblue color

##### Slategray
```
public static final ArgbColor Slategray
```

Slategray color - same as Slategrey

##### Slategrey
```
public static final ArgbColor Slategrey
```

Slategrey color - same as Slategray

##### Snow
```
public static final ArgbColor Snow
```

Snow color

##### Springgreen
```
public static final ArgbColor Springgreen
```

Springgreen color

##### Steelblue
```
public static final ArgbColor Steelblue
```

Steelblue color

##### Tan
```
public static final ArgbColor Tan
```

Tan color

##### Thistle
```
public static final ArgbColor Thistle
```

Thistle color

##### Tomato
```
public static final ArgbColor Tomato
```

Tomato color

##### Turquoise
```
public static final ArgbColor Turquoise
```

Turquoise color

##### Violet
```
public static final ArgbColor Violet
```

Violet color

##### Wheat
```
public static final ArgbColor Wheat
```

Wheat color

##### Whitesmoke
```
public static final ArgbColor Whitesmoke
```

Whitesmoke color

##### Yellowgreen
```
public static final ArgbColor Yellowgreen
```

Yellowgreen color

##### Rebeccapurple
```
public static final ArgbColor Rebeccapurple
```

Rebecca Purple color

CSS Colors Level 4 added the ' **rebeccapurple** ' keyword to honor web pioneer Eric Meyer: https://codepen.io/trezy/post/honoring-a-great-man

##### tryFind(String keyword, ArgbColor[] output)
```
public static boolean tryFind(String keyword, ArgbColor[] output)
```

Tries to find a color by its string name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keyword | java.lang.String | A color name |
| output | ArgbColor\[\] | The resultant color value on success or \#Transparent.Transparent value on failure |

**Returns:**
boolean - True if color was successfully found by its name, or false otherwise

### ICssDataType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes/icssdatatype.md

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public interface ICssDataType extends System.IEquatable<ICssDataType>
```

Common interface for all CSS data types, which are used in the CSS properties
#### Methods

| Method | Description |
| --- | --- |
| serializeDefault() | Should return a default string representation of the current value of the data type |
| isDefault() | Should define whether the current value of the data type is the default value for this specific data type or not |
##### serializeDefault()
```
public abstract String serializeDefault()
```

Should return a default string representation of the current value of the data type

**Returns:**
java.lang.String -
##### isDefault()
```
public abstract boolean isDefault()
```

Should define whether the current value of the data type is the default value for this specific data type or not

**Returns:**
boolean -

### Length
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes/length.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType
```
public class Length implements ICssDataType
```

Represents a CSS length value in any supportable unit, including percentage and unitless type. Values may be integer or float, negative, zero and positive. Immutable structure.

This type covers the next CSS data types:

https://developer.mozilla.org/en-US/docs/Web/CSS/length

https://developer.mozilla.org/en-US/docs/Web/CSS/percentage
#### Constructors

| Constructor | Description |
| --- | --- |
| Length() |  |
#### Fields

| Field | Description |
| --- | --- |
| UnitlessZero | Unitless integer zero - default value, the same as default parameterless constructor |
| OneHundredPercents | 100% |
| FiftyPercents | 50% |
| ZeroPercents | 0% |
#### Methods

| Method | Description |
| --- | --- |
| fromValueWithUnit(float value, int unit) | Creates and returns an instance of Length type by specified float number and unit |
| fromValueWithUnit(double value, int unit) | Creates and returns an instance of Length type by specified double number and unit |
| fromValueWithUnit(int value, int unit) | Creates and returns an instance of Length type by specified integer number and unit |
| isUnitlessZero() | Determines whether this instance is a unitless zero or not. |
| isDefault() | Indicates whether this Length instance has a default value \\u2014 unitless zero. |
| getUnitType() | Returns a unit type of this Length instance. |
| isInteger() | Indicates whether the numeric value of this Length instance was originally specified and stored as an integer (INT32) number |
| isFloat() | Indicates whether the numeric value of this Length instance was originally specified and stored as a float (FP32) number |
| getFloatValue() | Returns a float numeric value of the Length instance. |
| getIntegerValue() | Returns an integer numeric value of this Length instance, if it is internally stored as an integer, or throws an exception, if it was originally stored as a float number. |
| isAbsolute() | Gets if the length is given in absolute units. |
| isRelative() | Gets if the length is given in relative units. |
| isZero() | Determines whether the numeric value of this length is a zero number |
| isNegative() | Determines whether the numeric value of this length is a negative number |
| isPositive() | Determines whether the numeric value of this length is a positive number |
| isUnitlessNonZero() | The value has unitless type, but is not a zero - positive or negative number |
| toPixel() | Converts the length to a number of pixels, if possible. |
| to(int unit) | Converts the length to the given unit, if possible. |
| toStringSpecified(int unit) | Returns a string representation of this length in specified unit type. |
| serializeDefault() | Returns a string representation of this length in its original native form (as it is stored), without converting length value to some other unit type |
| equals(Length other) | Defines whether this value is equal to the other specified length |
| equals(Object obj) | Determines whether this length is equal to specified object |
| op_Multiply(Length multiplicand, int factor) | Multiplicates the given Length onto the given factor |
| op_Equality(Length left, Length right) | Checks the equality of the two given lengths. |
| op_Inequality(Length left, Length right) | Checks the inequality of the two given lengths. |
| hashCode() | Calculates and returns a hash-code of this Length instance by combining hash-codes of the value and unit type |
| deepClone() | Returns a full copy of this Length instance |
| getUnitFromName(String unitName) | Tries to parse specified unit name and return corresponding value of a Unit enum. |
| tryParse(String input, Length[] result) | Tries to parse a specified string as a Length value, including its numeric value and unit name |
| parse(String input) | Parses and returns specified string as a Length value, including its numeric value and unit name, or throws an exception on failure |
##### Length()
```
public Length()
```

##### UnitlessZero
```
public static final Length UnitlessZero
```

Unitless integer zero - default value, the same as default parameterless constructor

##### OneHundredPercents
```
public static final Length OneHundredPercents
```

100%

##### FiftyPercents
```
public static final Length FiftyPercents
```

50%

##### ZeroPercents
```
public static final Length ZeroPercents
```

0%

##### fromValueWithUnit(float value, int unit)
```
public static Length fromValueWithUnit(float value, int unit)
```

Creates and returns an instance of Length type by specified float number and unit

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | >Any float (FP32) number |
| unit | int | Any valid unit type |

**Returns:**
Length - New instance of Length type
##### fromValueWithUnit(double value, int unit)
```
public static Length fromValueWithUnit(double value, int unit)
```

Creates and returns an instance of Length type by specified double number and unit

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Any double (FP64) number, that will be converted to float (FP32) |
| unit | int | Any valid unit type |

**Returns:**
Length - New instance of Length type
##### fromValueWithUnit(int value, int unit)
```
public static Length fromValueWithUnit(int value, int unit)
```

Creates and returns an instance of Length type by specified integer number and unit

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | Any integer number |
| unit | int | Any valid unit type |

**Returns:**
Length - New instance of Length type
##### isUnitlessZero()
```
public final boolean isUnitlessZero()
```

Determines whether this instance is a unitless zero or not. Unitless zero is default value of this type. Same as IsDefault property.

**Returns:**
boolean
##### isDefault()
```
public final boolean isDefault()
```

Indicates whether this Length instance has a default value \\u2014 unitless zero. Same as IsUnitlessZero property.

**Returns:**
boolean
##### getUnitType()
```
public final int getUnitType()
```

Returns a unit type of this Length instance.

**Returns:**
int
##### isInteger()
```
public final boolean isInteger()
```

Indicates whether the numeric value of this Length instance was originally specified and stored as an integer (INT32) number

**Returns:**
boolean
##### isFloat()
```
public final boolean isFloat()
```

Indicates whether the numeric value of this Length instance was originally specified and stored as a float (FP32) number

**Returns:**
boolean
##### getFloatValue()
```
public final float getFloatValue()
```

Returns a float numeric value of the Length instance. Never throws an exception - converts Integer value to Float if necessary.

**Returns:**
float
##### getIntegerValue()
```
public final int getIntegerValue()
```

Returns an integer numeric value of this Length instance, if it is internally stored as an integer, or throws an exception, if it was originally stored as a float number.

**Returns:**
int
##### isAbsolute()
```
public final boolean isAbsolute()
```

Gets if the length is given in absolute units. Such a length may be converted to pixels.

**Returns:**
boolean
##### isRelative()
```
public final boolean isRelative()
```

Gets if the length is given in relative units. Such a length cannot be converted to pixels.

**Returns:**
boolean
##### isZero()
```
public final boolean isZero()
```

Determines whether the numeric value of this length is a zero number

**Returns:**
boolean
##### isNegative()
```
public final boolean isNegative()
```

Determines whether the numeric value of this length is a negative number

**Returns:**
boolean
##### isPositive()
```
public final boolean isPositive()
```

Determines whether the numeric value of this length is a positive number

**Returns:**
boolean
##### isUnitlessNonZero()
```
public final boolean isUnitlessNonZero()
```

The value has unitless type, but is not a zero - positive or negative number

**Returns:**
boolean
##### toPixel()
```
public final float toPixel()
```

Converts the length to a number of pixels, if possible. If the current unit is relative, then an exception will be thrown.

**Returns:**
float - The number of pixels represented by the current length.
##### to(int unit)
```
public final float to(int unit)
```

Converts the length to the given unit, if possible. If the current or given unit is relative, then an exception will be thrown.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unit | int | The unit to convert to. |

**Returns:**
float - The value in the given unit of the current length.
##### toStringSpecified(int unit)
```
public final String toStringSpecified(int unit)
```

Returns a string representation of this length in specified unit type. Numeric value will be converted in corresponding to unit type change.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unit | int | Specified unit, to which this instance should be converted before serializing to the string. Should be valid. Cannot be unitless. |

**Returns:**
java.lang.String - String representation
##### serializeDefault()
```
public final String serializeDefault()
```

Returns a string representation of this length in its original native form (as it is stored), without converting length value to some other unit type

**Returns:**
java.lang.String - String instance
##### equals(Length other)
```
public final boolean equals(Length other)
```

Defines whether this value is equal to the other specified length

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Length | Other instance of Length type |

**Returns:**
boolean - True if equal, otherwise false
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this length is equal to specified object

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other instance of Length type, that is boxed to the System.Object or any other abstract type or interface |

**Returns:**
boolean - True if equal, otherwise false
##### op_Multiply(Length multiplicand, int factor)
```
public static Length op_Multiply(Length multiplicand, int factor)
```

Multiplicates the given Length onto the given factor

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| multiplicand | Length | Length - multiplicand |
| factor | int | Arbitrary integer - factor |

**Returns:**
Length - A new Length - a product of multiplication
##### op_Equality(Length left, Length right)
```
public static boolean op_Equality(Length left, Length right)
```

Checks the equality of the two given lengths.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Length | The left length operand. |
| right | Length | The right length operand. |

**Returns:**
boolean - True if both lengths are equal, otherwise false.
##### op_Inequality(Length left, Length right)
```
public static boolean op_Inequality(Length left, Length right)
```

Checks the inequality of the two given lengths.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Length | The left length operand. |
| right | Length | The right length operand. |

**Returns:**
boolean - True if both lengths are not equal, otherwise false.
##### hashCode()
```
public int hashCode()
```

Calculates and returns a hash-code of this Length instance by combining hash-codes of the value and unit type

**Returns:**
int - Integer number
##### deepClone()
```
public final Length deepClone()
```

Returns a full copy of this Length instance

**Returns:**
Length - New separate instance of this Length, that is absolutely identical to this one
##### getUnitFromName(String unitName)
```
public static int getUnitFromName(String unitName)
```

Tries to parse specified unit name and return corresponding value of a Unit enum. Returns LengthUnit.Unitless if cannot find appropriate LengthUnit.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unitName | java.lang.String | String, that represents a unit name |

**Returns:**
int - Value of Unit enum in any case, LengthUnit.Unitless when cannot find appropriate unit
##### tryParse(String input, Length[] result)
```
public static boolean tryParse(String input, Length[] result)
```

Tries to parse a specified string as a Length value, including its numeric value and unit name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.lang.String | Input string, that should be parsed |
| result | Length\[\] | Output parameter, that contains a result of parsing. If parsing is unsuccessful, contains a default Length value \\u2014 a unitless zero. |

**Returns:**
boolean - True if parsing is successful, false if unsuccessful
##### parse(String input)
```
public static Length parse(String input)
```

Parses and returns specified string as a Length value, including its numeric value and unit name, or throws an exception on failure

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.lang.String | Input string, that should be parsed |

**Returns:**
Length - Valid parsed Length instance

### LengthUnit
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes/lengthunit.md

**Inheritance:**
java.lang.Object
```
public class LengthUnit
```

All supported length units

[https://developer.mozilla.org/en-US/docs/Web/CSS/length\#Units][https_developer.mozilla.org_en-US_docs_Web_CSS_length_Units]

[https_developer.mozilla.org_en-US_docs_Web_CSS_length_Units]: https://developer.mozilla.org/en-US/docs/Web/CSS/length#Units
#### Fields

| Field | Description |
| --- | --- |
| Unitless | Unitless - no defined length unit. |
| Px | Pixel. |
| Em | Em. |
| Ex | Ex (x-length). |
| Cm | Cm. |
| Mm | Mm. |
| In | In. |
| Pt | Pt. |
| Pc | Pc. |
| Ch | Ch. |
| Rem | Rem. |
| Vw | Vw - viewport width. |
| Vh | Vh - viewport height. |
| Vmin | Vmin. |
| Vmax | Vmax. |
| Percent | The value is relative to a fixed (external) value, that is context dependent. |
#### Methods

| Method | Description |
| --- | --- |
| getUnit() |  |
| getUnits() |  |
##### Unitless
```
public static final int Unitless
```

Unitless - no defined length unit. Default value.

##### Px
```
public static final int Px
```

Pixel. Relative to the viewing device. For screen display, typically one device pixel (dot) of the display.

##### Em
```
public static final int Em
```

Em. This unit represents the calculated font-size of the element.

##### Ex
```
public static final int Ex
```

Ex (x-length). This unit represents the x-height of the element's font. On fonts with the 'x' letter, this is generally the height of lowercase letters in the font; 1ex \\u2248 0.5em in many fonts.

##### Cm
```
public static final int Cm
```

Cm. One centimeter (10 millimeters).

##### Mm
```
public static final int Mm
```

Mm. One millimeter.

##### In
```
public static final int In
```

In. One inch (2.54 centimeters).

##### Pt
```
public static final int Pt
```

Pt. One point is 1/72th of an inch or 0.353 mm.

##### Pc
```
public static final int Pc
```

Pc. One pica (12 points).

##### Ch
```
public static final int Ch
```

Ch. This unit represents the width, or more precisely the advance measure, of the glyph '0' (zero, the Unicode character U+0030) in the element's font.

##### Rem
```
public static final int Rem
```

Rem. This unit represents the font-size of the root element (e.g. the font-size of the <html> element). When used on the font-size on this root element, it represents its initial value.

##### Vw
```
public static final int Vw
```

Vw - viewport width. 1/100th of the width of the viewport.

##### Vh
```
public static final int Vh
```

Vh - viewport height. 1/100th of the height of the viewport.

##### Vmin
```
public static final int Vmin
```

Vmin. 1/100th of the minimum value between the height and the width of the viewport.

##### Vmax
```
public static final int Vmax
```

Vmax. 1/100th of the maximum value between the height and the width of the viewport.

##### Percent
```
public static final int Percent
```

The value is relative to a fixed (external) value, that is context dependent. 1% = 1/100 of the external value.

##### getUnit()
```
public static Integer[] getUnit()
```

**Returns:**
java.lang.Integer[]
##### getUnits()
```
public static Map<Integer,String> getUnits()
```

**Returns:**
java.util.Map<java.lang.Integer,java.lang.String>

### Ratio
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.datatypes/ratio.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType
```
public class Ratio implements ICssDataType
```

Represents a "ratio" CSS data type, which is used for describing aspect ratios in media queries and for raster images by denoting the proportion between two unitless values called "numerator" and "denominator". Immutable struct.

https://developer.mozilla.org/en-US/docs/Web/CSS/ratio
#### Constructors

| Constructor | Description |
| --- | --- |
| Ratio() |  |
#### Fields

| Field | Description |
| --- | --- |
| Single | Single default ratio 1/1 |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Returns a numerator of this ratio |
| getDenominator() | Returns a denominator of this ratio |
| calculate() | Calculates and returns this ratio as a single floating point number |
| getInverseRatio() | Generates and returns an inverse (reciprocal) ratio for this ratio |
| serializeDefault() | Serializes this ratio to the string and returns it |
| toString() | Returns a string representation of this ratio; same as "SerializeDefault()" |
| isDefault() | Determines whether this ratio has default value or is a "1/1" (Single) |
| deepClone() | Returns a full copy of this ratio |
| equals(Ratio other) | Determines whether this instance is equal with specified "Ratio" instance |
| equals(Object other) | Determines whether this instance is equal with specified uncasted object, which presumably is another "Ratio" instance |
| op_Equality(Ratio left, Ratio right) | Compares two ratios and returns a boolean indicating if the two do match. |
| op_Inequality(Ratio left, Ratio right) | Compares two ratios and returns a boolean indicating if the two do not match. |
| hashCode() | Returns a hashcode for this instance, which cannot be changed during its lifetime |
| create(int numerator, int denominator) | Creates and returns one Ratio instance from specified numerator and denominator |
##### Ratio()
```
public Ratio()
```

##### Single
```
public static final Ratio Single
```

Single default ratio 1/1

##### getNumerator()
```
public final int getNumerator()
```

Returns a numerator of this ratio

**Returns:**
int
##### getDenominator()
```
public final int getDenominator()
```

Returns a denominator of this ratio

**Returns:**
int
##### calculate()
```
public final double calculate()
```

Calculates and returns this ratio as a single floating point number

**Returns:**
double - Floating-point number with double precision
##### getInverseRatio()
```
public final Ratio getInverseRatio()
```

Generates and returns an inverse (reciprocal) ratio for this ratio

**Returns:**
Ratio - New Ratio instance, that is an inverse ratio for this one
##### serializeDefault()
```
public final String serializeDefault()
```

Serializes this ratio to the string and returns it

**Returns:**
java.lang.String - String in "numerator/denominator" format
##### toString()
```
public String toString()
```

Returns a string representation of this ratio; same as "SerializeDefault()"

**Returns:**
java.lang.String - String in "numerator/denominator" format
##### isDefault()
```
public final boolean isDefault()
```

Determines whether this ratio has default value or is a "1/1" (Single)

**Returns:**
boolean
##### deepClone()
```
public final Ratio deepClone()
```

Returns a full copy of this ratio

**Returns:**
Ratio - New Ratio instance, that is a full and deep copy of this one
##### equals(Ratio other)
```
public final boolean equals(Ratio other)
```

Determines whether this instance is equal with specified "Ratio" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Ratio | Other Ratio instance to check on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal
##### equals(Object other)
```
public boolean equals(Object other)
```

Determines whether this instance is equal with specified uncasted object, which presumably is another "Ratio" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | Other System.Object instance, that is presumably of Ratio type, to check on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Equality(Ratio left, Ratio right)
```
public static boolean op_Equality(Ratio left, Ratio right)
```

Compares two ratios and returns a boolean indicating if the two do match.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Ratio | The first ratio to use. |
| right | Ratio | The second ratio to use. |

**Returns:**
boolean - True if both ratios are equal, otherwise false.
##### op_Inequality(Ratio left, Ratio right)
```
public static boolean op_Inequality(Ratio left, Ratio right)
```

Compares two ratios and returns a boolean indicating if the two do not match.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | Ratio | The first ratio to use. |
| right | Ratio | The second ratio to use. |

**Returns:**
boolean - True if both ratios are not equal, otherwise false.
##### hashCode()
```
public int hashCode()
```

Returns a hashcode for this instance, which cannot be changed during its lifetime

**Returns:**
int - Signed 4-byte integer, that is immutable for this instance
##### create(int numerator, int denominator)
```
public static Ratio create(int numerator, int denominator)
```

Creates and returns one Ratio instance from specified numerator and denominator

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | int | Numerator for the ratio. Should be a strictly positive integer number. |
| denominator | int | Denominator for the ratio. Should be a strictly positive integer number. |

**Returns:**
Ratio - New Ratio instance

### com.groupdocs.editor.htmlcss.css.properties
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.properties.md

#### Classes

| Class | Description |
| --- | --- |
| FontSize | Represents a font size as a special unit or a length value, which specifies the size of the font (historically the width of the capital "M"). |
| FontStyle | Defines how the font should be styled with: a normal, italic, or oblique face from its font-family. |
| FontWeight | Font-weight property sets the weight (or boldness) of the font. |
| TextDecorationLineType | Represents types of the text decoration line: underline (underscore), overline, and line-through (strikethrough) |

### FontSize
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.properties/fontsize.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.properties.ICssProperty
```
public class FontSize implements ICssProperty
```

Represents a font size as a special unit or a length value, which specifies the size of the font (historically the width of the capital "M").
#### Constructors

| Constructor | Description |
| --- | --- |
| FontSize() |  |
#### Fields

| Field | Description |
| --- | --- |
| Medium | Medium size. |
| XxSmall | The very small absolute-size |
| XSmall | The mediocre small absolute-size |
| Small | The normally small absolute-size |
| Large | The normally large absolute-size |
| XLarge | The mediocre large absolute-size |
| XxLarge | The very large absolute-size |
| Larger | Larger relative-size - font will be larger relative to the parent element's font-size, roughly by the ratio used to separate the absolute-size keywords above. |
| Smaller | Smaller relative-size - font will be smaller relative to the parent element's font-size, roughly by the ratio used to separate the absolute-size keywords above. |
#### Methods

| Method | Description |
| --- | --- |
| isInitial() | Indicates whether this font-size has an initial value (Medium) |
| getValue() | Returns a value of this font size as a string |
| isLengthDefined() | Indicates whether this font-size is defined with a Length value |
| getLength() | A length value, if this font-size was defined with it, or throwed exception otherwise |
| isAbsoluteSize() | Indicates whether this font-size is defined with an absolute size as a keyword, based on the user's default font size (which is medium) |
| isRelativeSize() | Indicates whether this font-size is defined with an relative size as a keyword. |
| equals(FontSize other) | Determines whether this font-size instance is equal to specified |
| equals(Object obj) | Determines whether this font-size instance is equal to specified uncasted |
| hashCode() | Returns a hash-code for this instance |
| op_Equality(FontSize first, FontSize second) | Checks whether two "FontSize" values are equal |
| op_Inequality(FontSize first, FontSize second) | Checks whether two "FontSize" values are not equal |
| fromLength(Length length) | Creates a font-size from specified length |
| tryParse(String keyword, FontSize[] result) | Tries to recognize a specified keyword as a proper keyword value of the 'font-size' and return it on success or NULL on failure. |
##### FontSize()
```
public FontSize()
```

##### Medium
```
public static final FontSize Medium
```

Medium size. Initial value.

##### XxSmall
```
public static final FontSize XxSmall
```

The very small absolute-size

##### XSmall
```
public static final FontSize XSmall
```

The mediocre small absolute-size

##### Small
```
public static final FontSize Small
```

The normally small absolute-size

##### Large
```
public static final FontSize Large
```

The normally large absolute-size

##### XLarge
```
public static final FontSize XLarge
```

The mediocre large absolute-size

##### XxLarge
```
public static final FontSize XxLarge
```

The very large absolute-size

##### Larger
```
public static final FontSize Larger
```

Larger relative-size - font will be larger relative to the parent element's font-size, roughly by the ratio used to separate the absolute-size keywords above.

##### Smaller
```
public static final FontSize Smaller
```

Smaller relative-size - font will be smaller relative to the parent element's font-size, roughly by the ratio used to separate the absolute-size keywords above.

##### isInitial()
```
public final boolean isInitial()
```

Indicates whether this font-size has an initial value (Medium)

**Returns:**
boolean
##### getValue()
```
public final String getValue()
```

Returns a value of this font size as a string

**Returns:**
java.lang.String
##### isLengthDefined()
```
public final boolean isLengthDefined()
```

Indicates whether this font-size is defined with a Length value

**Returns:**
boolean
##### getLength()
```
public final Length getLength()
```

A length value, if this font-size was defined with it, or throwed exception otherwise

**Returns:**
Length
##### isAbsoluteSize()
```
public final boolean isAbsoluteSize()
```

Indicates whether this font-size is defined with an absolute size as a keyword, based on the user's default font size (which is medium)

**Returns:**
boolean
##### isRelativeSize()
```
public final boolean isRelativeSize()
```

Indicates whether this font-size is defined with an relative size as a keyword. The font will be larger or smaller relative to the parent element's font size, roughly by the ratio used to separate the absolute-size keywords.

**Returns:**
boolean
##### equals(FontSize other)
```
public final boolean equals(FontSize other)
```

Determines whether this font-size instance is equal to specified

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FontSize | Other font-size instance |

**Returns:**
boolean - true if are equal, false otherwise
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this font-size instance is equal to specified uncasted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other uncasted font-size instance, may be null |

**Returns:**
boolean - true if are equal, false if not equal, null or of other type
##### hashCode()
```
public int hashCode()
```

Returns a hash-code for this instance

**Returns:**
int - Hash-code as an signed integer
##### op_Equality(FontSize first, FontSize second)
```
public static boolean op_Equality(FontSize first, FontSize second)
```

Checks whether two "FontSize" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontSize | First value to check |
| second | FontSize | Second value to check |

**Returns:**
boolean - true if are equal, false otherwise
##### op_Inequality(FontSize first, FontSize second)
```
public static boolean op_Inequality(FontSize first, FontSize second)
```

Checks whether two "FontSize" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontSize | First value to check |
| second | FontSize | Second value to check |

**Returns:**
boolean - false if are equal, true otherwise
##### fromLength(Length length)
```
public static FontSize fromLength(Length length)
```

Creates a font-size from specified length

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| length | Length | A length value, cannot be unitless or negative |

**Returns:**
FontSize - New FontSize instance
##### tryParse(String keyword, FontSize[] result)
```
public static boolean tryParse(String keyword, FontSize[] result)
```

Tries to recognize a specified keyword as a proper keyword value of the 'font-size' and return it on success or NULL on failure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keyword | java.lang.String | A keyword to parse |
| result | FontSize\[\] | Result, of parsing was successful, or \#Medium.Medium otherwise |

**Returns:**
boolean - true if parsing was successful, false otherwise

### FontStyle
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.properties/fontstyle.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.properties.ICssProperty
```
public class FontStyle implements ICssProperty
```

Defines how the font should be styled with: a normal, italic, or oblique face from its font-family.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontStyle() |  |
#### Fields

| Field | Description |
| --- | --- |
| Normal | Selects a font that is classified as normal within a font-family. |
| Italic | Selects a font that is classified as italic. |
| Oblique | Selects a font that is classified as oblique. |
#### Methods

| Method | Description |
| --- | --- |
| isInitial() | Indicates whether this font-style has an initial value (Normal) |
| getValue() | Returns a value of this font style as a string |
| equals(FontStyle other) | Determines whether this font-style instance is equal to specified |
| equals(Object obj) | Determines whether this font-style instance is equal to specified uncasted |
| hashCode() | Returns a hash-code for this instance |
| op_Equality(FontStyle first, FontStyle second) | Checks whether two "FontStyle" values are equal |
| op_Inequality(FontStyle first, FontStyle second) | Checks whether two "FontStyle" values are not equal |
| tryParse(String keyword, FontStyle[] result) | Tries to recognize a specified keyword as a proper keyword value of the 'font-style' and return it on success or NULL on failure. |
##### FontStyle()
```
public FontStyle()
```

##### Normal
```
public static final FontStyle Normal
```

Selects a font that is classified as normal within a font-family. Initial value.

##### Italic
```
public static final FontStyle Italic
```

Selects a font that is classified as italic. If no italic version of the face is available, one classified as oblique is used instead. If neither is available, the style is artificially simulated.

##### Oblique
```
public static final FontStyle Oblique
```

Selects a font that is classified as oblique. If no oblique version of the face is available, one classified as italic is used instead. If neither is available, the style is artificially simulated.

##### isInitial()
```
public final boolean isInitial()
```

Indicates whether this font-style has an initial value (Normal)

**Returns:**
boolean
##### getValue()
```
public final String getValue()
```

Returns a value of this font style as a string

**Returns:**
java.lang.String
##### equals(FontStyle other)
```
public final boolean equals(FontStyle other)
```

Determines whether this font-style instance is equal to specified

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FontStyle | Other font-style instance |

**Returns:**
boolean - true if are equal, false otherwise
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this font-style instance is equal to specified uncasted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other uncasted font-style instance, may be null |

**Returns:**
boolean - true if are equal, false if not equal, null or of other type
##### hashCode()
```
public int hashCode()
```

Returns a hash-code for this instance

**Returns:**
int - Hash-code as an signed integer
##### op_Equality(FontStyle first, FontStyle second)
```
public static boolean op_Equality(FontStyle first, FontStyle second)
```

Checks whether two "FontStyle" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyle | First value to check |
| second | FontStyle | Second value to check |

**Returns:**
boolean - true if are equal, false otherwise
##### op_Inequality(FontStyle first, FontStyle second)
```
public static boolean op_Inequality(FontStyle first, FontStyle second)
```

Checks whether two "FontStyle" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyle | First value to check |
| second | FontStyle | Second value to check |

**Returns:**
boolean - false if are equal, true otherwise
##### tryParse(String keyword, FontStyle[] result)
```
public static boolean tryParse(String keyword, FontStyle[] result)
```

Tries to recognize a specified keyword as a proper keyword value of the 'font-style' and return it on success or NULL on failure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keyword | java.lang.String | A keyword to parse |
| result | FontStyle\[\] | Result, of parsing was successful, or \#Normal.Normal otherwise |

**Returns:**
boolean - true if parsing was successful, false otherwise

### FontWeight
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.properties/fontweight.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.properties.ICssProperty
```
public class FontWeight implements ICssProperty
```

Font-weight property sets the weight (or boldness) of the font. The weights available depend on the font-family that is currently set.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontWeight() |  |
#### Fields

| Field | Description |
| --- | --- |
| Lighter | One relative font weight lighter than the parent element |
| Bolder | One relative font weight heavier than the parent element |
| Normal | Normal font weight. |
| Bold | Bold font weight. |
#### Methods

| Method | Description |
| --- | --- |
| isInitial() | Indicates whether this font-size has an initial value (Medium) |
| getNumber() | Returns a number - integer value between 1 and 1000, inclusive, which describes the boldness of the font, or throws an exception, if current boldness is not absolute, but relative |
| isAbsolute() | Indicates whether this font-weight instance stores an absolute value of the weight (boldness) of the font, as an integer number |
| isRelative() | Indicates whether this font-weight instance stores a relative value of the weight (boldness) of the font - compared to the boldness of the parent element |
| getValue() | Returns a value of this font-weight as a string |
| equals(FontWeight other) | Determines whether specified FontWeight instances are equal |
| equals(Object obj) | Determines whether this FontWeight instance is equal to specified uncasted |
| hashCode() | Returns a hash-code for this instance |
| op_Equality(FontWeight first, FontWeight second) | Checks whether two "FontWeight" values are equal |
| op_Inequality(FontWeight first, FontWeight second) | Checks whether two "FontWeight" values are not equal |
| fromNumber(int number) | Creates a font-weight from specified number |
| tryParse(String input, FontWeight[] result) | Tries to parse a specified string and return a valid FontWeight instance on success |
##### FontWeight()
```
public FontWeight()
```

##### Lighter
```
public static final FontWeight Lighter
```

One relative font weight lighter than the parent element

##### Bolder
```
public static final FontWeight Bolder
```

One relative font weight heavier than the parent element

##### Normal
```
public static final FontWeight Normal
```

Normal font weight. Same as 400.

##### Bold
```
public static final FontWeight Bold
```

Bold font weight. Same as 700.

##### isInitial()
```
public final boolean isInitial()
```

Indicates whether this font-size has an initial value (Medium)

**Returns:**
boolean
##### getNumber()
```
public final int getNumber()
```

Returns a number - integer value between 1 and 1000, inclusive, which describes the boldness of the font, or throws an exception, if current boldness is not absolute, but relative

**Returns:**
int
##### isAbsolute()
```
public final boolean isAbsolute()
```

Indicates whether this font-weight instance stores an absolute value of the weight (boldness) of the font, as an integer number

**Returns:**
boolean
##### isRelative()
```
public final boolean isRelative()
```

Indicates whether this font-weight instance stores a relative value of the weight (boldness) of the font - compared to the boldness of the parent element

**Returns:**
boolean
##### getValue()
```
public final String getValue()
```

Returns a value of this font-weight as a string

**Returns:**
java.lang.String
##### equals(FontWeight other)
```
public final boolean equals(FontWeight other)
```

Determines whether specified FontWeight instances are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FontWeight | Other FontWeight instance to check the equality |

**Returns:**
boolean - true if are equal, false if are unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this FontWeight instance is equal to specified uncasted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other uncasted FontWeight instance, may be null |

**Returns:**
boolean - true if are equal, false if not equal, null or of other type
##### hashCode()
```
public int hashCode()
```

Returns a hash-code for this instance

**Returns:**
int - Hash-code as an signed integer
##### op_Equality(FontWeight first, FontWeight second)
```
public static boolean op_Equality(FontWeight first, FontWeight second)
```

Checks whether two "FontWeight" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontWeight | First value to check |
| second | FontWeight | Second value to check |

**Returns:**
boolean - true if are equal, false otherwise
##### op_Inequality(FontWeight first, FontWeight second)
```
public static boolean op_Inequality(FontWeight first, FontWeight second)
```

Checks whether two "FontWeight" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontWeight | First value to check |
| second | FontWeight | Second value to check |

**Returns:**
boolean - false if are equal, true otherwise
##### fromNumber(int number)
```
public static FontWeight fromNumber(int number)
```

Creates a font-weight from specified number

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | Unsigned integer, must be within [1..1000] range |

**Returns:**
FontWeight - New FontWeight instance or exception
##### tryParse(String input, FontWeight[] result)
```
public static boolean tryParse(String input, FontWeight[] result)
```

Tries to parse a specified string and return a valid FontWeight instance on success

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.lang.String | Input string to parse |
| result | FontWeight\[\] | Valid FontWeight value on success or \#Normal.Normal on failure |

**Returns:**
boolean - Success (true) or failure (false) of the parsing

### TextDecorationLineType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.css.properties/textdecorationlinetype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.css.properties.ICssProperty
```
public class TextDecorationLineType implements ICssProperty
```

Represents types of the text decoration line: underline (underscore), overline, and line-through (strikethrough)

Immutable struct. Similar to the https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-line
#### Constructors

| Constructor | Description |
| --- | --- |
| TextDecorationLineType() |  |
| TextDecorationLineType(int value) |  |
#### Fields

| Field | Description |
| --- | --- |
| None | Produces no text decoration. |
| Underline | Each line of text is underlined. |
| Overline | Each line of text has a line above it. |
| LineThrough | Each line of text has a line through the middle. |
#### Methods

| Method | Description |
| --- | --- |
| isInitial() | Indicates whether this instance has an initial value \\u2014 None |
| isUnderline() | Indicates whether underline (underscore) is enabled |
| isOverline() | Indicates whether overline is enabled |
| isLineThrough() | Indicates whether line-through (strikethrough) is enabled |
| getValue() | Returns a value of all flags in this instance as text |
| toString() | Returns a value of all flags in this instance as text |
| equals(TextDecorationLineType other) | Indicates whether this TextDecorationLineType instance is equal to specified |
| equals(Object other) | Indicates whether this TextDecorationLineType instance is equal to specified uncasted |
| hashCode() | Returns a hash-code of this instance |
| op_Equality(TextDecorationLineType first, TextDecorationLineType second) | Checks whether two "TextDecorationLineType" values are equal |
| op_Inequality(TextDecorationLineType first, TextDecorationLineType second) | Checks whether two "TextDecorationLineType" values are not equal |
| fromFlags(boolean isUnderline, boolean isOverline, boolean isLineThrough) | Creates and returns a TextDecorationLineType instance with flags, defined by the specified parameters |
| tryParse(String input, TextDecorationLineType[] output) | Tries to parse a specified string and return a valid TextDecorationLineType instance |
| op_Addition(TextDecorationLineType first, TextDecorationLineType second) | Combines (merges) two specified line types and produces new resultant line type, where flags are merged (union) |
| op_Subtraction(TextDecorationLineType first, TextDecorationLineType second) | Subtracts second specified line type from the first specified line type and produces new resultant line type, where are present only those flags from the first operand, which are not found in the second operand (difference) |
| op_Division(TextDecorationLineType first, TextDecorationLineType second) | Returns an intersection between first and second line types, where only those flags are enabled, which are enabled simultaneously in both operands. |
| to_TextDecorationLineType(byte octet) | Casts specific byte (8-bit octet) to the corresponding TextDecorationLineType, throws exception if casting is invalid |
##### TextDecorationLineType()
```
public TextDecorationLineType()
```

##### TextDecorationLineType(int value)
```
public TextDecorationLineType(int value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### None
```
public static final TextDecorationLineType None
```

Produces no text decoration. Initial value.

##### Underline
```
public static final TextDecorationLineType Underline
```

Each line of text is underlined.

##### Overline
```
public static final TextDecorationLineType Overline
```

Each line of text has a line above it.

##### LineThrough
```
public static final TextDecorationLineType LineThrough
```

Each line of text has a line through the middle.

##### isInitial()
```
public final boolean isInitial()
```

Indicates whether this instance has an initial value \\u2014 None

**Returns:**
boolean
##### isUnderline()
```
public final boolean isUnderline()
```

Indicates whether underline (underscore) is enabled

**Returns:**
boolean
##### isOverline()
```
public final boolean isOverline()
```

Indicates whether overline is enabled

**Returns:**
boolean
##### isLineThrough()
```
public final boolean isLineThrough()
```

Indicates whether line-through (strikethrough) is enabled

**Returns:**
boolean
##### getValue()
```
public final String getValue()
```

Returns a value of all flags in this instance as text

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Returns a value of all flags in this instance as text

**Returns:**
java.lang.String
##### equals(TextDecorationLineType other)
```
public final boolean equals(TextDecorationLineType other)
```

Indicates whether this TextDecorationLineType instance is equal to specified

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TextDecorationLineType | Other TextDecorationLineType instance |

**Returns:**
boolean -  true  if are equal,  false  otherwise
##### equals(Object other)
```
public boolean equals(Object other)
```

Indicates whether this TextDecorationLineType instance is equal to specified uncasted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | Other TextDecorationLineType instance, casted to object |

**Returns:**
boolean -  true  if are equal,  false  otherwise
##### hashCode()
```
public int hashCode()
```

Returns a hash-code of this instance

**Returns:**
int - Signed integer hash-code
##### op_Equality(TextDecorationLineType first, TextDecorationLineType second)
```
public static boolean op_Equality(TextDecorationLineType first, TextDecorationLineType second)
```

Checks whether two "TextDecorationLineType" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First operand to check |
| second | TextDecorationLineType | Second operand to check |

**Returns:**
boolean -  true  if are equal,  false  otherwise
##### op_Inequality(TextDecorationLineType first, TextDecorationLineType second)
```
public static boolean op_Inequality(TextDecorationLineType first, TextDecorationLineType second)
```

Checks whether two "TextDecorationLineType" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First operand to check |
| second | TextDecorationLineType | Second operand to check |

**Returns:**
boolean -  true  if are unequal,  false  otherwise
##### fromFlags(boolean isUnderline, boolean isOverline, boolean isLineThrough)
```
public static TextDecorationLineType fromFlags(boolean isUnderline, boolean isOverline, boolean isLineThrough)
```

Creates and returns a TextDecorationLineType instance with flags, defined by the specified parameters

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isUnderline | boolean | Determines whether an underline flag is enabled or not |
| isOverline | boolean | Determines whether an overline flag is enabled or not |
| isLineThrough | boolean | Determines whether an line-through flag is enabled or not |

**Returns:**
TextDecorationLineType - New TextDecorationLineType instance
##### tryParse(String input, TextDecorationLineType[] output)
```
public static boolean tryParse(String input, TextDecorationLineType[] output)
```

Tries to parse a specified string and return a valid TextDecorationLineType instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.lang.String | Input string |
| output | TextDecorationLineType\[\] | Result. If parsing is invalid, it is a \#None.None value |

**Returns:**
boolean -  true  if parsing was successful,  false  on failure
##### op_Addition(TextDecorationLineType first, TextDecorationLineType second)
```
public static TextDecorationLineType op_Addition(TextDecorationLineType first, TextDecorationLineType second)
```

Combines (merges) two specified line types and produces new resultant line type, where flags are merged (union)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First line type operand |
| second | TextDecorationLineType | Second line type operand |

**Returns:**
TextDecorationLineType - Result of the union between specified operands
##### op_Subtraction(TextDecorationLineType first, TextDecorationLineType second)
```
public static TextDecorationLineType op_Subtraction(TextDecorationLineType first, TextDecorationLineType second)
```

Subtracts second specified line type from the first specified line type and produces new resultant line type, where are present only those flags from the first operand, which are not found in the second operand (difference)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First line type operand |
| second | TextDecorationLineType | Second line type operand |

**Returns:**
TextDecorationLineType - Result of the difference between the first (minuend) and second (subtrahend) operands
##### op_Division(TextDecorationLineType first, TextDecorationLineType second)
```
public static TextDecorationLineType op_Division(TextDecorationLineType first, TextDecorationLineType second)
```

Returns an intersection between first and second line types, where only those flags are enabled, which are enabled simultaneously in both operands. Has the highest priority between all operators (higher than union and difference)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First line type operand |
| second | TextDecorationLineType | Second line type operand |

**Returns:**
TextDecorationLineType - Result of the intersection between specified operands
##### to_TextDecorationLineType(byte octet)
```
public static TextDecorationLineType to_TextDecorationLineType(byte octet)
```

Casts specific byte (8-bit octet) to the corresponding TextDecorationLineType, throws exception if casting is invalid

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| octet | byte | A 8-bit octet (bitfield), where 5 leading bits are zeros, while last 3 indicate flags |

**Returns:**
TextDecorationLineType

### com.groupdocs.editor.htmlcss.exceptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.exceptions.md

The **com.groupdocs.editor.htmlcss.exceptions** namespace provides exceptions that is thrown when trying to open, load, save or process somehow else some content.

#### Classes

| Class | Description |
| --- | --- |
| InvalidFontFormatException | The exception that is thrown when trying to open, load, save or process somehow else some content, that presumably is a font of supported (known) format, but actually is a font of unsupported or unexpected format or not a font at all. |
| InvalidImageFormatException | The exception that is thrown when trying to open, load, save or process somehow else some content, that presumably is an image (raster or vector), but actually is an image of unexpected type or not an image at all. |

### InvalidFontFormatException
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.exceptions/invalidfontformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public class InvalidFontFormatException extends RuntimeException
```

The exception that is thrown when trying to open, load, save or process somehow else some content, that presumably is a font of supported (known) format, but actually is a font of unsupported or unexpected format or not a font at all.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidFontFormatException(String message) | Creates new instance of  with specified error message |
| InvalidFontFormatException(String message, RuntimeException innerException) | Creates new instance of @see "InvalidFontFormatException" with specified error message and a reference to the inner exception that is the cause of this exception |
##### InvalidFontFormatException(String message)
```
public InvalidFontFormatException(String message)
```

Creates new instance of  with specified error message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Textual message, that describes the error, can be null or empty |

##### InvalidFontFormatException(String message, RuntimeException innerException)
```
public InvalidFontFormatException(String message, RuntimeException innerException)
```

Creates new instance of @see "InvalidFontFormatException" with specified error message and a reference to the inner exception that is the cause of this exception

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Textual message, that describes the error, can be null or empty |
| innerException | java.lang.RuntimeException | The exception that is the cause of the current exception, or a null reference if no inner exception is specified. |

### InvalidImageFormatException
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.exceptions/invalidimageformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public class InvalidImageFormatException extends RuntimeException
```

The exception that is thrown when trying to open, load, save or process somehow else some content, that presumably is an image (raster or vector), but actually is an image of unexpected type or not an image at all.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidImageFormatException(String message) | Creates new instance of InvalidImageFormatException with specified error message |
| InvalidImageFormatException(String message, RuntimeException innerException) | Creates new instance of InvalidImageFormatException with specified error message and a reference to the inner exception that is the cause of this exception |
##### InvalidImageFormatException(String message)
```
public InvalidImageFormatException(String message)
```

Creates new instance of InvalidImageFormatException with specified error message

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Textual message, that describes the error, can be null or empty |

##### InvalidImageFormatException(String message, RuntimeException innerException)
```
public InvalidImageFormatException(String message, RuntimeException innerException)
```

Creates new instance of InvalidImageFormatException with specified error message and a reference to the inner exception that is the cause of this exception

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Textual message, that describes the error, can be null or empty |
| innerException | java.lang.RuntimeException | The exception that is the cause of the current exception, or a null reference if no inner exception is specified. |

### com.groupdocs.editor.htmlcss.resources.audio
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.audio.md

The **com.groupdocs.editor.htmlcss.resources.audio** namespace provides classes that represent audio resources.

#### Classes

| Class | Description |
| --- | --- |
| AudioType | Represents one supportable audio type (format) |
| Mp3Audio | Represents one audio resource of arbitrary format |

### AudioType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.audio/audiotype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IResourceType
```
public class AudioType implements IResourceType
```

Represents one supportable audio type (format)
#### Constructors

| Constructor | Description |
| --- | --- |
| AudioType() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormalName() | Formal name of this audio format |
| getFileExtension() | Filename extension (without dot character) for this audio format |
| getMimeCode() | MIME code for this audio format |
| equals(AudioType other) | Determines whether this instance is equal with specified "AudioType" instance |
| equals(Object obj) | Determines whether this instance is equal with specified uncasted object, which presumably is another "AudioType" instance |
| op_Equality(AudioType first, AudioType second) | Checks whether two "AudioType" values are equal |
| op_Inequality(AudioType first, AudioType second) | Checks whether two "AudioType" values are not equal |
| hashCode() | Returns a hash-code, which is a constant number for this specific value type |
| getUndefined() | Special value, which marks undefined, unknown or unsupported audio format |
| getMp3() | Represents a MPEG-1 Audio Layer III audio format |
| parseFromFilenameWithExtension(String filename) | Returns AudioType value, which is equivalent of filename extension, which is extracted from specified filename |
##### AudioType()
```
public AudioType()
```

##### getFormalName()
```
public final String getFormalName()
```

Formal name of this audio format

**Returns:**
java.lang.String
##### getFileExtension()
```
public final String getFileExtension()
```

Filename extension (without dot character) for this audio format

**Returns:**
java.lang.String
##### getMimeCode()
```
public final String getMimeCode()
```

MIME code for this audio format

**Returns:**
java.lang.String
##### equals(AudioType other)
```
public final boolean equals(AudioType other)
```

Determines whether this instance is equal with specified "AudioType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | AudioType | Other AudioType instance to check with this |

**Returns:**
boolean - True if are equal, false if are unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this instance is equal with specified uncasted object, which presumably is another "AudioType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other instance presumably of AudioType struct, that was boxed to System.Object |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Equality(AudioType first, AudioType second)
```
public static boolean op_Equality(AudioType first, AudioType second)
```

Checks whether two "AudioType" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | AudioType | First AudioType to check |
| second | AudioType | Second AudioType to check |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Inequality(AudioType first, AudioType second)
```
public static boolean op_Inequality(AudioType first, AudioType second)
```

Checks whether two "AudioType" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | AudioType | First AudioType to check |
| second | AudioType | Second AudioType to check |

**Returns:**
boolean - True if are equal, false if are unequal
##### hashCode()
```
public int hashCode()
```

Returns a hash-code, which is a constant number for this specific value type

**Returns:**
int - 4-byte signed integer, 0 for Undefined value
##### getUndefined()
```
public static AudioType getUndefined()
```

Special value, which marks undefined, unknown or unsupported audio format

**Returns:**
AudioType
##### getMp3()
```
public static AudioType getMp3()
```

Represents a MPEG-1 Audio Layer III audio format

**Returns:**
AudioType
##### parseFromFilenameWithExtension(String filename)
```
public static AudioType parseFromFilenameWithExtension(String filename)
```

Returns AudioType value, which is equivalent of filename extension, which is extracted from specified filename

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filename | java.lang.String | Arbitrary filename, can be a relative or full path |

**Returns:**
AudioType - AudioType value. Returns AudioType.Undefined, if extension cannot be recognized.

### Mp3Audio
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.audio/mp3audio.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IHtmlResource
```
public final class Mp3Audio implements IHtmlResource
```

Represents one audio resource of arbitrary format
#### Constructors

| Constructor | Description |
| --- | --- |
| Mp3Audio(String name, InputStream binaryContent) | Creates new Mp3Audio class from MP3 content, represented as byte stream, and with specified name |
#### Fields

| Field | Description |
| --- | --- |
| Disposed |  |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid MP3 content |
| getName() | Returns name of this MP3 content. |
| getFilenameWithExtension() | Returns correct filename of this MP3 content, which consists of name and extension. |
| getType() | Returns a AudioType.Mp3 |
| getByteContent() | Returns content of this font as byte stream |
| getTextContent() | Returns content of this MP3 resource as base64-encoded string. |
| save(String fullPathToFile) | Saves this MP3 resource to the specified file |
| equals(IHtmlResource other) | Checks this instance with specified HTML resource on reference equality |
| equals(Mp3Audio other) | Checks this instance with specified font resource on reference equality |
| dispose() | Disposes this MP3 resource, disposing its content and making most methods and properties non-working |
| isDisposed() | Determines whether this MP3 content is disposed or not |
##### Mp3Audio(String name, InputStream binaryContent)
```
public Mp3Audio(String name, InputStream binaryContent)
```

Creates new Mp3Audio class from MP3 content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the MP3 content. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### Disposed
```
public final Event<EventHandler> Disposed
```

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid MP3 content

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a MP3 content |

**Returns:**
boolean - True if specified stream contains valid MP3 content, false otherwise
##### getName()
```
public final String getName()
```

Returns name of this MP3 content. Usually doesn't contain filename extension and theoretically can differ from filename.

**Returns:**
java.lang.String
##### getFilenameWithExtension()
```
public final String getFilenameWithExtension()
```

Returns correct filename of this MP3 content, which consists of name and extension. Theoretically can differ from the name.

**Returns:**
java.lang.String
##### getType()
```
public final AudioType getType()
```

Returns a AudioType.Mp3

**Returns:**
AudioType
##### getByteContent()
```
public final InputStream getByteContent()
```

Returns content of this font as byte stream

**Returns:**
java.io.InputStream
##### getTextContent()
```
public final String getTextContent()
```

Returns content of this MP3 resource as base64-encoded string. This value is cached after first invoke.

**Returns:**
java.lang.String
##### save(String fullPathToFile)
```
public final void save(String fullPathToFile)
```

Saves this MP3 resource to the specified file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created or rewritten |

##### equals(IHtmlResource other)
```
public final boolean equals(IHtmlResource other)
```

Checks this instance with specified HTML resource on reference equality

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other inheritor of IHtmlResource interface |

**Returns:**
boolean - True if are equal, false if are unequal
##### equals(Mp3Audio other)
```
public final boolean equals(Mp3Audio other)
```

Checks this instance with specified font resource on reference equality

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Mp3Audio | Other instance of Mp3Audio class |

**Returns:**
boolean - True if are equal, false if are unequal
##### dispose()
```
public final void dispose()
```

Disposes this MP3 resource, disposing its content and making most methods and properties non-working

##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this MP3 content is disposed or not

**Returns:**
boolean

### com.groupdocs.editor.htmlcss.resources.fonts
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts.md

The **com.groupdocs.editor.htmlcss.resources.fonts** namespace provides classes that represent font resources.

#### Classes

| Class | Description |
| --- | --- |
| EotFont | Represents one font in the EOT (Embedded OpenType) format |
| FontResourceBase | Base class for any supported font type as a resource for the HTML document with all its properties |
| FontType | Represents one supportable font type |
| OtfFont | Represents one font in the OTF (Open Type Format) format |
| TtfFont | Represents one font in the TTF (TrueType Font) format |
| Woff2Font | Represents one font in the WOFF2 (Web Open Font Format) format |
| WoffFont | Represents one font in the WOFF (Web Open Font Format) format |

### EotFont
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/eotfont.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase
```
public final class EotFont extends FontResourceBase
```

Represents one font in the EOT (Embedded OpenType) format
#### Constructors

| Constructor | Description |
| --- | --- |
| EotFont(String name, String contentInBase64) | Creates new EotFont class from content, represented as base64-encoded string, and with specified name |
| EotFont(String name, InputStream binaryContent) | Creates new EotFont class from content, represented as byte stream, and with specified name |
#### Fields

| Field | Description |
| --- | --- |
| RequiredHeaderSize | EOT header size (in bytes), which is required for its validation |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid EOT font |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid EOT font |
| getType() | Returns FontType.Eot |
##### EotFont(String name, String contentInBase64)
```
public EotFont(String name, String contentInBase64)
```

Creates new EotFont class from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the EOT font. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a EOT content, exception will be thrown. |

##### EotFont(String name, InputStream binaryContent)
```
public EotFont(String name, InputStream binaryContent)
```

Creates new EotFont class from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the EOT font. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### RequiredHeaderSize
```
public static final int RequiredHeaderSize
```

EOT header size (in bytes), which is required for its validation

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid EOT font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a EOT resource |

**Returns:**
boolean - True if specified stream contains valid EOT font, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid EOT font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably EOT font in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid EOT font, false otherwise
##### getType()
```
public FontType getType()
```

Returns FontType.Eot

**Returns:**
FontType

### FontResourceBase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/fontresourcebase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IHtmlResource
```
public abstract class FontResourceBase implements IHtmlResource
```

Base class for any supported font type as a resource for the HTML document with all its properties
#### Constructors

| Constructor | Description |
| --- | --- |
| FontResourceBase() |  |
#### Fields

| Field | Description |
| --- | --- |
| Disposed | Event, which occurs when this font is disposed |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Returns name of this font resource. |
| getFilenameWithExtension() | Returns correct filename of this font resource, which consists of name and extension. |
| getByteContent() | Returns content of this font as byte stream |
| getTextContent() | Returns content of this font as base64-encoded string. |
| save(String fullPathToFile) | Saves this font to the specified file |
| equals(IHtmlResource other) | Checks this instance with specified HTML resource on reference equality |
| equals(FontResourceBase other) | Checks this instance with specified font resource on reference equality |
| dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| isDisposed() | Determines whether this font is disposed or not |
| getType() | In implementing type should return information about type of specific font resource as an instance of specific FontType type, which encapsulates all type-specific info |
##### FontResourceBase()
```
public FontResourceBase()
```

##### Disposed
```
public final Event<EventHandler> Disposed
```

Event, which occurs when this font is disposed

##### getName()
```
public final String getName()
```

Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename.

**Returns:**
java.lang.String
##### getFilenameWithExtension()
```
public final String getFilenameWithExtension()
```

Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name.

**Returns:**
java.lang.String
##### getByteContent()
```
public final InputStream getByteContent()
```

Returns content of this font as byte stream

**Returns:**
java.io.InputStream -
##### getTextContent()
```
public final String getTextContent()
```

Returns content of this font as base64-encoded string. This value is cached after first invoke.

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public final void save(String fullPathToFile)
```

Saves this font to the specified file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created or rewritten |

##### equals(IHtmlResource other)
```
public final boolean equals(IHtmlResource other)
```

Checks this instance with specified HTML resource on reference equality

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other inheritor of IHtmlResource interface |

**Returns:**
boolean - True if are equal, false if are unequal
##### equals(FontResourceBase other)
```
public final boolean equals(FontResourceBase other)
```

Checks this instance with specified font resource on reference equality

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FontResourceBase | Other inheritor of FontResourceBase abstract class |

**Returns:**
boolean - True if are equal, false if are unequal
##### dispose()
```
public final void dispose()
```

Disposes this font resource, disposing its content and making most methods and properties non-working

##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this font is disposed or not

**Returns:**
boolean -
##### getType()
```
public abstract FontType getType()
```

In implementing type should return information about type of specific font resource as an instance of specific FontType type, which encapsulates all type-specific info

**Returns:**
FontType

### FontType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/fonttype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IResourceType
```
public class FontType implements IResourceType
```

Represents one supportable font type
#### Constructors

| Constructor | Description |
| --- | --- |
| FontType() |  |
#### Methods

| Method | Description |
| --- | --- |
| getUndefined() | Special value, which marks undefined, unknown or unsupported font resource |
| getWoff() | Represents a WOFF (Web Open Font Format) font type |
| getWoff2() | Represents a WOFF2 (Web Open Font Format version 2) font type |
| getTtf() | Represents a TTF (TrueType Font) font type |
| getEot() | Represents a EOT (Embedded OpenType) font type |
| getOtf() | Represents a OTF (OpenType Font) font type |
| getCssName() | Returns CSS-compatible name of this font type, which is used in the |
| getFormalName() | Returns a formal name of this font type |
| getFileExtension() | Filename extension (without dot character) for this font type |
| getFontFormat() | Font format for @font-face format |
| getMimeCode() | MIME code of a particular font type |
| parseFromCssName(String name) | Returns FontType value, which is equivalent of specified CSS-compatible name of the font type |
| parseFromFilenameWithExtension(String filename) | Returns FontType value, which is equivalent of filename extension, which is extracted from specified filename |
| parseFromMime(String mimeCode) | Returns FontType value, which is equivalent of specified MIME-code |
| getFirstDefined(FontType[] fonts) | Returns a first font type from specified set, which is not an "Undefined" value, or "Undefined" font type otherwise (when all items are "Undefined") |
| equals(FontType other) | Determines whether this instance is equal with specified "FontType" instance |
| equals(Object obj) | Determines whether this instance is equal with specified uncasted object, which presumably is another "FontType" instance |
| op_Equality(FontType first, FontType second) | Checks whether two "FontType" values are equal |
| op_Inequality(FontType first, FontType second) | Checks whether two "FontType" values are not equal |
| hashCode() | Returns a hash-code, which is a constant number for this specific value type |
##### FontType()
```
public FontType()
```

##### getUndefined()
```
public static FontType getUndefined()
```

Special value, which marks undefined, unknown or unsupported font resource

**Returns:**
FontType -
##### getWoff()
```
public static FontType getWoff()
```

Represents a WOFF (Web Open Font Format) font type

**Returns:**
FontType -
##### getWoff2()
```
public static FontType getWoff2()
```

Represents a WOFF2 (Web Open Font Format version 2) font type

**Returns:**
FontType -
##### getTtf()
```
public static FontType getTtf()
```

Represents a TTF (TrueType Font) font type

**Returns:**
FontType -
##### getEot()
```
public static FontType getEot()
```

Represents a EOT (Embedded OpenType) font type

**Returns:**
FontType -
##### getOtf()
```
public static FontType getOtf()
```

Represents a OTF (OpenType Font) font type

**Returns:**
FontType -
##### getCssName()
```
public final String getCssName()
```

Returns CSS-compatible name of this font type, which is used in the

**Returns:**
java.lang.String -
##### getFormalName()
```
public final String getFormalName()
```

Returns a formal name of this font type

**Returns:**
java.lang.String -
##### getFileExtension()
```
public final String getFileExtension()
```

Filename extension (without dot character) for this font type

**Returns:**
java.lang.String -
##### getFontFormat()
```
public final String getFontFormat()
```

Font format for @font-face format

**Returns:**
java.lang.String -
##### getMimeCode()
```
public final String getMimeCode()
```

MIME code of a particular font type

**Returns:**
java.lang.String -
##### parseFromCssName(String name)
```
public static FontType parseFromCssName(String name)
```

Returns FontType value, which is equivalent of specified CSS-compatible name of the font type

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | CSS-compatible name of the font type |

**Returns:**
FontType - Valid FontType value on success or FontType.Undefined on failure
##### parseFromFilenameWithExtension(String filename)
```
public static FontType parseFromFilenameWithExtension(String filename)
```

Returns FontType value, which is equivalent of filename extension, which is extracted from specified filename

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filename | java.lang.String | Filename with extension, may be a full name |

**Returns:**
FontType - Valid FontType value on success or FontType.Undefined on failure
##### parseFromMime(String mimeCode)
```
public static FontType parseFromMime(String mimeCode)
```

Returns FontType value, which is equivalent of specified MIME-code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mimeCode | java.lang.String | MIME-code |

**Returns:**
FontType - Valid FontType value on success or FontType.Undefined on failure
##### getFirstDefined(FontType[] fonts)
```
public static FontType getFirstDefined(FontType[] fonts)
```

Returns a first font type from specified set, which is not an "Undefined" value, or "Undefined" font type otherwise (when all items are "Undefined")

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fonts | FontType\[\] | One or more FontType values, NULL or empty collection is not allowed |

**Returns:**
FontType - First FontType value from specified collection, that is not Undefined, or Undefined, if all items are Undefined
##### equals(FontType other)
```
public final boolean equals(FontType other)
```

Determines whether this instance is equal with specified "FontType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FontType | Other FontType instance to check with this |

**Returns:**
boolean - True if are equal, false if are unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this instance is equal with specified uncasted object, which presumably is another "FontType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other instance presumably of FontType struct, that was boxed to System.Object |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Equality(FontType first, FontType second)
```
public static boolean op_Equality(FontType first, FontType second)
```

Checks whether two "FontType" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontType | First FontType to check |
| second | FontType | Second FontType to check |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Inequality(FontType first, FontType second)
```
public static boolean op_Inequality(FontType first, FontType second)
```

Checks whether two "FontType" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | FontType | First FontType to check |
| second | FontType | Second FontType to check |

**Returns:**
boolean - True if are equal, false if are unequal
##### hashCode()
```
public int hashCode()
```

Returns a hash-code, which is a constant number for this specific value type

**Returns:**
int - 4-byte signed integer, 0 for Undefined value

### OtfFont
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/otffont.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase
```
public final class OtfFont extends FontResourceBase
```

Represents one font in the OTF (Open Type Format) format
#### Constructors

| Constructor | Description |
| --- | --- |
| OtfFont(String name, String contentInBase64) | Creates new OtfFont class from content, represented as base64-encoded string, and with specified name |
| OtfFont(String name, InputStream binaryContent) | Creates new OtfFont class from content, represented as byte stream, and with specified name |
#### Fields

| Field | Description |
| --- | --- |
| RequiredHeaderSize | OTF header size (in bytes), which is required for its validation |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid OTF font |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid OTF font |
| getType() | Returns  FontType.Otf (FontType.getOtf) |
##### OtfFont(String name, String contentInBase64)
```
public OtfFont(String name, String contentInBase64)
```

Creates new OtfFont class from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the OTF font. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a OTF content, exception will be thrown. |

##### OtfFont(String name, InputStream binaryContent)
```
public OtfFont(String name, InputStream binaryContent)
```

Creates new OtfFont class from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the OTF font. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### RequiredHeaderSize
```
public static final int RequiredHeaderSize
```

OTF header size (in bytes), which is required for its validation

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid OTF font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a OTF resource |

**Returns:**
boolean - True if specified stream contains valid OTF font, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid OTF font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably OTF font in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid OTF font, false otherwise
##### getType()
```
public FontType getType()
```

Returns  FontType.Otf (FontType.getOtf)

**Returns:**
FontType -

### TtfFont
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/ttffont.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase
```
public final class TtfFont extends FontResourceBase
```

Represents one font in the TTF (TrueType Font) format
#### Constructors

| Constructor | Description |
| --- | --- |
| TtfFont(String name, String contentInBase64) | Creates new TtfFont class from content, represented as base64-encoded string, and with specified name |
| TtfFont(String name, InputStream binaryContent) | Creates new TtfFont class from content, represented as byte stream, and with specified name |
#### Fields

| Field | Description |
| --- | --- |
| RequiredHeaderSize | TTF header size (in bytes), which is required for its validation |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid TTF font |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid TTF font |
| getType() | Returns FontType.Ttf |
##### TtfFont(String name, String contentInBase64)
```
public TtfFont(String name, String contentInBase64)
```

Creates new TtfFont class from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the TTF font. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a TTF content, exception will be thrown. |

##### TtfFont(String name, InputStream binaryContent)
```
public TtfFont(String name, InputStream binaryContent)
```

Creates new TtfFont class from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the TTF font. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### RequiredHeaderSize
```
public static final int RequiredHeaderSize
```

TTF header size (in bytes), which is required for its validation

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid TTF font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a TTF resource |

**Returns:**
boolean - True if specified stream contains valid TTF font, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid TTF font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably TTF font in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid TTF font, false otherwise
##### getType()
```
public FontType getType()
```

Returns FontType.Ttf

**Returns:**
FontType

### Woff2Font
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/woff2font.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase
```
public final class Woff2Font extends FontResourceBase
```

Represents one font in the WOFF2 (Web Open Font Format) format
#### Constructors

| Constructor | Description |
| --- | --- |
| Woff2Font(String name, String contentInBase64) | Creates new Woff2Font class from content, represented as base64-encoded string, and with specified name |
| Woff2Font(String name, InputStream binaryContent) | Creates new Woff2Font class from content, represented as byte stream, and with specified name |
#### Fields

| Field | Description |
| --- | --- |
| RequiredHeaderSize | WOFF2 header size (in bytes), which is required for its validation |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid WOFF2 font |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid WOFF2 font |
| getType() | Returns FontType.Woff2 |
##### Woff2Font(String name, String contentInBase64)
```
public Woff2Font(String name, String contentInBase64)
```

Creates new Woff2Font class from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the WOFF2 font. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a WOFF2 content, exception will be thrown. |

##### Woff2Font(String name, InputStream binaryContent)
```
public Woff2Font(String name, InputStream binaryContent)
```

Creates new Woff2Font class from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the WOFF2 font. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seakable. If this instance will be disposed, this stream will be disposed too. |

##### RequiredHeaderSize
```
public static final int RequiredHeaderSize
```

WOFF2 header size (in bytes), which is required for its validation

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid WOFF2 font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a WOFF2 resource |

**Returns:**
boolean - True if specified stream contains valid WOFF2 font, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid WOFF2 font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably WOFF2 font in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid WOFF2 font, false otherwise
##### getType()
```
public FontType getType()
```

Returns FontType.Woff2

**Returns:**
FontType

### WoffFont
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.fonts/wofffont.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase
```
public final class WoffFont extends FontResourceBase
```

Represents one font in the WOFF (Web Open Font Format) format
#### Constructors

| Constructor | Description |
| --- | --- |
| WoffFont(String name, String contentInBase64) | Creates new WoffFont class from content, represented as base64-encoded string, and with specified name |
| WoffFont(String name, InputStream binaryContent) | Creates new WoffFont class from content, represented as byte stream, and with specified name |
#### Fields

| Field | Description |
| --- | --- |
| RequiredHeaderSize | WOFF header size (in bytes), which is required for its validation |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid WOFF font |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid WOFF font |
| getType() | Returns FontType.Woff |
##### WoffFont(String name, String contentInBase64)
```
public WoffFont(String name, String contentInBase64)
```

Creates new WoffFont class from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the WOFF font. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a WOFF content, exception will be thrown. |

##### WoffFont(String name, InputStream binaryContent)
```
public WoffFont(String name, InputStream binaryContent)
```

Creates new WoffFont class from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the WOFF font. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seakable. If this instance will be disposed, this stream will be disposed too. |

##### RequiredHeaderSize
```
public static final int RequiredHeaderSize
```

WOFF header size (in bytes), which is required for its validation

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid WOFF font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a WOFF resource |

**Returns:**
boolean - True if specified stream contains valid WOFF font, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid WOFF font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably WOFF font in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid WOFF font, false otherwise
##### getType()
```
public FontType getType()
```

Returns FontType.Woff

**Returns:**
FontType

### com.groupdocs.editor.htmlcss.resources.images.raster
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster.md

The **com.groupdocs.editor.htmlcss.resources.images.raster** namespace provides classes that represent only raster image resources.

#### Classes

| Class | Description |
| --- | --- |
| BmpImage | Represents one image in BMP (BitMap Picture) format with its metadata and additional methods |
| GifImage | Represents one image in GIF (Graphics Interchange Format) format with its metadata and additional methods |
| IconImage | Represents one image in ICON format with its metadata and additional methods |
| JpegImage | Represents one image in JPEG (Joint Photographic Experts Group) format with its metadata and additional methods |
| PngImage | Represents one image in PNG (Portable Network Graphics) format with its metadata and additional methods |
| RasterImageResourceBase | Base class for any supported raster image with fixed name, dimensions, aspect ratio, type, size, and content. |
| TiffImage | Represents one image in TIFF (Tagged Image File Format) format with its metadata and additional methods |

### BmpImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/bmpimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
```
public final class BmpImage extends RasterImageResourceBase
```

Represents one image in BMP (BitMap Picture) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| BmpImage(String name, String contentInBase64) | Creates new BmpImage instance from content, represented as base64-encoded string, and with specified name |
| BmpImage(String name, InputStream binaryContent) | Creates new BmpImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid BMP image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid BMP image |
| getType() | Returns ImageType.Bmp |
##### BmpImage(String name, String contentInBase64)
```
public BmpImage(String name, String contentInBase64)
```

Creates new BmpImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the BMP image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a BMP content, exception will be thrown. |

##### BmpImage(String name, InputStream binaryContent)
```
public BmpImage(String name, InputStream binaryContent)
```

Creates new BmpImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the BMP image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid BMP image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a BMP image |

**Returns:**
boolean - True if specified stream contains valid BMP image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid BMP image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably BMP image in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid BMP image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Bmp

**Returns:**
ImageType

### GifImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/gifimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
```
public final class GifImage extends RasterImageResourceBase
```

Represents one image in GIF (Graphics Interchange Format) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| GifImage(String name, String contentInBase64) | Creates new GifImage instance from content, represented as base64-encoded string, and with specified name |
| GifImage(String name, InputStream binaryContent) | Creates new GifImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid GIF image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid GIF image |
| getType() | Returns ImageType.Gif |
| getVersion() | Returns internal version of this GIF image (version is extracted from header) |
##### GifImage(String name, String contentInBase64)
```
public GifImage(String name, String contentInBase64)
```

Creates new GifImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the GIF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a GIF content, exception will be thrown. |

##### GifImage(String name, InputStream binaryContent)
```
public GifImage(String name, InputStream binaryContent)
```

Creates new GifImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the GIF image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid GIF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a GIF image |

**Returns:**
boolean - True if specified stream contains valid GIF image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid GIF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably GIF image in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid GIF image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Gif

**Returns:**
ImageType
##### getVersion()
```
public final String getVersion()
```

Returns internal version of this GIF image (version is extracted from header)

**Returns:**
java.lang.String

### IconImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/iconimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
```
public final class IconImage extends RasterImageResourceBase
```

Represents one image in ICON format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| IconImage(String name, String contentInBase64) | Creates new IconImage instance from content, represented as base64-encoded string, and with specified name |
| IconImage(String name, InputStream binaryContent) | Creates new IconImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid ICON image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid ICON image |
| getType() | Returns ImageType.Icon |
| getNumberOfImages() | Returns number of images, which are present in this ICON file |
##### IconImage(String name, String contentInBase64)
```
public IconImage(String name, String contentInBase64)
```

Creates new IconImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the ICON image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a ICON content, exception will be thrown. |

##### IconImage(String name, InputStream binaryContent)
```
public IconImage(String name, InputStream binaryContent)
```

Creates new IconImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the ICON image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid ICON image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a ICON image |

**Returns:**
boolean - True if specified stream contains valid ICON image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid ICON image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably ICON image in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid ICON image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Icon

**Returns:**
ImageType
##### getNumberOfImages()
```
public final int getNumberOfImages()
```

Returns number of images, which are present in this ICON file

**Returns:**
int

### JpegImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/jpegimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
```
public final class JpegImage extends RasterImageResourceBase
```

Represents one image in JPEG (Joint Photographic Experts Group) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| JpegImage(String name, String contentInBase64) | Creates new JpegImage instance from content, represented as base64-encoded string, and with specified name |
| JpegImage(String name, InputStream binaryContent) | Creates new JpegImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid JPEG image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid JPEG image |
| getType() | Returns ImageType.Jpeg |
##### JpegImage(String name, String contentInBase64)
```
public JpegImage(String name, String contentInBase64)
```

Creates new JpegImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the JPEG image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a JPEG content, exception will be thrown. |

##### JpegImage(String name, InputStream binaryContent)
```
public JpegImage(String name, InputStream binaryContent)
```

Creates new JpegImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the JPEG image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid JPEG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a JPEG image |

**Returns:**
boolean - True if specified stream contains valid JPEG image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid JPEG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably JPEG image in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid JPEG image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Jpeg

**Returns:**
ImageType -

### PngImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/pngimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
```
public final class PngImage extends RasterImageResourceBase
```

Represents one image in PNG (Portable Network Graphics) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| PngImage(String name, String contentInBase64) | Creates new PngImage instance from content, represented as base64-encoded string, and with specified name |
| PngImage(String name, InputStream binaryContent) | Creates new PngImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid PNG image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid PNG image |
| getType() | Returns ImageType.Png |
##### PngImage(String name, String contentInBase64)
```
public PngImage(String name, String contentInBase64)
```

Creates new PngImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the PNG image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a PNG content, exception will be thrown. |

##### PngImage(String name, InputStream binaryContent)
```
public PngImage(String name, InputStream binaryContent)
```

Creates new PngImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the PNG image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid PNG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a PNG image |

**Returns:**
boolean - True if specified stream contains valid PNG image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid PNG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably PNG image in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid PNG image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Png

**Returns:**
ImageType -

### RasterImageResourceBase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.images.IImageResource
```
public abstract class RasterImageResourceBase implements IImageResource
```

Base class for any supported raster image with fixed name, dimensions, aspect ratio, type, size, and content.
#### Constructors

| Constructor | Description |
| --- | --- |
| RasterImageResourceBase() |  |
#### Fields

| Field | Description |
| --- | --- |
| Disposed |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Returns name of this raster image. |
| getFilenameWithExtension() | Returns correct filename of this raster image, which consists of name and extension. |
| getLinearDimensions() | Returns linear dimensions of this raster image (width and height) |
| getAspectRatio() | Returns an aspect ratio of this image as the width-to-height relation |
| getLength() | Returns the length of this raster image file in bytes |
| getByteContent() | Returns content of this raster image as byte stream |
| getTextContent() | Returns content of this raster image as base64-encoded string |
| save(String fullPathToFile) | Saves this raster image to the specified file |
| equals(IHtmlResource other) | Checks this instance with specified on reference equality. |
| dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| isDisposed() | Determines whether this raster image is disposed or not |
| getType() | In implementing type should return information about type of the raster image |
##### RasterImageResourceBase()
```
public RasterImageResourceBase()
```

##### Disposed
```
public final Event<EventHandler> Disposed
```

##### getName()
```
public final String getName()
```

Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename.

**Returns:**
java.lang.String
##### getFilenameWithExtension()
```
public final String getFilenameWithExtension()
```

Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name.

**Returns:**
java.lang.String
##### getLinearDimensions()
```
public final Dimensions getLinearDimensions()
```

Returns linear dimensions of this raster image (width and height)

**Returns:**
Dimensions
##### getAspectRatio()
```
public final Ratio getAspectRatio()
```

Returns an aspect ratio of this image as the width-to-height relation

**Returns:**
Ratio
##### getLength()
```
public final int getLength()
```

Returns the length of this raster image file in bytes

**Returns:**
int -
##### getByteContent()
```
public final InputStream getByteContent()
```

Returns content of this raster image as byte stream

**Returns:**
java.io.InputStream -
##### getTextContent()
```
public final String getTextContent()
```

Returns content of this raster image as base64-encoded string

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public final void save(String fullPathToFile)
```

Saves this raster image to the specified file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created or rewritten |

##### equals(IHtmlResource other)
```
public final boolean equals(IHtmlResource other)
```

Checks this instance with specified on reference equality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other IHtmlResource inheritor |

**Returns:**
boolean - True if are equal, false if are unequal
##### dispose()
```
public final void dispose()
```

Disposes this raster image, disposing its content and making most methods and properties non-working

##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this raster image is disposed or not

**Returns:**
boolean -
##### getType()
```
public abstract ImageType getType()
```

In implementing type should return information about type of the raster image

**Returns:**
ImageType -

### TiffImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.raster/tiffimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
```
public final class TiffImage extends RasterImageResourceBase
```

Represents one image in TIFF (Tagged Image File Format) format with its metadata and additional methods

See https://en.wikipedia.org/wiki/TIFF for details. In very rare cases TIFF is present inside WordProcessing documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffImage(String name, String contentInBase64) | Creates new TiffImage instance from content, represented as base64-encoded string, and with specified name |
| TiffImage(String name, InputStream binaryContent) | Creates new GifImage instance from content, represented as byte stream, and with specified name |
| TiffImage(String name, System.IO.Stream binaryContent) |  |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid TIFF image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid TIFF image |
| getType() | Returns ImageType.Tiff |
| getFramesCount() | Returns a number of frames (images) inside this TIFF image. |
##### TiffImage(String name, String contentInBase64)
```
public TiffImage(String name, String contentInBase64)
```

Creates new TiffImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the TIFF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a TIFF content, exception will be thrown. |

##### TiffImage(String name, InputStream binaryContent)
```
public TiffImage(String name, InputStream binaryContent)
```

Creates new GifImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the GIF image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### TiffImage(String name, System.IO.Stream binaryContent)
```
public TiffImage(String name, System.IO.Stream binaryContent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |
| binaryContent | com.aspose.ms.System.IO.Stream |  |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid TIFF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a TIFF image |

**Returns:**
boolean - True if specified stream contains valid TIFF image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid TIFF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Content of the presumably TIFF image in a form of base64-encoded string |

**Returns:**
boolean - True if specified string contains valid TIFF image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Tiff

**Returns:**
ImageType -
##### getFramesCount()
```
public final int getFramesCount()
```

Returns a number of frames (images) inside this TIFF image. Cannot be lesser then 1.

**Returns:**
int -

### com.groupdocs.editor.htmlcss.resources.images.vector
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.vector.md

The **com.groupdocs.editor.htmlcss.resources.images.vector** namespace provides classes that represent only vector image resources.

#### Classes

| Class | Description |
| --- | --- |
| EmfImage | Represents one vector image in Enhanced metafile format (EMF) format with its metadata and additional methods |
| MetaImageBase | Base abstract class for WMF and EMF image formats |
| SvgImage | Represents one vector image in SVG (Scalable Vector Graphics) format with its metadata and additional methods |
| VectorImageResourceBase | Base class for any supported vector image |
| WmfImage | Represents one vector image in WMF (Windows MetaFile) format with its metadata and additional methods |

### EmfImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.vector/emfimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase, com.groupdocs.editor.htmlcss.resources.images.vector.MetaImageBase
```
public final class EmfImage extends MetaImageBase
```

Represents one vector image in Enhanced metafile format (EMF) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| EmfImage(String name, String contentInBase64) | Creates new EmfImage instance from content, represented as base64-encoded string, and with specified name |
| EmfImage(String name, InputStream binaryContent) | Creates new EmfImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid EMF image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid EMF image |
| getType() | Returns ImageType.Emf |
| getByteContent() | Returns a content of this EMF image as a binary stream |
| getTextContent() | Returns a content of this EMF image as a plain text |
| save(String fullPathToFile) | Saves this EMF image to the file |
| saveToPng(OutputStream outputPngContent) | Saves this vector EMF image into raster PNG image |
| saveToSvg(OutputStream outputSvgContent) | Saves this vector EMF image into vector SVG image |
| dispose() | Disposes this EMF image by disposing its content and making most its methods and properties non-working |
##### EmfImage(String name, String contentInBase64)
```
public EmfImage(String name, String contentInBase64)
```

Creates new EmfImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the EMF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a EMF content, exception will be thrown. |

##### EmfImage(String name, InputStream binaryContent)
```
public EmfImage(String name, InputStream binaryContent)
```

Creates new EmfImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the EMF image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid EMF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Input byte stream. Cannot be NULL, should support reading and seeking. |

**Returns:**
boolean - True if specified stream holds a valid EMF image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid EMF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Input string, where content of EMF image is stored in base64 encoding. Cannot be NULL or empty. |

**Returns:**
boolean - True if specified string holds a valid EMF image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Emf

**Returns:**
ImageType
##### getByteContent()
```
public InputStream getByteContent()
```

Returns a content of this EMF image as a binary stream

**Returns:**
java.io.InputStream
##### getTextContent()
```
public String getTextContent()
```

Returns a content of this EMF image as a plain text

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public void save(String fullPathToFile)
```

Saves this EMF image to the file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created (if it doesn't exist) or overwritten (if exists) with the content of this EMF image |

##### saveToPng(OutputStream outputPngContent)
```
public void saveToPng(OutputStream outputPngContent)
```

Saves this vector EMF image into raster PNG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | java.io.OutputStream | Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable. |

##### saveToSvg(OutputStream outputSvgContent)
```
public void saveToSvg(OutputStream outputSvgContent)
```

Saves this vector EMF image into vector SVG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputSvgContent | java.io.OutputStream | Output stream, into which the content of SVG image will be written. Cannot be NULL and should be writable. |

##### dispose()
```
public void dispose()
```

Disposes this EMF image by disposing its content and making most its methods and properties non-working

### MetaImageBase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.vector/metaimagebase.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase
```
public abstract class MetaImageBase extends VectorImageResourceBase
```

Base abstract class for WMF and EMF image formats
#### Constructors

| Constructor | Description |
| --- | --- |
| MetaImageBase(String name, String contentInBase64, boolean isWmf) | Common constructor, which prepares a creating a WMF or EMF instance from base64-encoded string |
| MetaImageBase(String name, InputStream binaryContent, boolean isWmf) | Common constructor, which prepares a creating a WMF or EMF instance from byte stream |
#### Methods

| Method | Description |
| --- | --- |
| isValidWmf(InputStream binaryContent) | Determines whether specified byte stream contains a valid WMF image |
| isValidWmf(String contentInBase64) | Determines whether specified string contains a valid WMF image, which is encoded with base64 |
| isValidEmf(InputStream binaryContent) | Determines whether specified byte stream contains a valid EMF image |
| isValidEmf(String contentInBase64) | Determines whether specified string contains a valid EMF image, which is encoded with base64 |
| saveToSvg(OutputStream outputSvgContent) | In implementing type should save a current vector meta-image to the vector SVG format into specified byte stream |
##### MetaImageBase(String name, String contentInBase64, boolean isWmf)
```
public MetaImageBase(String name, String contentInBase64, boolean isWmf)
```

Common constructor, which prepares a creating a WMF or EMF instance from base64-encoded string

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Mandatory name |
| contentInBase64 | java.lang.String | Content as base64 string. Should be not NULL or empty. |
| isWmf | boolean | true for WMF, false for EMF |

##### MetaImageBase(String name, InputStream binaryContent, boolean isWmf)
```
public MetaImageBase(String name, InputStream binaryContent, boolean isWmf)
```

Common constructor, which prepares a creating a WMF or EMF instance from byte stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Mandatory name |
| binaryContent | java.io.InputStream | Content as byte stream. Should be valid. |
| isWmf | boolean | true for WMF, false for EMF |

##### isValidWmf(InputStream binaryContent)
```
public static boolean isValidWmf(InputStream binaryContent)
```

Determines whether specified byte stream contains a valid WMF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Input byte stream. Should be valid. |

**Returns:**
boolean - Returns 'true' if valid and 'false' if invalid
##### isValidWmf(String contentInBase64)
```
public static boolean isValidWmf(String contentInBase64)
```

Determines whether specified string contains a valid WMF image, which is encoded with base64

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | String, which is assumed to contain a base64-encoded WMF image |

**Returns:**
boolean - Returns 'true' if valid and 'false' if invalid
##### isValidEmf(InputStream binaryContent)
```
public static boolean isValidEmf(InputStream binaryContent)
```

Determines whether specified byte stream contains a valid EMF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Input byte stream. Should be valid. |

**Returns:**
boolean - Returns 'true' if valid and 'false' if invalid
##### isValidEmf(String contentInBase64)
```
public static boolean isValidEmf(String contentInBase64)
```

Determines whether specified string contains a valid EMF image, which is encoded with base64

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | String, which is assumed to contain a base64-encoded EMF image |

**Returns:**
boolean - Returns 'true' if valid and 'false' if invalid
##### saveToSvg(OutputStream outputSvgContent)
```
public abstract void saveToSvg(OutputStream outputSvgContent)
```

In implementing type should save a current vector meta-image to the vector SVG format into specified byte stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputSvgContent | java.io.OutputStream | Byte stream, into which the SVG version of this vector meta-image will be stored. Should not be NULL and should support writing. |

### SvgImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.vector/svgimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase
```
public final class SvgImage extends VectorImageResourceBase
```

Represents one vector image in SVG (Scalable Vector Graphics) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| SvgImage(String name, String content) | Creates new SvgImage instance from content, represented as usual string, and with specified name |
| SvgImage(String name, InputStream binaryContent) | Creates new SvgImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(String content) | Performs a surface check whether specified textual XML-compliant content represents a SVG image |
| getType() | Returns ImageType.Svg |
| getByteContent() | Returns a content of this SVG image as a binary stream |
| getTextContent() | Returns a content of this SVG image as a plain text (in XML format) |
| getXmlContent() | Returns a content of this SVG image int its original XML-compliant textual form |
| save(String fullPathToFile) | Saves this SVG image to the file |
| saveToPng(OutputStream outputPngContent) | Saves this vector SVG image into raster PNG image |
| dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
##### SvgImage(String name, String content)
```
public SvgImage(String name, String content)
```

Creates new SvgImage instance from content, represented as usual string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the SVG image. Cannot be null, empty or whitespaces. |
| content | java.lang.String | Content as a usual string, which contains a valid XML-compliant content of SVG image. Cannot be null, empty or whitespaces. If it is not a SVG content, exception will be thrown. |

##### SvgImage(String name, InputStream binaryContent)
```
public SvgImage(String name, InputStream binaryContent)
```

Creates new SvgImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the SVG image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(String content)
```
public static boolean isValid(String content)
```

Performs a surface check whether specified textual XML-compliant content represents a SVG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | java.lang.String | XML content of an SVG image as simple text, not a base64-encoded content |

**Returns:**
boolean - True if specified string can be treated as valid SVG at first look, false if it is not SVG for sure
##### getType()
```
public ImageType getType()
```

Returns ImageType.Svg

**Returns:**
ImageType -
##### getByteContent()
```
public InputStream getByteContent()
```

Returns a content of this SVG image as a binary stream

**Returns:**
java.io.InputStream -
##### getTextContent()
```
public String getTextContent()
```

Returns a content of this SVG image as a plain text (in XML format)

**Returns:**
java.lang.String -
##### getXmlContent()
```
public final String getXmlContent()
```

Returns a content of this SVG image int its original XML-compliant textual form

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public void save(String fullPathToFile)
```

Saves this SVG image to the file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created (if it doesn't exist) or overwritten (if exists) with the content of this SVG image |

##### saveToPng(OutputStream outputPngContent)
```
public void saveToPng(OutputStream outputPngContent)
```

Saves this vector SVG image into raster PNG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | java.io.OutputStream | Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable. |

##### dispose()
```
public void dispose()
```

Disposes this raster image, disposing its content and making most methods and properties non-working

### VectorImageResourceBase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.images.IImageResource
```
public abstract class VectorImageResourceBase implements IImageResource
```

Base class for any supported vector image
#### Constructors

| Constructor | Description |
| --- | --- |
| VectorImageResourceBase() |  |
#### Fields

| Field | Description |
| --- | --- |
| Disposed |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Returns name of this vector image. |
| getFilenameWithExtension() | Returns correct filename of this vector image, which consists of name and extension. |
| getAspectRatio() | Returns aspect ratio of this vector image |
| getLinearDimensions() | Returns linear dimensions of this vector image (width and height) |
| equals(IHtmlResource other) | Checks this instance with specified on reference equality. |
| isDisposed() | Determines whether this raster image is disposed or not |
| getType() | In implementing type should return information about type of the vector image |
| getByteContent() | In implementing type should return a content of this vector image as byte stream |
| getTextContent() | In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type |
| save(String fullPathToFile) | In implementing type should save this image to the disk by specified path |
| saveToPng(OutputStream outputPngContent) | In implementing type should save a current vector image to the raster PNG format into specified byte stream |
| dispose() | In implementing type should dispose this instance |
##### VectorImageResourceBase()
```
public VectorImageResourceBase()
```

##### Disposed
```
public final Event<EventHandler> Disposed
```

##### getName()
```
public final String getName()
```

Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename.

**Returns:**
java.lang.String
##### getFilenameWithExtension()
```
public final String getFilenameWithExtension()
```

Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name.

**Returns:**
java.lang.String
##### getAspectRatio()
```
public final Ratio getAspectRatio()
```

Returns aspect ratio of this vector image

**Returns:**
Ratio
##### getLinearDimensions()
```
public final Dimensions getLinearDimensions()
```

Returns linear dimensions of this vector image (width and height)

**Returns:**
Dimensions
##### equals(IHtmlResource other)
```
public final boolean equals(IHtmlResource other)
```

Checks this instance with specified on reference equality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other instance of vector image |

**Returns:**
boolean - True if are equal, false if are unequal
##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this raster image is disposed or not

**Returns:**
boolean -
##### getType()
```
public abstract ImageType getType()
```

In implementing type should return information about type of the vector image

**Returns:**
ImageType -
##### getByteContent()
```
public InputStream getByteContent()
```

In implementing type should return a content of this vector image as byte stream

**Returns:**
java.io.InputStream -
##### getTextContent()
```
public abstract String getTextContent()
```

In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public abstract void save(String fullPathToFile)
```

In implementing type should save this image to the disk by specified path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String |  |

##### saveToPng(OutputStream outputPngContent)
```
public abstract void saveToPng(OutputStream outputPngContent)
```

In implementing type should save a current vector image to the raster PNG format into specified byte stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | java.io.OutputStream | Byte stream, into which the PNG version of this raster image will be stored. Should not be NULL and should support writing. |

##### dispose()
```
public abstract void dispose()
```

In implementing type should dispose this instance

### WmfImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.vector/wmfimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase, com.groupdocs.editor.htmlcss.resources.images.vector.MetaImageBase
```
public final class WmfImage extends MetaImageBase
```

Represents one vector image in WMF (Windows MetaFile) format with its metadata and additional methods
#### Constructors

| Constructor | Description |
| --- | --- |
| WmfImage(String name, String contentInBase64) | Creates new WmfImage instance from content, represented as base64-encoded string, and with specified name |
| WmfImage(String name, InputStream binaryContent) | Creates new WmfImage instance from content, represented as byte stream, and with specified name |
#### Methods

| Method | Description |
| --- | --- |
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid WMF image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid WMF image |
| getType() | Returns ImageType.Wmf |
| getByteContent() | Returns a content of this WMF image as a binary stream |
| getTextContent() | Returns a content of this WMF image as a plain text |
| save(String fullPathToFile) | Saves this WMF image to the file |
| saveToPng(OutputStream outputPngContent) | Saves this vector WMF image into raster PNG image |
| saveToSvg(OutputStream outputSvgContent) | Saves this vector WMF image into vector SVG image |
| dispose() | Disposes this WMF image by disposing its content and making most its methods and properties non-working |
##### WmfImage(String name, String contentInBase64)
```
public WmfImage(String name, String contentInBase64)
```

Creates new WmfImage instance from content, represented as base64-encoded string, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the WMF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | java.lang.String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a WMF content, exception will be thrown. |

##### WmfImage(String name, InputStream binaryContent)
```
public WmfImage(String name, InputStream binaryContent)
```

Creates new WmfImage instance from content, represented as byte stream, and with specified name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of the WMF image. Cannot be null, empty or whitespaces. |
| binaryContent | java.io.InputStream | Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too. |

##### isValid(InputStream binaryContent)
```
public static boolean isValid(InputStream binaryContent)
```

Checks whether specified stream is a valid WMF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | java.io.InputStream | Input byte stream. Cannot be NULL, should support reading and seeking. |

**Returns:**
boolean - True if specified stream holds a valid WMF image, false otherwise
##### isValid(String contentInBase64)
```
public static boolean isValid(String contentInBase64)
```

Checks whether specified base64-encoded string is a valid WMF image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | java.lang.String | Input string, where content of WMF image is stored in base64 encoding. Cannot be NULL or empty. |

**Returns:**
boolean - True if specified string holds a valid WMF image, false otherwise
##### getType()
```
public ImageType getType()
```

Returns ImageType.Wmf

**Returns:**
ImageType -
##### getByteContent()
```
public InputStream getByteContent()
```

Returns a content of this WMF image as a binary stream

**Returns:**
java.io.InputStream -
##### getTextContent()
```
public String getTextContent()
```

Returns a content of this WMF image as a plain text

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public void save(String fullPathToFile)
```

Saves this WMF image to the file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created (if it doesn't exist) or overwritten (if exists) with the content of this WMF image |

##### saveToPng(OutputStream outputPngContent)
```
public void saveToPng(OutputStream outputPngContent)
```

Saves this vector WMF image into raster PNG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | java.io.OutputStream | Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable. |

##### saveToSvg(OutputStream outputSvgContent)
```
public void saveToSvg(OutputStream outputSvgContent)
```

Saves this vector WMF image into vector SVG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputSvgContent | java.io.OutputStream | Output stream, into which the content of SVG image will be written. Cannot be NULL and should be writable. |

##### dispose()
```
public void dispose()
```

Disposes this WMF image by disposing its content and making most its methods and properties non-working

### com.groupdocs.editor.htmlcss.resources.images
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images.md

The **com.groupdocs.editor.htmlcss.resources.images** namespace provides classes that represent image resources of all types in general.

#### Classes

| Class | Description |
| --- | --- |
| Dimensions | Represents the linear dimensions (width and height) of one raster rectangular image in arbitrary unit. |
| ImageType | Represents one supportable image type (format), supports both raster and vector formats |

#### Interfaces

| Interface | Description |
| --- | --- |
| IImage | Image CSS data type represents a two-dimensional image |
| IImageResource | Represents image resource of any type, raster or vector |

### Dimensions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images/dimensions.md

**Inheritance:**
java.lang.Object
```
public class Dimensions
```

Represents the linear dimensions (width and height) of one raster rectangular image in arbitrary unit. Immutable struct.
#### Constructors

| Constructor | Description |
| --- | --- |
| Dimensions(int width, int height) | Creates a new instance from specified width and height |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Returns width of the image |
| getHeight() | Returns height of the image |
| isSquare() | Determines whether specified 'Dimensions' represents square, i.e. |
| getArea() | Returns an area (Width x Height) |
| isEmpty() | Determines whether this "Dimensions" instance is empty and default, i.e. |
| getAspectRatio() | Aspect ratio of this dimensions as width/height |
| proportionallyResizeForNewWidth(int targetWidth) | Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified width |
| proportionallyResizeForNewHeight(int targetHeight) | Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified height |
| equals(Dimensions other) | Determines whether this instance is equal with specified "Dimensions" instance |
| equals(Object obj) | Determines whether this instance is equal with specified uncasted object, which presumably is another "Dimensions" instance |
| hashCode() | Returns a hashcode for this instance, which cannot be changed during its lifetime |
| op_Equality(Dimensions first, Dimensions second) | Checks whether two "Dimensions" values are equal, i.e. |
| op_Inequality(Dimensions first, Dimensions second) | Checks whether two "Dimensions" values are not equal, i.e. |
| toString() | Returns a string representation of this "Dimensions" |
| deepClone() | Returns a full copy of this instance |
| getEmpty() | Returns an empty Dimensions instance |
##### Dimensions(int width, int height)
```
public Dimensions(int width, int height)
```

Creates a new instance from specified width and height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | Width of image |
| height | int | Height of image |

##### getWidth()
```
public final int getWidth()
```

Returns width of the image

**Returns:**
int
##### getHeight()
```
public final int getHeight()
```

Returns height of the image

**Returns:**
int
##### isSquare()
```
public final boolean isSquare()
```

Determines whether specified 'Dimensions' represents square, i.e. if width is equal to height

**Returns:**
boolean
##### getArea()
```
public final long getArea()
```

Returns an area (Width x Height)

**Returns:**
long
##### isEmpty()
```
public final boolean isEmpty()
```

Determines whether this "Dimensions" instance is empty and default, i.e. it doesn't store correct width and height

**Returns:**
boolean
##### getAspectRatio()
```
public final Ratio getAspectRatio()
```

Aspect ratio of this dimensions as width/height

**Returns:**
Ratio
##### proportionallyResizeForNewWidth(int targetWidth)
```
public final Dimensions proportionallyResizeForNewWidth(int targetWidth)
```

Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| targetWidth | int | New target width, that will be present in resultant Dimension |

**Returns:**
Dimensions - New "Dimensions" instance with specified target width and proportionally resized height
##### proportionallyResizeForNewHeight(int targetHeight)
```
public final Dimensions proportionallyResizeForNewHeight(int targetHeight)
```

Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| targetHeight | int | New target height, that will be present in resultant Dimension |

**Returns:**
Dimensions - New "Dimensions" instance with specified target height and proportionally resized width
##### equals(Dimensions other)
```
public final boolean equals(Dimensions other)
```

Determines whether this instance is equal with specified "Dimensions" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Dimensions | Other "Dimensions" instance to check on equality |

**Returns:**
boolean - True if are equal, false if are not equal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this instance is equal with specified uncasted object, which presumably is another "Dimensions" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other object, that is presumably of "Dimensions" type, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are not equal
##### hashCode()
```
public int hashCode()
```

Returns a hashcode for this instance, which cannot be changed during its lifetime

**Returns:**
int - Immutable (for this instance) hash-code as signed 4-byte integer
##### op_Equality(Dimensions first, Dimensions second)
```
public static boolean op_Equality(Dimensions first, Dimensions second)
```

Checks whether two "Dimensions" values are equal, i.e. they have equal width and height, or both are empty

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | Dimensions | First instance to check |
| second | Dimensions | Second instance to check |

**Returns:**
boolean - True if are equal, false if are not equal
##### op_Inequality(Dimensions first, Dimensions second)
```
public static boolean op_Inequality(Dimensions first, Dimensions second)
```

Checks whether two "Dimensions" values are not equal, i.e. their corresponding width and/or height are different

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | Dimensions | First instance to check |
| second | Dimensions | Second instance to check |

**Returns:**
boolean - True if are unequal, false if are equal
##### toString()
```
public String toString()
```

Returns a string representation of this "Dimensions"

> ```
> W640×H480
> ```

**Returns:**
java.lang.String - String instance, that contains a width and height in W:(width)×H:(height) format
##### deepClone()
```
public final Dimensions deepClone()
```

Returns a full copy of this instance

**Returns:**
Dimensions - New instance, that is a full and deep copy of this one
##### getEmpty()
```
public static Dimensions getEmpty()
```

Returns an empty Dimensions instance

**Returns:**
Dimensions

### IImage
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images/iimage.md

### IImageResource
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images/iimageresource.md

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IHtmlResource, com.groupdocs.editor.htmlcss.resources.images.IImage
```
public interface IImageResource extends IHtmlResource, IImage
```

Represents image resource of any type, raster or vector

https://developer.mozilla.org/en-US/docs/Web/CSS/image
#### Methods

| Method | Description |
| --- | --- |
| getType() | In implementing type should return a type of specific image as an instance of specific ImageType, which encapsulates all type-specific info |
| getAspectRatio() | In implementing type should return an aspect ratio of particular image regardless of its type. |
| getLinearDimensions() | In implementing type should return linear dimensions of the image. |
##### getType()
```
public abstract ImageType getType()
```

In implementing type should return a type of specific image as an instance of specific ImageType, which encapsulates all type-specific info

**Returns:**
ImageType
##### getAspectRatio()
```
public abstract Ratio getAspectRatio()
```

In implementing type should return an aspect ratio of particular image regardless of its type. Both vector and raster images have intrinsic aspect ratio between its width and height.

**Returns:**
Ratio -
##### getLinearDimensions()
```
public abstract Dimensions getLinearDimensions()
```

In implementing type should return linear dimensions of the image. For raster images they are intrinsic dimensions in pixels. Vector images, in counterpart, have no fixed dimensions, but their metadata can contain some basic dimensions in different measurement units.

**Returns:**
Dimensions -

### ImageType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.images/imagetype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IResourceType
```
public class ImageType implements IResourceType
```

Represents one supportable image type (format), supports both raster and vector formats
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageType() |  |
#### Methods

| Method | Description |
| --- | --- |
| getUndefined() | Undefined image type - special value, which should not normally occur |
| getJpeg() | JPEG image type |
| getPng() | PNG image type |
| getBmp() | BMP image type |
| getGif() | GIF image type |
| getIcon() | ICON image type |
| getSvg() | SVG vector image type |
| getWmf() | WMF (Windows MetaFile) vector image type |
| getEmf() | EMF (Enhanced MetaFile) vector image type |
| getTiff() | TIFF (Tagged Image File Format) raster image type |
| getFormalName() | Returns a formal name of this image format. |
| isVector() | Indicates whether this particular format is vector (true) or raster (false) |
| getFileExtension() | File extension (without leading dot character) of a particular image type in lower case. |
| toString() | Returns a FormalName property |
| getMimeCode() | MIME code of a particular image type as a string. |
| equals(ImageType other) | Determines whether this instance is equal with specified "ImageType" instance |
| equals(Object obj) | Determines whether this instance is equal with specified uncasted object, which presumably is another "ImageType" instance |
| op_Equality(ImageType first, ImageType second) | Defines whether two specific ImageType instances are equal |
| op_Inequality(ImageType first, ImageType second) | Defines whether two specific ImageType instances are not equal |
| hashCode() | Returns a hash-code, which is an immutable number for this specific instance |
| parseFromFilenameWithExtension(String filename) | Returns ImageType value, which is equivalent of filename extension, which is extracted from specified filename |
| parseFromMime(String mimeCode) | Returns ImageType value, which is equivalent of specified MIME code |
##### ImageType()
```
public ImageType()
```

##### getUndefined()
```
public static ImageType getUndefined()
```

Undefined image type - special value, which should not normally occur

**Returns:**
ImageType
##### getJpeg()
```
public static ImageType getJpeg()
```

JPEG image type

**Returns:**
ImageType
##### getPng()
```
public static ImageType getPng()
```

PNG image type

**Returns:**
ImageType
##### getBmp()
```
public static ImageType getBmp()
```

BMP image type

**Returns:**
ImageType
##### getGif()
```
public static ImageType getGif()
```

GIF image type

**Returns:**
ImageType
##### getIcon()
```
public static ImageType getIcon()
```

ICON image type

**Returns:**
ImageType
##### getSvg()
```
public static ImageType getSvg()
```

SVG vector image type

**Returns:**
ImageType
##### getWmf()
```
public static ImageType getWmf()
```

WMF (Windows MetaFile) vector image type

**Returns:**
ImageType
##### getEmf()
```
public static ImageType getEmf()
```

EMF (Enhanced MetaFile) vector image type

**Returns:**
ImageType
##### getTiff()
```
public static ImageType getTiff()
```

TIFF (Tagged Image File Format) raster image type

**Returns:**
ImageType
##### getFormalName()
```
public final String getFormalName()
```

Returns a formal name of this image format. Never reurns NULL. If instance is not corrupted, never throws an exception.

**Returns:**
java.lang.String
##### isVector()
```
public final boolean isVector()
```

Indicates whether this particular format is vector (true) or raster (false)

**Returns:**
boolean
##### getFileExtension()
```
public final String getFileExtension()
```

File extension (without leading dot character) of a particular image type in lower case. For the Undefined type returns a string 'unsefined'.

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Returns a FormalName property

**Returns:**
java.lang.String -
##### getMimeCode()
```
public final String getMimeCode()
```

MIME code of a particular image type as a string. For the Undefined type returns a string 'unsefined'.

**Returns:**
java.lang.String
##### equals(ImageType other)
```
public final boolean equals(ImageType other)
```

Determines whether this instance is equal with specified "ImageType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ImageType | Other ImageType instance to check on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this instance is equal with specified uncasted object, which presumably is another "ImageType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other System.Object instance, that is presumably of ImageType type, to check on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Equality(ImageType first, ImageType second)
```
public static boolean op_Equality(ImageType first, ImageType second)
```

Defines whether two specific ImageType instances are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | ImageType | First ImageType instance to check |
| second | ImageType | Second ImageType instance to check |

**Returns:**
boolean - True if are equal, false if are unequal
##### op_Inequality(ImageType first, ImageType second)
```
public static boolean op_Inequality(ImageType first, ImageType second)
```

Defines whether two specific ImageType instances are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | ImageType | First ImageType instance to check |
| second | ImageType | Second ImageType instance to check |

**Returns:**
boolean - True if are unequal, false if are equal
##### hashCode()
```
public int hashCode()
```

Returns a hash-code, which is an immutable number for this specific instance

**Returns:**
int - Signed 4-byte integer
##### parseFromFilenameWithExtension(String filename)
```
public static ImageType parseFromFilenameWithExtension(String filename)
```

Returns ImageType value, which is equivalent of filename extension, which is extracted from specified filename

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filename | java.lang.String | Arbitrary filename, can be a relative or full path |

**Returns:**
ImageType - ImageType value. Returns ImageType.Undefined, if extension cannot be recognized.
##### parseFromMime(String mimeCode)
```
public static ImageType parseFromMime(String mimeCode)
```

Returns ImageType value, which is equivalent of specified MIME code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mimeCode | java.lang.String | Arbitrary MIME-code |

**Returns:**
ImageType - ImageType value. Returns ImageType.Undefined, if extension cannot be recognized.

### com.groupdocs.editor.htmlcss.resources.textual
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.textual.md

The **com.groupdocs.editor.htmlcss.resources.textual** namespace provides classes that represent text resources.

#### Classes

| Class | Description |
| --- | --- |
| CssText | Represents one CSS textual resource |
| TextResourceBase | Base class for any supported text resource with text content and encoding |
| TextType | Represents one supportable textual resource type |
| XmlText | Represents one textual resource, which is a XML. |

### CssText
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.textual/csstext.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.textual.TextResourceBase
```
public final class CssText extends TextResourceBase
```

Represents one CSS textual resource
#### Methods

| Method | Description |
| --- | --- |
| getType() | Returns TextType.Css |
##### getType()
```
public TextType getType()
```

Returns TextType.Css

**Returns:**
TextType

### TextResourceBase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.textual/textresourcebase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IHtmlResource
```
public abstract class TextResourceBase implements IHtmlResource
```

Base class for any supported text resource with text content and encoding
#### Constructors

| Constructor | Description |
| --- | --- |
| TextResourceBase(String name, String textualContent, Charset originalEncoding) | Creates new text resource from specified textual content with encoding |
| TextResourceBase(String name, InputStream binaryContent, Charset originalEncoding) | Creates new text resource from specified byte stream and encoding |
#### Fields

| Field | Description |
| --- | --- |
| Disposed |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Returns name of this text resource without file extension |
| getFilenameWithExtension() | Returns correct filename of this text resource, which consists of name and extension |
| getEncoding() | Returns encoding of this textual resource. |
| getByteContent() | Returns content of this text resource as byte stream with original encoding |
| getTextContent() | Returns content of this text resource as a standard string |
| save(String fullPathToFile) | Saves this text resource to the specified file |
| equals(IHtmlResource other) | Checks this instance with specified on equality. |
| dispose() | Disposes this text resource, disposing its content and making most methods and properties non-working. |
| isDisposed() | Determines whether this text resource is disposed or not |
| getType() | In implementing type should return information about type of the text resource |
##### TextResourceBase(String name, String textualContent, Charset originalEncoding)
```
public TextResourceBase(String name, String textualContent, Charset originalEncoding)
```

Creates new text resource from specified textual content with encoding

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Mandatory name of the resource, that serves as its unique identifier. Usually is a file name. |
| textualContent | java.lang.String | Textual content of the resource, cannot be NULL or empty |
| originalEncoding | java.nio.charset.Charset | Original encoding of the resource, cannot be NULL or empty |

##### TextResourceBase(String name, InputStream binaryContent, Charset originalEncoding)
```
public TextResourceBase(String name, InputStream binaryContent, Charset originalEncoding)
```

Creates new text resource from specified byte stream and encoding

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Mandatory name of the resource, that serves as its unique identifier. Usually is a file name. |
| binaryContent | java.io.InputStream | Binary content of a resource as a byte stream. Cannot be NULL, disposed, should be readable and seekable. |
| originalEncoding | java.nio.charset.Charset | Original encoding of the resource, cannot be NULL or empty |

##### Disposed
```
public final Event<EventHandler> Disposed
```

##### getName()
```
public final String getName()
```

Returns name of this text resource without file extension

**Returns:**
java.lang.String
##### getFilenameWithExtension()
```
public final String getFilenameWithExtension()
```

Returns correct filename of this text resource, which consists of name and extension

**Returns:**
java.lang.String
##### getEncoding()
```
public final Charset getEncoding()
```

Returns encoding of this textual resource. Usually returns UTF-8.

**Returns:**
java.nio.charset.Charset -
##### getByteContent()
```
public final InputStream getByteContent()
```

Returns content of this text resource as byte stream with original encoding

**Returns:**
java.io.InputStream -
##### getTextContent()
```
public final String getTextContent()
```

Returns content of this text resource as a standard string

**Returns:**
java.lang.String -
##### save(String fullPathToFile)
```
public final void save(String fullPathToFile)
```

Saves this text resource to the specified file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created or rewritten if already exists |

##### equals(IHtmlResource other)
```
public final boolean equals(IHtmlResource other)
```

Checks this instance with specified on equality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other HTML resource of unknown type, that is also presumable TextResourceBase inheritor |

**Returns:**
boolean - Returns true if are equal, or false if are unequal
##### dispose()
```
public final void dispose()
```

Disposes this text resource, disposing its content and making most methods and properties non-working. Tolerant to multiple calls.

##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this text resource is disposed or not

**Returns:**
boolean -
##### getType()
```
public abstract TextType getType()
```

In implementing type should return information about type of the text resource

**Returns:**
TextType

### TextType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.textual/texttype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IResourceType
```
public class TextType implements IResourceType
```

Represents one supportable textual resource type
#### Constructors

| Constructor | Description |
| --- | --- |
| TextType() |  |
#### Methods

| Method | Description |
| --- | --- |
| getUndefined() | Special value, which marks undefined, unknown or unsupported textual resource |
| getCss() | CSS type of the textual resource |
| getXml() | XML type of the textual resource |
| getFormalName() | Returns a formal name of this textual resource type |
| getFileExtension() | File extension (without leading dot character) of a particular textual resource |
| getMimeCode() | MIME code of a particular textual resource type |
| equals(TextType other) | Determines whether this instance is equal with specified "TextType" instance |
| equals(Object obj) | Determines whether this instance is equal with specified uncasted object, which presumably is another "TextType" instance |
| op_Equality(TextType first, TextType second) | Defines whether two specific "TextType" instances are equal |
| op_Inequality(TextType first, TextType second) | Defines whether two specific "TextType" instances are not equal |
| hashCode() | Returns a hash-code, which is a constant number for this specific value type |
| parseFromFilenameWithExtension(String filename) | Returns TextType value, which is equivalent of filename extension, which is extracted from specified filename with extension or pure extension |
##### TextType()
```
public TextType()
```

##### getUndefined()
```
public static TextType getUndefined()
```

Special value, which marks undefined, unknown or unsupported textual resource

**Returns:**
TextType
##### getCss()
```
public static TextType getCss()
```

CSS type of the textual resource

**Returns:**
TextType
##### getXml()
```
public static TextType getXml()
```

XML type of the textual resource

**Returns:**
TextType
##### getFormalName()
```
public final String getFormalName()
```

Returns a formal name of this textual resource type

**Returns:**
java.lang.String
##### getFileExtension()
```
public final String getFileExtension()
```

File extension (without leading dot character) of a particular textual resource

**Returns:**
java.lang.String
##### getMimeCode()
```
public final String getMimeCode()
```

MIME code of a particular textual resource type

**Returns:**
java.lang.String
##### equals(TextType other)
```
public final boolean equals(TextType other)
```

Determines whether this instance is equal with specified "TextType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TextType | Other TextType instance, that should be compared with this on equality |

**Returns:**
boolean - Returns true if are equal or false if are unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this instance is equal with specified uncasted object, which presumably is another "TextType" instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Other TextType instance, that is boxed to object |

**Returns:**
boolean - Returns true if are equal or false if are unequal
##### op_Equality(TextType first, TextType second)
```
public static boolean op_Equality(TextType first, TextType second)
```

Defines whether two specific "TextType" instances are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextType | First TextType instance |
| second | TextType | Second TextType instance |

**Returns:**
boolean - Returns true if are equal or false if are unequal
##### op_Inequality(TextType first, TextType second)
```
public static boolean op_Inequality(TextType first, TextType second)
```

Defines whether two specific "TextType" instances are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | TextType | First TextType instance |
| second | TextType | Second TextType instance |

**Returns:**
boolean - Returns true if are unequal or false if are equal
##### hashCode()
```
public int hashCode()
```

Returns a hash-code, which is a constant number for this specific value type

**Returns:**
int - Signed 4-byte integer number. Returns 0 if this instance has default value.
##### parseFromFilenameWithExtension(String filename)
```
public static TextType parseFromFilenameWithExtension(String filename)
```

Returns TextType value, which is equivalent of filename extension, which is extracted from specified filename with extension or pure extension

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filename | java.lang.String | Filename with extension, can be relative or absolute path, or pure extension itself |

**Returns:**
TextType - Parsed TextType instance on success or TextType.Undefined on failure

### XmlText
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.textual/xmltext.md

**Inheritance:**
java.lang.Object, com.groupdocs.editor.htmlcss.resources.textual.TextResourceBase
```
public final class XmlText extends TextResourceBase
```

Represents one textual resource, which is a XML.
#### Methods

| Method | Description |
| --- | --- |
| getType() | Returns TextType.Xml |
##### getType()
```
public TextType getType()
```

Returns TextType.Xml

**Returns:**
TextType

### com.groupdocs.editor.htmlcss.resources
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources.md

The **com.groupdocs.editor.htmlcss.resources** namespace provides classes that represent all kinds of the HTML resources.

#### Classes

| Class | Description |
| --- | --- |
| ResourceTypeDetector | Utility static methods for detecting resource types (formats) |

#### Interfaces

| Interface | Description |
| --- | --- |
| IAuxDisposable | Expands the standard IDisposable interface, allows to obtain a current state of an object and subscribe to disposing event |
| IHtmlResource | Represents one instance of the unknown HTML resource (raster or vector image, stylesheet, font, text resource (CSS, XML) etc.) |
| IResourceType | Represents one instance of the unknown resource type/format (image, font, text) |

### IAuxDisposable
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources/iauxdisposable.md

**All Implemented Interfaces:**
com.groupdocs.editor.interfaces.IDisposable
```
public interface IAuxDisposable extends IDisposable
```

Expands the standard IDisposable interface, allows to obtain a current state of an object and subscribe to disposing event
#### Fields

| Field | Description |
| --- | --- |
| Disposed | Occurs when object is disposed |
#### Methods

| Method | Description |
| --- | --- |
| isDisposed() | Determines whether a resource is closed (true) or not (false |
##### Disposed
```
public static final Event<EventHandler> Disposed
```

Occurs when object is disposed

##### isDisposed()
```
public abstract boolean isDisposed()
```

Determines whether a resource is closed (true) or not (false

**Returns:**
boolean

### IHtmlResource
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources/ihtmlresource.md

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IAuxDisposable
```
public interface IHtmlResource extends IAuxDisposable
```

Represents one instance of the unknown HTML resource (raster or vector image, stylesheet, font, text resource (CSS, XML) etc.)
#### Methods

| Method | Description |
| --- | --- |
| getName() | Name of the HTML resource |
| getFilenameWithExtension() | Correct filename of the specified resource with appropriate file extension |
| getType() | Type of the HTML resource |
| getByteContent() | Content of the HTML resource in a form of a byte stream |
| getTextContent() | Content of the HTML resource in a form of a base64-encoded text string for binary resources or a simple text for textual resources |
| save(String fullPathToFile) | Saves a current resource to the specified file |
##### getName()
```
public abstract String getName()
```

Name of the HTML resource

**Returns:**
java.lang.String -
##### getFilenameWithExtension()
```
public abstract String getFilenameWithExtension()
```

Correct filename of the specified resource with appropriate file extension

**Returns:**
java.lang.String -
##### getType()
```
public abstract IResourceType getType()
```

Type of the HTML resource

**Returns:**
IResourceType -
##### getByteContent()
```
public abstract InputStream getByteContent()
```

Content of the HTML resource in a form of a byte stream

**Returns:**
java.io.InputStream
##### getTextContent()
```
public abstract String getTextContent()
```

Content of the HTML resource in a form of a base64-encoded text string for binary resources or a simple text for textual resources

**Returns:**
java.lang.String
##### save(String fullPathToFile)
```
public abstract void save(String fullPathToFile)
```

Saves a current resource to the specified file

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | java.lang.String | Full path to the file, which will be created or rewritten with the content of a current resource |

### IResourceType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources/iresourcetype.md

### ResourceTypeDetector
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.resources/resourcetypedetector.md

**Inheritance:**
java.lang.Object
```
public class ResourceTypeDetector
```

Utility static methods for detecting resource types (formats)
#### Constructors

| Constructor | Description |
| --- | --- |
| ResourceTypeDetector() |  |
#### Methods

| Method | Description |
| --- | --- |
| detectTypeFromFilename(String filename) | Detects a type from specified filename and returns an instance of respective IResourceType |
| tryDetectResource(InputStream inputResourceStream, String name, IResourceType assumptiveFormat) | Tries to analyze an input stream and creates one of supportable HTML resources from it, taking into account a specified assumptive type, if it is not null |
##### ResourceTypeDetector()
```
public ResourceTypeDetector()
```

##### detectTypeFromFilename(String filename)
```
public static IResourceType detectTypeFromFilename(String filename)
```

Detects a type from specified filename and returns an instance of respective IResourceType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filename | java.lang.String | Input filename, from which this method will try to extract the resultant IResourceType implementation |

**Returns:**
IResourceType - IResourceType implementation on success or NULL on failure
##### tryDetectResource(InputStream inputResourceStream, String name, IResourceType assumptiveFormat)
```
public static IHtmlResource tryDetectResource(InputStream inputResourceStream, String name, IResourceType assumptiveFormat)
```

Tries to analyze an input stream and creates one of supportable HTML resources from it, taking into account a specified assumptive type, if it is not null

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputResourceStream | java.io.InputStream | Input stream, which presumably contains an HTML resource. If invalid, an exception will be thrown. |
| name | java.lang.String | Resource name, which will be used for created and returned resource on success. Cannot be NULL, empty or whitespace |
| assumptiveFormat | IResourceType | Assumed format of the input HTML resource, which is useful for achieving the best performance. If completely unknown, use the NULL value. May be incorrect, this will only worsen the performance. |

**Returns:**
IHtmlResource - Instance, which implements 'IHtmlResource' interface and represents one of supportable HTML resources on success, or NULL on failure

### com.groupdocs.editor.htmlcss.serialization
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.serialization.md

The **com.groupdocs.editor.htmlcss.serialization** namespace provides types, that are responsible for tuning HTML and CSS markup serialization process..

#### Classes

| Class | Description |
| --- | --- |
| QuoteType | Represents quote characters - single quote (') and double quote (") |
| TagRenderingCase | Represents different types of serialization the HTML tag names |

### QuoteType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.serialization/quotetype.md

**Inheritance:**
java.lang.Object
```
public class QuoteType
```

Represents quote characters - single quote (') and double quote (")
#### Constructors

| Constructor | Description |
| --- | --- |
| QuoteType() |  |
#### Fields

| Field | Description |
| --- | --- |
| SingleQuote | Single quote (U+0027 APOSTROPHE character) |
| DoubleQuote | Double quote (U+0022 QUOTATION MARK character) |
#### Methods

| Method | Description |
| --- | --- |
| getCode() | Code point of the current character (U+0027 or U+0022) |
| getCharacter() | Character to enquote |
| getHtmlEncoded() | HTML-encoded character |
| toString() | Returns a "SingleQuote" or "DoubleQuote" string depending on the current value |
| equals(QuoteType other) | Indicates whether this instance of the quote type is equal to specified |
| equals(Object obj) | Indicates whether this instance of the quote type is equal to specified uncasted |
| hashCode() | Returns a hash-code for this character |
| op_Equality(QuoteType first, QuoteType second) | Checks whether two "QuoteType" values are equal |
| op_Inequality(QuoteType first, QuoteType second) | Checks whether two "QuoteType" values are not equal |
| to_Char(QuoteType quote) | Casts specified QuoteType instance to the char |
| to_QuoteType(char character) | Casts specific char to the corresponding QuoteType, throws exception if casting is invalid |
##### QuoteType()
```
public QuoteType()
```

##### SingleQuote
```
public static final QuoteType SingleQuote
```

Single quote (U+0027 APOSTROPHE character)

##### DoubleQuote
```
public static final QuoteType DoubleQuote
```

Double quote (U+0022 QUOTATION MARK character)

##### getCode()
```
public final int getCode()
```

Code point of the current character (U+0027 or U+0022)

**Returns:**
int
##### getCharacter()
```
public final char getCharacter()
```

Character to enquote

**Returns:**
char
##### getHtmlEncoded()
```
public final String getHtmlEncoded()
```

HTML-encoded character

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Returns a "SingleQuote" or "DoubleQuote" string depending on the current value

**Returns:**
java.lang.String -
##### equals(QuoteType other)
```
public final boolean equals(QuoteType other)
```

Indicates whether this instance of the quote type is equal to specified

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | QuoteType | Other instance of QuoteType to check |

**Returns:**
boolean - true if are equal, false if are unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether this instance of the quote type is equal to specified uncasted

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Uncasted object, expected to be of QuoteType type |

**Returns:**
boolean - true if are equal, false if are unequal
##### hashCode()
```
public int hashCode()
```

Returns a hash-code for this character

**Returns:**
int - Hash-code as an signed integer
##### op_Equality(QuoteType first, QuoteType second)
```
public static boolean op_Equality(QuoteType first, QuoteType second)
```

Checks whether two "QuoteType" values are equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | QuoteType | First value to check |
| second | QuoteType | Second value to check |

**Returns:**
boolean - true if are equal, false otherwise
##### op_Inequality(QuoteType first, QuoteType second)
```
public static boolean op_Inequality(QuoteType first, QuoteType second)
```

Checks whether two "QuoteType" values are not equal

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | QuoteType | First value to check |
| second | QuoteType | Second value to check |

**Returns:**
boolean - false if are equal, true otherwise
##### to_Char(QuoteType quote)
```
public static char to_Char(QuoteType quote)
```

Casts specified QuoteType instance to the char

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| quote | QuoteType | Quote type instance to cast |

**Returns:**
char
##### to_QuoteType(char character)
```
public static QuoteType to_QuoteType(char character)
```

Casts specific char to the corresponding QuoteType, throws exception if casting is invalid

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | A single quote (U+0027 APOSTROPHE) or double quote (U+0022 QUOTATION MARK) character. Exception will be thrown if any other character will be specified. |

**Returns:**
QuoteType

### TagRenderingCase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.htmlcss.serialization/tagrenderingcase.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
```
public final class TagRenderingCase extends System.Enum
```

Represents different types of serialization the HTML tag names
#### Fields

| Field | Description |
| --- | --- |
| LowerCase | all-lower - all letters in the tag name will be serialized in lower case |
| UpperCase | ALL-CAPITAL - all letters in the tag name will be serialized in UPPER case |
| FirstLetterUpperCase | First letter in the tag name will be serialized in Upper case, while all others - in lower. |
##### LowerCase
```
public static final int LowerCase
```

all-lower - all letters in the tag name will be serialized in lower case

##### UpperCase
```
public static final int UpperCase
```

ALL-CAPITAL - all letters in the tag name will be serialized in UPPER case

##### FirstLetterUpperCase
```
public static final int FirstLetterUpperCase
```

First letter in the tag name will be serialized in Upper case, while all others - in lower.

### com.groupdocs.editor.license
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.license.md

The **com.groupdocs.editor.license** Provides methods to license the component. Learn more about licensing [here][]

[here]: https://purchase.groupdocs.com/faqs/licensing

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |
| Metered | Provides methods for applying [Metered][] license.[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered |

### License
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.license/license.md

**Inheritance:**
java.lang.Object
```
public class License
```

Provides methods to license the component. Learn more about licensing [here][].

[here]: https://purchase.groupdocs.com/faqs/licensing
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/editor/java/licensing-and-subscription/
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(InputStream licenseStream) | Licenses the component. |
| setLicense(String licensePath) | Licenses the component. |
##### License()
```
public License()
```

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Licenses the component.

> ```
> The following example demonstrates how to set a license
>  passing Stream of the license file.
>
>  using (InputStream licenseStream = new FileInputStream("LicenseFile.lic"))
>  {
>      com.groupdocs.editor.License lic = new com.groupdocs.editor.License();
>      lic.setLicense(licenseStream);
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream. |

##### setLicense(String licensePath)
```
public final void setLicense(String licensePath)
```

Licenses the component.

> ```
> The following example demonstrates how to set a license
>  passing a path to the license file.
>
>  String licensePath = "GroupDocs.Editor.lic";
>  com.groupdocs.editor.License lic = new com.groupdocs.editor.License();
>  lic.setLicense(licensePath);
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path. |

### Metered
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.license/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying [Metered][] license.

[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered
[GroupDocs Licensing FAQ]: https://purchase.groupdocs.com/faqs/licensing
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/editor/java/licensing-and-subscription/
#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() |  |
#### Methods

| Method | Description |
| --- | --- |
| setMeteredKey(String publicKey, String privateKey) | Activates product with Metered keys. |
| getConsumptionQuantity() | Retrieves amount of MBs processed. |
| getConsumptionCredit() | Retrieves count of credits consumed. |
##### Metered()
```
public Metered()
```

##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Activates product with Metered keys.

> ```
> Following example demonstrates how to activate product with Metered keys.
>
>  String publicKey = "Public Key";
>  String privateKey = "Private Key";
>  Metered metered = new Metered();
>  metered.setMeteredKey(publicKey, privateKey);
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | The public key. |
| privateKey | java.lang.String | The private key. |

##### getConsumptionQuantity()
```
public static BigDecimal getConsumptionQuantity()
```

Retrieves amount of MBs processed.

> ```
> Following example demonstrates how to retrieve amount of MBs processed.
>
>   String publicKey = "Public Key";
>   String privateKey = "Private Key";
>
>   Metered metered = new Metered();
>   metered.setMeteredKey(publicKey, privateKey);
>   double mbProcessed = metered.getConsumptionQuantity();
> ```

**Returns:**
java.math.BigDecimal
##### getConsumptionCredit()
```
public static BigDecimal getConsumptionCredit()
```

Retrieves count of credits consumed.

> ```
> Following example demonstrates how to retrieve count of credits consumed.
>
>   String publicKey = "Public Key";
>   String privateKey = "Private Key";
>
>   Metered metered = new Metered();
>   metered.setMeteredKey(publicKey, privateKey);
>   double creditsConsumed = metered.getConsumptionCredit();
> ```

**Returns:**
java.math.BigDecimal - Count of already used credits

### com.groupdocs.editor.metadata
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata.md

The **com.groupdocs.editor.metadata** namespace provides classes for describing basic document properties dependent on document type.

#### Classes

| Class | Description |
| --- | --- |
| EbookDocumentInfo | Represents metadata of one EBook document |
| EmailDocumentInfo | Represents metadata of one email document of any supported email format |
| FixedLayoutDocumentInfo | Represents metadata of one document with fixed layout format like PDF or XPS |
| MarkdownDocumentInfo | Represents metadata of one Markdown document |
| PresentationDocumentInfo | Represents metadata of one Presentation document |
| SpreadsheetDocumentInfo | Represents metadata of one Spreadsheet document |
| TextualDocumentInfo | Represents metadata of one textual document like XML, HTML or plain text (TXT) |
| WordProcessingDocumentInfo | Represents metadata of one WordProcessing document |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Common interface for all file metadata wrappers |

### EbookDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/ebookdocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class EbookDocumentInfo implements IDocumentInfo
```

Represents metadata of one EBook document
#### Constructors

| Constructor | Description |
| --- | --- |
| EbookDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this document |
| getPageCount() | Returns number of pages in case of MOBI or AZW3 or number of chapters in case of ePub. |
| getSize() | Returns size in bytes of this eBook document |
| isEncrypted() | Because eBook documents cannot be encrypted with password, this property always returns 'false' |
| equals(EbookDocumentInfo other) | Determines whether this instance is equal to the other specified EbookDocumentInfo instance |
##### EbookDocumentInfo()
```
public EbookDocumentInfo()
```

##### getFormat()
```
public final DocumentFormatBase getFormat()
```

Returns a format of this document

**Returns:**
DocumentFormatBase
##### getPageCount()
```
public final int getPageCount()
```

Returns number of pages in case of MOBI or AZW3 or number of chapters in case of ePub.

eBook documents usually have no fixed pages and thus page count. In case of ePub it is possible to calculate a number of chapters. However, the MOBI and AZW3 formats have no chapters either, so this number is calculated from standard page size set to A4 in portrait orientation.

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this eBook document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Because eBook documents cannot be encrypted with password, this property always returns 'false'

**Returns:**
boolean
##### equals(EbookDocumentInfo other)
```
public final boolean equals(EbookDocumentInfo other)
```

Determines whether this instance is equal to the other specified EbookDocumentInfo instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | EbookDocumentInfo | Other EbookDocumentInfo instance, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal

### EmailDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/emaildocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class EmailDocumentInfo implements IDocumentInfo
```

Represents metadata of one email document of any supported email format
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this email document |
| getPageCount() | Always returs 1, because email documents don't have paged view |
| getSize() | Returns size in bytes of this email document |
| isEncrypted() | Because email documents cannot be encrypted with password, this property always returns 'false' |
| equals(EmailDocumentInfo other) | Determines whether this instance is equal to the other specified EmailDocumentInfo instance |
##### EmailDocumentInfo()
```
public EmailDocumentInfo()
```

##### getFormat()
```
public final DocumentFormatBase getFormat()
```

Returns a format of this email document

**Returns:**
DocumentFormatBase
##### getPageCount()
```
public final int getPageCount()
```

Always returs 1, because email documents don't have paged view

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this email document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Because email documents cannot be encrypted with password, this property always returns 'false'

**Returns:**
boolean
##### equals(EmailDocumentInfo other)
```
public final boolean equals(EmailDocumentInfo other)
```

Determines whether this instance is equal to the other specified EmailDocumentInfo instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | EmailDocumentInfo | Other EmailDocumentInfo instance, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal

### FixedLayoutDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/fixedlayoutdocumentinfo.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.lang.Struct

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class FixedLayoutDocumentInfo extends Struct<FixedLayoutDocumentInfo> implements IDocumentInfo
```

Represents metadata of one document with fixed layout format like PDF or XPS
#### Constructors

| Constructor | Description |
| --- | --- |
| FixedLayoutDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this fixed-layout format document |
| getPageCount() | Returns number of pages |
| getSize() | Returns size in bytes of this fixed-layout format document |
| isEncrypted() | Determines whether this specific fixed-layout format document in encrypted and requires password for opening |
| equals(FixedLayoutDocumentInfo other) | Determines whether this instance is equal to the other specified FixedLayoutDocumentInfo instance |
##### FixedLayoutDocumentInfo()
```
public FixedLayoutDocumentInfo()
```

##### getFormat()
```
public final DocumentFormatBase getFormat()
```

Returns a format of this fixed-layout format document

**Returns:**
DocumentFormatBase
##### getPageCount()
```
public final int getPageCount()
```

Returns number of pages

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this fixed-layout format document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Determines whether this specific fixed-layout format document in encrypted and requires password for opening

**Returns:**
boolean
##### equals(FixedLayoutDocumentInfo other)
```
public final boolean equals(FixedLayoutDocumentInfo other)
```

Determines whether this instance is equal to the other specified FixedLayoutDocumentInfo instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FixedLayoutDocumentInfo | Other FixedLayoutDocumentInfo instance, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal

### IDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/idocumentinfo.md

### MarkdownDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/markdowndocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class MarkdownDocumentInfo implements IDocumentInfo
```

Represents metadata of one Markdown document
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this Markdown document \\u2014 always is TextualFormats.Md |
| getPageCount() | Returns number of pages. |
| getSize() | Returns size in bytes of this Markdown document |
| isEncrypted() | Because Markdown documents cannot be encrypted with password, this property always returns 'false' |
| equals(MarkdownDocumentInfo other) | Determines whether this instance is equal to the other specified MarkdownDocumentInfo instance. |
##### getFormat()
```
public final DocumentFormatBase getFormat()
```

Returns a format of this Markdown document \\u2014 always is TextualFormats.Md

**Returns:**
DocumentFormatBase
##### getPageCount()
```
public final int getPageCount()
```

Returns number of pages. Markdown documents usually have no fixed pages and thus page count, so this number is calculated from standard page size set to A4 in portrait orientation.

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this Markdown document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Because Markdown documents cannot be encrypted with password, this property always returns 'false'

**Returns:**
boolean
##### equals(MarkdownDocumentInfo other)
```
public final boolean equals(MarkdownDocumentInfo other)
```

Determines whether this instance is equal to the other specified MarkdownDocumentInfo instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | MarkdownDocumentInfo | Other MarkdownDocumentInfo instance, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal

### PresentationDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/presentationdocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class PresentationDocumentInfo implements IDocumentInfo
```

Represents metadata of one Presentation document
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this Presentation document |
| getPageCount() | Returns number of slides in this Presentation document |
| getSize() | Returns size in bytes of this Presentation document |
| isEncrypted() | Indicates whether this specific Presentation document in encrypted and requires password for opening |
| generatePreview(int slideIndex) | Generates and returns a preview of the selected slide in a form of SVG image |
##### getFormat()
```
public final PresentationFormats getFormat()
```

Returns a format of this Presentation document

**Returns:**
PresentationFormats
##### getPageCount()
```
public final int getPageCount()
```

Returns number of slides in this Presentation document

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this Presentation document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Indicates whether this specific Presentation document in encrypted and requires password for opening

**Returns:**
boolean
##### generatePreview(int slideIndex)
```
public final SvgImage generatePreview(int slideIndex)
```

Generates and returns a preview of the selected slide in a form of SVG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| slideIndex | int | 0-based index of the desired slide. Canot be lesser then 0, cannot exceed the number of slides in this presentation. |

**Returns:**
SvgImage - SVG image as the non-null instance of the SvgImage class

### SpreadsheetDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/spreadsheetdocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class SpreadsheetDocumentInfo implements IDocumentInfo
```

Represents metadata of one Spreadsheet document
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this Spreadsheet document |
| getPageCount() | Returns number of tabs |
| getSize() | Returns size in bytes of this Spreadsheet document |
| isEncrypted() | Indicates whether this specific Spreadsheet document in encrypted and requires password for opening |
| generatePreview(int worksheetIndex) | Generates and returns a preview of the selected worksheet in a form of SVG image |
| equals(SpreadsheetDocumentInfo other) | Determines whether this instance is equal to the other specified SpreadsheetDocumentInfo instance |
##### SpreadsheetDocumentInfo()
```
public SpreadsheetDocumentInfo()
```

##### getFormat()
```
public final SpreadsheetFormats getFormat()
```

Returns a format of this Spreadsheet document

**Returns:**
SpreadsheetFormats
##### getPageCount()
```
public final int getPageCount()
```

Returns number of tabs

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this Spreadsheet document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Indicates whether this specific Spreadsheet document in encrypted and requires password for opening

**Returns:**
boolean
##### generatePreview(int worksheetIndex)
```
public final SvgImage generatePreview(int worksheetIndex)
```

Generates and returns a preview of the selected worksheet in a form of SVG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | int | 0-based index of the desired worksheet. Cannot be lesser then 0, cannot exceed the number of worksheets in this spreadsheet. |

**Returns:**
SvgImage - SVG image as the non-null instance of the SvgImage class
##### equals(SpreadsheetDocumentInfo other)
```
public final boolean equals(SpreadsheetDocumentInfo other)
```

Determines whether this instance is equal to the other specified SpreadsheetDocumentInfo instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | SpreadsheetDocumentInfo | Other SpreadsheetDocumentInfo instance, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal

### TextualDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/textualdocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class TextualDocumentInfo implements IDocumentInfo
```

Represents metadata of one textual document like XML, HTML or plain text (TXT)
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this textual document. |
| getPageCount() | Always returns 1 |
| getSize() | Returns size in bytes (not the number of characters) of this textual document |
| isEncrypted() | Always returns 'false', as textual documents cannot be encrypted. |
| getEncoding() | Returns detected presumable encoding of the text document |
##### getFormat()
```
public final TextualFormats getFormat()
```

Returns a format of this textual document. May be not 100% correct in some cases.

**Returns:**
TextualFormats
##### getPageCount()
```
public final int getPageCount()
```

Always returns 1

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes (not the number of characters) of this textual document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Always returns 'false', as textual documents cannot be encrypted.

**Returns:**
boolean
##### getEncoding()
```
public final Charset getEncoding()
```

Returns detected presumable encoding of the text document

**Returns:**
java.nio.charset.Charset

### WordProcessingDocumentInfo
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.metadata/wordprocessingdocumentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.metadata.IDocumentInfo
```
public class WordProcessingDocumentInfo implements IDocumentInfo
```

Represents metadata of one WordProcessing document
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Returns a format of this WordProcessing document |
| getPageCount() | Returns number of pages |
| getSize() | Returns size in bytes of this WordProcessing document |
| isEncrypted() | Determines whether this specific WordProcessing document in encrypted and requires password for opening |
| generatePreview(int pageIndex) | Generates and returns a preview of the selected page in a form of SVG image |
| equals(WordProcessingDocumentInfo other) | Determines whether this instance is equal to the other specified WordProcessingDocumentInfo instance |
##### WordProcessingDocumentInfo()
```
public WordProcessingDocumentInfo()
```

##### getFormat()
```
public final WordProcessingFormats getFormat()
```

Returns a format of this WordProcessing document

**Returns:**
WordProcessingFormats
##### getPageCount()
```
public final int getPageCount()
```

Returns number of pages

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Returns size in bytes of this WordProcessing document

**Returns:**
long
##### isEncrypted()
```
public final boolean isEncrypted()
```

Determines whether this specific WordProcessing document in encrypted and requires password for opening

**Returns:**
boolean
##### generatePreview(int pageIndex)
```
public final SvgImage generatePreview(int pageIndex)
```

Generates and returns a preview of the selected page in a form of SVG image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | 0-based index of the desired page. Cannot be lesser then 0, cannot exceed the number of pages in this WordProcessing document. |

**Returns:**
SvgImage - SVG image as the non-null instance of the SvgImage class
##### equals(WordProcessingDocumentInfo other)
```
public final boolean equals(WordProcessingDocumentInfo other)
```

Determines whether this instance is equal to the other specified WordProcessingDocumentInfo instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | WordProcessingDocumentInfo | Other WordProcessingDocumentInfo instance, that should be checked on equality with this |

**Returns:**
boolean - True if are equal, false if are unequal

### com.groupdocs.editor.options
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options.md

The **com.groupdocs.editor.options** namespace provides interfaces for load and save options.

#### Classes

| Class | Description |
| --- | --- |
| DelimitedTextEditOptions | Options for loading text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter) |
| DelimitedTextSaveOptions | Contains options for generating and saving text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter) |
| EbookEditOptions | Allows to specify and adjust custom options for editing E-book documents in all supported formats: ePub, MOBI, and AZW3. |
| EbookSaveOptions | Allows to specify custom options for generating and saving the document in all supportable e-Book formats: ePub, MOBI, and AZW3. |
| EmailEditOptions | Allows to specify custom options for editing documents in the different electronic mail (email) formats |
| EmailSaveOptions | Allows to specify custom options for generating and saving electronic mail (email) documents |
| FixedLayoutEditOptionsBase | Base abstract class for the options for all documents of fixed-layout formats like PDF and XPS |
| FontEmbeddingOptions | Font embedding options control which font resources should be embedded into the output WordProcessing document |
| FontExtractionOptions | Font extraction options control which fonts should be extracted and from where |
| HtmlSaveOptions | Allows to specify custom options for saving the EditableDocument instance to the HTML format |
| MailMessageOutput | Controls which parts of the mail message should be delivered to the output processing |
| MarkdownEditOptions | Allows to specify custom options for editing documents in Markdown format. |
| MarkdownImageLoadArgs | Provides data for the  M:GroupDocs.Editor.Options.IMarkdownImageLoadCallback.ProcessImage(MarkdownImageLoadArgs)  event. |
| MarkdownImageLoadingAction | Defines the mode of image loading while opening for editing the file in Markdown format |
| MarkdownSaveOptions | Allows to specify custom options for generating and saving Markdown documents |
| MarkdownTableContentAlignment | Allows to specify the alignment of the content of the table to be used when exporting into Markdown format. |
| MhtmlSaveOptions | Allows to specify custom options for generating and saving the MHTML (MIME encapsulation of aggregate HTML documents) documents |
| PageRange | Encapsulates one page range, which can have open or closed bounds. |
| PdfCompliance | Specifies the PDF standards compliance level |
| PdfSaveOptions | Allows to specify custom options for generating and saving PDF (Portable Document Format) documents |
| PresentationEditOptions | Allows to specify custom options for editing documents of all supportable Presentation (PowerPoint-compatible) formats |
| PresentationLoadOptions | Allows to specify custom options for loading documents of all supportable Presentation formats like PPT(X), PPTM, PPS(X) etc. |
| PresentationSaveOptions | Allows to specify custom options for generating and saving Presentation (PowerPoint-compatible) documents |
| SpreadsheetEditOptions | Allows to specify custom options for editing documents of all supportable Spreadsheet (Excel-compatible) formats |
| SpreadsheetLoadOptions | Contains options for loading binary Spreadsheet (Cells, Excel-compatible) documents like XLS(X), ODS etc. |
| SpreadsheetSaveOptions | Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents |
| TextDirection | Represents 3 possible variants how to treat text direction in the plain text documents |
| TextEditOptions | Allows to specify custom options for loading plain text (TXT) documents |
| TextLeadingSpacesOptions | Contains available options for leading space handling during opening plain text document (TXT) |
| TextSaveOptions | Allows to specify custom options for generating and saving plain text (TXT) documents |
| TextTrailingSpacesOptions | Contains available options for trailing space handling during opening plain text document (TXT) |
| WebFont | Represents a font settings for the web |
| WordProcessingEditOptions | Allows to specify custom options for editing documents of all supportable WordProcessing (Words-compliant) formats like DOC(X), RTF, ODT etc. |
| WordProcessingLoadOptions | Contains options for loading WordProcessing (Word-compatible) documents like DOC(X), RTF, ODT etc. |
| WordProcessingProtection | Encapsulates document protection options for the WordProcessing document, which is generated from HTML |
| WordProcessingProtectionType | Represents all available protection types of the WordProcessing document |
| WordProcessingSaveOptions | Allows to specify custom options for generating and saving WordProcessing-compliant documents after they were edited |
| WorksheetProtection | Encapsulates worksheet protection options, which allow to protect a worksheet in the output Spreadsheet document from modification of specified type with a specified password. |
| WorksheetProtectionType | Represents Spreadsheet worksheet (tab) protection types |
| XmlEditOptions | Allows to specify custom options for loading XML (eXtensible Markup Language) documents and converting them to the HTML |
| XmlFormatOptions | Contains options, that allow to adjust the formatting of XML document, when it is represented as HTML |
| XmlHighlightOptions | Contains options, that allow to customize the XML highlighting during XML-to-HTML conversion |
| XpsSaveOptions | Allows to specify custom options for generating and saving XPS (XML Paper Specifications) documents |

#### Interfaces

| Interface | Description |
| --- | --- |
| IEditOptions | Common interface for all options, which are responsible for document-to-HTML conversions. |
| IHtmlSavingCallback | Interface, that is used while saving the to the HTML format and which must be implemented by the end-user in order to save the provided resource and returns a link to it |
| ILoadOptions | Common interface for all option classes, responsible for loading documents of different type formats |
| IMarkdownImageLoadCallback | Implement this interface if you want to control how GroupDocs.Editor load images when converting Markdown to Html. |
| ISaveOptions | Interface for all saving options for all documents types |

### DelimitedTextEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/delimitedtexteditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public final class DelimitedTextEditOptions implements IEditOptions
```

Options for loading text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)

https://en.wikipedia.org/wiki/Delimiter-separated\_values
#### Constructors

| Constructor | Description |
| --- | --- |
| DelimitedTextEditOptions(String separator) | Creates an instance of options class for delimited text with mandatory separator (delimiter) |
#### Methods

| Method | Description |
| --- | --- |
| getSeparator() | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| setSeparator(String value) | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| getConvertDateTimeData() | Gets or sets a value that indicates whether the string in text-based document is converted to the date data. |
| setConvertDateTimeData(boolean value) | Gets or sets a value that indicates whether the string in text-based document is converted to the date data. |
| getConvertNumericData() | Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. |
| setConvertNumericData(boolean value) | Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. |
| getTreatConsecutiveDelimitersAsOne() | Defines whether consecutive delimiters should be treated as one. |
| setTreatConsecutiveDelimitersAsOne(boolean value) | Defines whether consecutive delimiters should be treated as one. |
| getOptimizeMemoryUsage() | Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. |
| setOptimizeMemoryUsage(boolean value) | Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. |
##### DelimitedTextEditOptions(String separator)
```
public DelimitedTextEditOptions(String separator)
```

Creates an instance of options class for delimited text with mandatory separator (delimiter)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| separator | java.lang.String | Mandatory separator (delimiter), that cannot be NULL or empty |

##### getSeparator()
```
public final String getSeparator()
```

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

**Returns:**
java.lang.String
##### setSeparator(String value)
```
public final void setSeparator(String value)
```

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getConvertDateTimeData()
```
public final boolean getConvertDateTimeData()
```

Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is false.

**Returns:**
boolean
##### setConvertDateTimeData(boolean value)
```
public final void setConvertDateTimeData(boolean value)
```

Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getConvertNumericData()
```
public final boolean getConvertNumericData()
```

Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is false.

**Returns:**
boolean
##### setConvertNumericData(boolean value)
```
public final void setConvertNumericData(boolean value)
```

Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTreatConsecutiveDelimitersAsOne()
```
public final boolean getTreatConsecutiveDelimitersAsOne()
```

Defines whether consecutive delimiters should be treated as one. By default is false.

**Returns:**
boolean
##### setTreatConsecutiveDelimitersAsOne(boolean value)
```
public final void setTreatConsecutiveDelimitersAsOne(boolean value)
```

Defines whether consecutive delimiters should be treated as one. By default is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOptimizeMemoryUsage()
```
public final boolean getOptimizeMemoryUsage()
```

Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

**Returns:**
boolean
##### setOptimizeMemoryUsage(boolean value)
```
public final void setOptimizeMemoryUsage(boolean value)
```

Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### DelimitedTextSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/delimitedtextsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class DelimitedTextSaveOptions implements ISaveOptions
```

Contains options for generating and saving text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)

https://en.wikipedia.org/wiki/Delimiter-separated\_values
#### Constructors

| Constructor | Description |
| --- | --- |
| DelimitedTextSaveOptions() | This parameterless constructor creates a new instance of DelimitedTextSaveOptions with a semicolon (;) default separator (can be modified then through  Separator (\#getSeparator.getSeparator/\#setSeparator(String).setSeparator(String)) property) |
| DelimitedTextSaveOptions(String separator) | Creates an instance of options class for delimited text with mandatory separator (delimiter) |
#### Methods

| Method | Description |
| --- | --- |
| getSeparator() | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| setSeparator(String value) | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| getEncoding() | Allows to set an encoding for the text-based Spreadsheet document. |
| setEncoding(Charset value) | Allows to set an encoding for the text-based Spreadsheet document. |
| getTrimLeadingBlankRowAndColumn() | Indicates whether leading blank rows and columns should be trimmed like what MS Excel does |
| setTrimLeadingBlankRowAndColumn(boolean value) | Indicates whether leading blank rows and columns should be trimmed like what MS Excel does |
| getKeepSeparatorsForBlankRow() | Indicates whether separators should be output for blank row. |
| setKeepSeparatorsForBlankRow(boolean value) | Indicates whether separators should be output for blank row. |
##### DelimitedTextSaveOptions()
```
public DelimitedTextSaveOptions()
```

This parameterless constructor creates a new instance of DelimitedTextSaveOptions with a semicolon (;) default separator (can be modified then through  Separator (\#getSeparator.getSeparator/\#setSeparator(String).setSeparator(String)) property)

##### DelimitedTextSaveOptions(String separator)
```
public DelimitedTextSaveOptions(String separator)
```

Creates an instance of options class for delimited text with mandatory separator (delimiter)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| separator | java.lang.String | String separator (delimiter) for text-based Spreadsheet documents |

##### getSeparator()
```
public final String getSeparator()
```

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

**Returns:**
java.lang.String -
##### setSeparator(String value)
```
public final void setSeparator(String value)
```

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEncoding()
```
public final Charset getEncoding()
```

Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF8.

**Returns:**
java.nio.charset.Charset -
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF8.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### getTrimLeadingBlankRowAndColumn()
```
public final boolean getTrimLeadingBlankRowAndColumn()
```

Indicates whether leading blank rows and columns should be trimmed like what MS Excel does

**Returns:**
boolean -
##### setTrimLeadingBlankRowAndColumn(boolean value)
```
public final void setTrimLeadingBlankRowAndColumn(boolean value)
```

Indicates whether leading blank rows and columns should be trimmed like what MS Excel does

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getKeepSeparatorsForBlankRow()
```
public final boolean getKeepSeparatorsForBlankRow()
```

Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.

**Returns:**
boolean -
##### setKeepSeparatorsForBlankRow(boolean value)
```
public final void setKeepSeparatorsForBlankRow(boolean value)
```

Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### EbookEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/ebookeditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public final class EbookEditOptions implements IEditOptions
```

Allows to specify and adjust custom options for editing E-book documents in all supported formats: ePub, MOBI, and AZW3.

Supported E-book formats:

1.  [ePub][] (Electronic Publication)
2.  [MOBI][] (MobiPocket)
3.  [AZW3][] (Kindle Format 8t)

[ePub]: https://docs.fileformat.com/ebook/epub/
[MOBI]: https://docs.fileformat.com/ebook/mobi/
[AZW3]: https://docs.fileformat.com/ebook/azw3/
#### Constructors

| Constructor | Description |
| --- | --- |
| EbookEditOptions() | Initializes a new instance of the EbookEditOptions class, where all options are set to their default values |
| EbookEditOptions(boolean enablePagination) | Initializes a new instance of the EbookEditOptions class with specified pagination mode |
#### Methods

| Method | Description |
| --- | --- |
| getEnablePagination() | Allows to enable or disable pagination in the resultant HTML document. |
| setEnablePagination(boolean value) | Allows to enable or disable pagination in the resultant HTML document. |
| getEnableLanguageInformation() | Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. |
| setEnableLanguageInformation(boolean value) | Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. |
##### EbookEditOptions()
```
public EbookEditOptions()
```

Initializes a new instance of the EbookEditOptions class, where all options are set to their default values

##### EbookEditOptions(boolean enablePagination)
```
public EbookEditOptions(boolean enablePagination)
```

Initializes a new instance of the EbookEditOptions class with specified pagination mode

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enablePagination | boolean | Enables ( true ) or disables ( false ) pagination of the e-book content in the resultant HTML document. By default is disabled ( false ). |

##### getEnablePagination()
```
public final boolean getEnablePagination()
```

Allows to enable or disable pagination in the resultant HTML document. By default is disabled ( false ).

In its essence most of e-book formats internally is a flow format like Office Open XML, where content is a solid and is splitted onto chapters but not the pages. However, it contains some page-specific info like the page numbers, footnotes, heraders/footers and so on. Some e-book readers perform a splitting of the e-book content onto pages, while others (especially mobile) \\u2014 not. This option allows to control how the e-book content should be represented in HTML/CSS while editing \\u2014 in the float ( false ) or paged ( true ) view.

**Returns:**
boolean
##### setEnablePagination(boolean value)
```
public final void setEnablePagination(boolean value)
```

Allows to enable or disable pagination in the resultant HTML document. By default is disabled ( false ).

In its essence most of e-book formats internally is a flow format like Office Open XML, where content is a solid and is splitted onto chapters but not the pages. However, it contains some page-specific info like the page numbers, footnotes, heraders/footers and so on. Some e-book readers perform a splitting of the e-book content onto pages, while others (especially mobile) \\u2014 not. This option allows to control how the e-book content should be represented in HTML/CSS while editing \\u2014 in the float ( false ) or paged ( true ) view.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEnableLanguageInformation()
```
public final boolean getEnableLanguageInformation()
```

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled ( false ).

**Returns:**
boolean
##### setEnableLanguageInformation(boolean value)
```
public final void setEnableLanguageInformation(boolean value)
```

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled ( false ).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### EbookSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/ebooksaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class EbookSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving the document in all supportable e-Book formats: ePub, MOBI, and AZW3.

Supported E-book formats:

1.  [ePub][] (Electronic Publication)
2.  [MOBI][] (MobiPocket)
3.  [AZW3][] (Kindle Format 8t)

[ePub]: https://docs.fileformat.com/ebook/epub/
[MOBI]: https://docs.fileformat.com/ebook/mobi/
[AZW3]: https://docs.fileformat.com/ebook/azw3/
#### Constructors

| Constructor | Description |
| --- | --- |
| EbookSaveOptions() | This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(EBookFormats).setOutputFormat(EBookFormats)) property) |
| EbookSaveOptions(EBookFormats outputFormat) | Creates a new instance of EbookSaveOptions with specified mandatory e-Book output format, while all other parameters are default |
#### Methods

| Method | Description |
| --- | --- |
| getSplitHeadingLevel() | Specifies the maximum level of headings at which to split the e-Book file. |
| setSplitHeadingLevel(int value) | Specifies the maximum level of headings at which to split the e-Book file. |
| getExportDocumentProperties() | Specifies whether to export built-in and custom document properties in resultant file. |
| setExportDocumentProperties(boolean value) | Specifies whether to export built-in and custom document properties in resultant file. |
| getOutputFormat() | Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3. |
| setOutputFormat(EBookFormats value) | Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3. |
##### EbookSaveOptions()
```
public EbookSaveOptions()
```

This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(EBookFormats).setOutputFormat(EBookFormats)) property)

##### EbookSaveOptions(EBookFormats outputFormat)
```
public EbookSaveOptions(EBookFormats outputFormat)
```

Creates a new instance of EbookSaveOptions with specified mandatory e-Book output format, while all other parameters are default

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | EBookFormats | andatory output format, in which the e-Book should be saved |

##### getSplitHeadingLevel()
```
public final int getSplitHeadingLevel()
```

Specifies the maximum level of headings at which to split the e-Book file. Default value is  2 . Setting it to  0  will disable splitting, so all content of the e-Book will be incorporarted into a single package inside the resultant file.

When this property is set to a value from 1 to 9, the document will be split at paragraphs formatted using  **Heading 1** ,  **Heading 2**  ,  **Heading 3**  etc. styles up to the specified heading level.

By default, only  **Heading 1**  and  **Heading 2**  paragraphs cause the document to be split. Setting this property to zero (or lesser then zero) will cause the document not to be split at heading paragraphs at all.

**Returns:**
int
##### setSplitHeadingLevel(int value)
```
public final void setSplitHeadingLevel(int value)
```

Specifies the maximum level of headings at which to split the e-Book file. Default value is  2 . Setting it to  0  will disable splitting, so all content of the e-Book will be incorporarted into a single package inside the resultant file.

When this property is set to a value from 1 to 9, the document will be split at paragraphs formatted using  **Heading 1** ,  **Heading 2**  ,  **Heading 3**  etc. styles up to the specified heading level.

By default, only  **Heading 1**  and  **Heading 2**  paragraphs cause the document to be split. Setting this property to zero (or lesser then zero) will cause the document not to be split at heading paragraphs at all.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExportDocumentProperties()
```
public final boolean getExportDocumentProperties()
```

Specifies whether to export built-in and custom document properties in resultant file. Default value is  false .

**Returns:**
boolean
##### setExportDocumentProperties(boolean value)
```
public final void setExportDocumentProperties(boolean value)
```

Specifies whether to export built-in and custom document properties in resultant file. Default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOutputFormat()
```
public final EBookFormats getOutputFormat()
```

Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.

**Returns:**
EBookFormats
##### setOutputFormat(EBookFormats value)
```
public final void setOutputFormat(EBookFormats value)
```

Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | EBookFormats |  |

### EmailEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/emaileditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public final class EmailEditOptions implements IEditOptions
```

Allows to specify custom options for editing documents in the different electronic mail (email) formats
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailEditOptions() | Initializes a new instance of the EmailEditOptions class, where all options are set to their default values |
| EmailEditOptions(int mailMessageOutput) | Initializes a new instance of the EmailEditOptions class with  MailMessageOutput (\#getMailMessageOutput.getMailMessageOutput/\#setMailMessageOutput.setMailMessageOutput) parameter |
#### Methods

| Method | Description |
| --- | --- |
| getMailMessageOutput() | Allows to control which parts of the mail message should be delivered to the output EditableDocument and then to the emitted HTML |
| setMailMessageOutput(int value) | Allows to control which parts of the mail message should be delivered to the output EditableDocument and then to the emitted HTML |
##### EmailEditOptions()
```
public EmailEditOptions()
```

Initializes a new instance of the EmailEditOptions class, where all options are set to their default values

##### EmailEditOptions(int mailMessageOutput)
```
public EmailEditOptions(int mailMessageOutput)
```

Initializes a new instance of the EmailEditOptions class with  MailMessageOutput (\#getMailMessageOutput.getMailMessageOutput/\#setMailMessageOutput.setMailMessageOutput) parameter

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mailMessageOutput | int | The mail message output, which also can be specified through the property |

##### getMailMessageOutput()
```
public final int getMailMessageOutput()
```

Allows to control which parts of the mail message should be delivered to the output EditableDocument and then to the emitted HTML

Value: Flagged enum that controls the parts of the mail message, which should be processed. Default value is  MailMessageOutput.All

**Returns:**
int
##### setMailMessageOutput(int value)
```
public final void setMailMessageOutput(int value)
```

Allows to control which parts of the mail message should be delivered to the output EditableDocument and then to the emitted HTML

Value: Flagged enum that controls the parts of the mail message, which should be processed. Default value is  MailMessageOutput.All

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### EmailSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/emailsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class EmailSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving electronic mail (email) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailSaveOptions() | Initializes a new instance of the EmailSaveOptions class, where all options are set to their default values |
| EmailSaveOptions(int mailMessageOutput) | Initializes a new instance of the EmailSaveOptions class with  MailMessageOutput (\#getMailMessageOutput.getMailMessageOutput/\#setMailMessageOutput.setMailMessageOutput) parameter |
#### Methods

| Method | Description |
| --- | --- |
| getMailMessageOutput() | Allows to control which parts of the mail message should be delivered to the output email document, which will be generated and saved with the Editor.save(EditableDocument,Stream,ISaveOptions) method |
| setMailMessageOutput(int value) | Allows to control which parts of the mail message should be delivered to the output email document, which will be generated and saved with the Editor.save(EditableDocument,Stream,ISaveOptions) method |
##### EmailSaveOptions()
```
public EmailSaveOptions()
```

Initializes a new instance of the EmailSaveOptions class, where all options are set to their default values

##### EmailSaveOptions(int mailMessageOutput)
```
public EmailSaveOptions(int mailMessageOutput)
```

Initializes a new instance of the EmailSaveOptions class with  MailMessageOutput (\#getMailMessageOutput.getMailMessageOutput/\#setMailMessageOutput.setMailMessageOutput) parameter

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mailMessageOutput | int | The mail message output, which also can be specified through the property |

##### getMailMessageOutput()
```
public final int getMailMessageOutput()
```

Allows to control which parts of the mail message should be delivered to the output email document, which will be generated and saved with the Editor.save(EditableDocument,Stream,ISaveOptions) method

Value: Flagged enum that controls the parts of the mail message, which should be processed. Default value is  MailMessageOutput.All

**Returns:**
int
##### setMailMessageOutput(int value)
```
public final void setMailMessageOutput(int value)
```

Allows to control which parts of the mail message should be delivered to the output email document, which will be generated and saved with the Editor.save(EditableDocument,Stream,ISaveOptions) method

Value: Flagged enum that controls the parts of the mail message, which should be processed. Default value is  MailMessageOutput.All

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### FixedLayoutEditOptionsBase
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/fixedlayouteditoptionsbase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public abstract class FixedLayoutEditOptionsBase implements IEditOptions
```

Base abstract class for the options for all documents of fixed-layout formats like PDF and XPS
#### Constructors

| Constructor | Description |
| --- | --- |
| FixedLayoutEditOptionsBase() |  |
#### Methods

| Method | Description |
| --- | --- |
| getSkipImages() | Gets or sets the flag indicating whether images must be skipped while converting input fixed-layout document to the resultant HTML. |
| setSkipImages(boolean value) | Gets or sets the flag indicating whether images must be skipped while converting input fixed-layout document to the resultant HTML. |
| getPages() | Allows to set a page range to process. |
| setPages(PageRange value) | Allows to set a page range to process. |
| getEnablePagination() | Allows to enable (true) or disable (false) pagination in the resultant HTML document. |
| setEnablePagination(boolean value) | Allows to enable (true) or disable (false) pagination in the resultant HTML document. |
##### FixedLayoutEditOptionsBase()
```
public FixedLayoutEditOptionsBase()
```

##### getSkipImages()
```
public final boolean getSkipImages()
```

Gets or sets the flag indicating whether images must be skipped while converting input fixed-layout document to the resultant HTML. Default is false - images are preserved.

**Returns:**
boolean
##### setSkipImages(boolean value)
```
public final void setSkipImages(boolean value)
```

Gets or sets the flag indicating whether images must be skipped while converting input fixed-layout document to the resultant HTML. Default is false - images are preserved.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPages()
```
public final PageRange getPages()
```

Allows to set a page range to process. By default all pages of a fixed-layout document are processed.

**Returns:**
PageRange
##### setPages(PageRange value)
```
public final void setPages(PageRange value)
```

Allows to set a page range to process. By default all pages of a fixed-layout document are processed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PageRange |  |

##### getEnablePagination()
```
public final boolean getEnablePagination()
```

Allows to enable (true) or disable (false) pagination in the resultant HTML document. By default is disabled (false).

Fixed-layout format documents (PDF and XPS in particular) in their essence are strictly paged, their content has a fixed layout and divided onto pages. But resultant editable HTML can be represented in either pageless or paginal view.

**Returns:**
boolean
##### setEnablePagination(boolean value)
```
public final void setEnablePagination(boolean value)
```

Allows to enable (true) or disable (false) pagination in the resultant HTML document. By default is disabled (false).

Fixed-layout format documents (PDF and XPS in particular) in their essence are strictly paged, their content has a fixed layout and divided onto pages. But resultant editable HTML can be represented in either pageless or paginal view.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### FontEmbeddingOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/fontembeddingoptions.md

**Inheritance:**
java.lang.Object
```
public final class FontEmbeddingOptions
```

Font embedding options control which font resources should be embedded into the output WordProcessing document

Font embedding options are applied during document saving (from intermediate EditableDocument into output WordProcessing format), this enum is included as a property in the WordProcessingSaveOptions, from where it should be used
#### Fields

| Field | Description |
| --- | --- |
| NotEmbed | Do not embed any font resource neither from EditableDocument nor from the system. |
| EmbedAll | Analize document content from input EditableDocument, find all used fonts and embed them into output WordProcessing document. |
| EmbedWithoutSystem | Exact to EmbedAll, but exclude those fonts, which are treated by OS as system fonts |
#### Methods

| Method | Description |
| --- | --- |
| getFontEmbeddingOptions() |  |
##### NotEmbed
```
public static final int NotEmbed
```

Do not embed any font resource neither from EditableDocument nor from the system. Default value.

##### EmbedAll
```
public static final int EmbedAll
```

Analize document content from input EditableDocument, find all used fonts and embed them into output WordProcessing document. In the first place GroupDocs.Editor takes fonts from font resources within EditableDocument. If they are insufficient or missing, then GroupDocs.Editor takes fonts from OS.

First of all GroupDocs.Editor analyzes a content of EditableDocument and forms a list of all used fonts. Then these fotns are searched for in the font resources of EditableDocument. If EditableDocument contains some font resources, which are not involved within document content, such resources are ignored. If there are some fonts, used in the document content, which have no corresponding font resources in EditableDocument, then GroupDocs.Editor tries to find them in the OS. This option resembles the "Embed fonts in the file" option with all sub-options turned off in Microsoft Word 2007 and higher

##### EmbedWithoutSystem
```
public static final int EmbedWithoutSystem
```

Exact to EmbedAll, but exclude those fonts, which are treated by OS as system fonts

MS Windows has a concept of system fonts, which are the most basic and used fonts by Windows itself. When using this option, the GroupDocs.Editor acts like for EmbedAll case, but finally reviews a set of obtained fonts and excludes those, which are treated by OS as system fonts. This option resembles the "Embed fonts in the file" + "Do not embed common system fonts" options in Microsoft Word 2007 and higher

##### getFontEmbeddingOptions()
```
public static int[] getFontEmbeddingOptions()
```

**Returns:**
int[]

### FontExtractionOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/fontextractionoptions.md

**Inheritance:**
java.lang.Object
```
public final class FontExtractionOptions
```

Font extraction options control which fonts should be extracted and from where
#### Fields

| Field | Description |
| --- | --- |
| NotExtract | Does not extract any font resource neither from document not from the system. |
| ExtractAllEmbedded | Extracts all font resources, which are embedded into the input Word document, regardless of what they are: custom or system. |
| ExtractEmbeddedWithoutSystem | Extracts only those embedded font resources, which are custom (not system) |
| ExtractAll | Tries to extract all fonts, which are used in the input WordProcessing document, including system fonts. |
#### Methods

| Method | Description |
| --- | --- |
| getFontExtractionOptions() |  |
##### NotExtract
```
public static final int NotExtract
```

Does not extract any font resource neither from document not from the system. Default value.

##### ExtractAllEmbedded
```
public static final int ExtractAllEmbedded
```

Extracts all font resources, which are embedded into the input Word document, regardless of what they are: custom or system.

Converter finds and extracts all 100% font resources, which are embedded into the input WordProcessing document, but it doesn't determine whether they are system or custom; it doesn't touch Windows Registry or system folders at all.

##### ExtractEmbeddedWithoutSystem
```
public static final int ExtractEmbeddedWithoutSystem
```

Extracts only those embedded font resources, which are custom (not system)

Converter finds and extracts all embedded font resources, and then tries to determine which of these fonts are system, and which - not. In order to achieve this, converter tries to obtain a list of all system fonts by using Windows Registry and system folders, and then compares this list with a set of embedded fonts. As a result, only subset of those embedded fonts, which were not found in system, will be returned.

##### ExtractAll
```
public static final int ExtractAll
```

Tries to extract all fonts, which are used in the input WordProcessing document, including system fonts.

Converter is analyzing an input WordProcessing document and finds all fonts, which are used there. If all of these fonts are embedded into the input document, converter extracts and returns them. Otherwise, if a collection of embedded fonts doesn't cover all used fonts in the document, or is empty, converter tries to extract these font resources from system, by using Windows Registry and system folders.

##### getFontExtractionOptions()
```
public static int[] getFontExtractionOptions()
```

**Returns:**
int[]

### HtmlSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/htmlsaveoptions.md

**Inheritance:**
java.lang.Object
```
public final class HtmlSaveOptions
```

Allows to specify custom options for saving the EditableDocument instance to the HTML format
#### Constructors

| Constructor | Description |
| --- | --- |
| HtmlSaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getHtmlTagCase() | Controls how the HTML tag names will be present in HTML markup: All lower case (default value), All upper case, or First letter upper case |
| setHtmlTagCase(int value) | Controls how the HTML tag names will be present in HTML markup: All lower case (default value), All upper case, or First letter upper case |
| getAttributeValueDelimiter() | Controls which delimiter around the attribute values in HTML elements will be used: single quote (default value) or double quote |
| setAttributeValueDelimiter(int value) | Controls which delimiter around the attribute values in HTML elements will be used: single quote (default value) or double quote |
| getEmbedStylesheetsIntoMarkup() | Controls where to store the CSS stylesheet(s): as external resources ( false ), or embed them into the HTML markup, inside the STYLE element in the HTML->HEAD section ( true ) |
| setEmbedStylesheetsIntoMarkup(boolean value) | Controls where to store the CSS stylesheet(s): as external resources ( false ), or embed them into the HTML markup, inside the STYLE element in the HTML->HEAD section ( true ) |
| getSavingCallback() | Interface, which must be implemented by the end-user for saving all the external HTML resources |
| setSavingCallback(IHtmlSavingCallback value) | Interface, which must be implemented by the end-user for saving all the external HTML resources |
##### HtmlSaveOptions()
```
public HtmlSaveOptions()
```

##### getHtmlTagCase()
```
public final int getHtmlTagCase()
```

Controls how the HTML tag names will be present in HTML markup: All lower case (default value), All upper case, or First letter upper case

**Returns:**
int
##### setHtmlTagCase(int value)
```
public final void setHtmlTagCase(int value)
```

Controls how the HTML tag names will be present in HTML markup: All lower case (default value), All upper case, or First letter upper case

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getAttributeValueDelimiter()
```
public final int getAttributeValueDelimiter()
```

Controls which delimiter around the attribute values in HTML elements will be used: single quote (default value) or double quote

**Returns:**
int
##### setAttributeValueDelimiter(int value)
```
public final void setAttributeValueDelimiter(int value)
```

Controls which delimiter around the attribute values in HTML elements will be used: single quote (default value) or double quote

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getEmbedStylesheetsIntoMarkup()
```
public final boolean getEmbedStylesheetsIntoMarkup()
```

Controls where to store the CSS stylesheet(s): as external resources ( false ), or embed them into the HTML markup, inside the STYLE element in the HTML->HEAD section ( true )

**Returns:**
boolean
##### setEmbedStylesheetsIntoMarkup(boolean value)
```
public final void setEmbedStylesheetsIntoMarkup(boolean value)
```

Controls where to store the CSS stylesheet(s): as external resources ( false ), or embed them into the HTML markup, inside the STYLE element in the HTML->HEAD section ( true )

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSavingCallback()
```
public final IHtmlSavingCallback getSavingCallback()
```

Interface, which must be implemented by the end-user for saving all the external HTML resources

**Returns:**
IHtmlSavingCallback
##### setSavingCallback(IHtmlSavingCallback value)
```
public final void setSavingCallback(IHtmlSavingCallback value)
```

Interface, which must be implemented by the end-user for saving all the external HTML resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IHtmlSavingCallback |  |

### IEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/ieditoptions.md

### IHtmlSavingCallback
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/ihtmlsavingcallback.md

### ILoadOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/iloadoptions.md

### IMarkdownImageLoadCallback
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/imarkdownimageloadcallback.md

### ISaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/isaveoptions.md

### MailMessageOutput
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/mailmessageoutput.md

**Inheritance:**
java.lang.Object
```
public final class MailMessageOutput
```

Controls which parts of the mail message should be delivered to the output processing
#### Fields

| Field | Description |
| --- | --- |
| None | None of the email message parts will be processed |
| Body | Process body of the mail message |
| Subject | Process subject of the mail message |
| Date | Process date and time when message was delivered |
| To | Process all recipients of the mail message |
| Cc | Process all CC recipients of the mail message |
| Bcc | Process all BCC recipients of the mail message |
| From | Process sender of the mail message |
| Attachments | Process all attachments of the mail message |
| Metadata | Process all other technical metadata (sensitivity, priority, encoding, MIME, X-Mailer, etc) |
| Common | Common output - body with all main metadata |
| All | Full output - body with all metadata |
##### None
```
public static final int None
```

None of the email message parts will be processed

##### Body
```
public static final int Body
```

Process body of the mail message

##### Subject
```
public static final int Subject
```

Process subject of the mail message

##### Date
```
public static final int Date
```

Process date and time when message was delivered

##### To
```
public static final int To
```

Process all recipients of the mail message

##### Cc
```
public static final int Cc
```

Process all CC recipients of the mail message

##### Bcc
```
public static final int Bcc
```

Process all BCC recipients of the mail message

##### From
```
public static final int From
```

Process sender of the mail message

##### Attachments
```
public static final int Attachments
```

Process all attachments of the mail message

##### Metadata
```
public static final int Metadata
```

Process all other technical metadata (sensitivity, priority, encoding, MIME, X-Mailer, etc)

##### Common
```
public static final int Common
```

Common output - body with all main metadata

##### All
```
public static final int All
```

Full output - body with all metadata

### MarkdownEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/markdowneditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public final class MarkdownEditOptions implements IEditOptions
```

Allows to specify custom options for editing documents in Markdown format.
#### Constructors

| Constructor | Description |
| --- | --- |
| MarkdownEditOptions() | Creates and returns a new instance of the MarkdownEditOptions class, where all options are set to their default values |
#### Methods

| Method | Description |
| --- | --- |
| getImageLoadCallback() | Allows to control how images are saved when converting Markdown document to Html. |
| setImageLoadCallback(IMarkdownImageLoadCallback value) | Allows to control how images are saved when converting Markdown document to Html. |
##### MarkdownEditOptions()
```
public MarkdownEditOptions()
```

Creates and returns a new instance of the MarkdownEditOptions class, where all options are set to their default values

##### getImageLoadCallback()
```
public final IMarkdownImageLoadCallback getImageLoadCallback()
```

Allows to control how images are saved when converting Markdown document to Html.

Value: The image saving callback.

**Returns:**
IMarkdownImageLoadCallback
##### setImageLoadCallback(IMarkdownImageLoadCallback value)
```
public final void setImageLoadCallback(IMarkdownImageLoadCallback value)
```

Allows to control how images are saved when converting Markdown document to Html.

Value: The image saving callback.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IMarkdownImageLoadCallback |  |

### MarkdownImageLoadArgs
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/markdownimageloadargs.md

**Inheritance:**
java.lang.Object
```
public class MarkdownImageLoadArgs
```

Provides data for the  M:GroupDocs.Editor.Options.IMarkdownImageLoadCallback.ProcessImage(MarkdownImageLoadArgs)  event.
#### Constructors

| Constructor | Description |
| --- | --- |
| MarkdownImageLoadArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getImageFileName() | Gets or sets the file name (as is in the Markdown document) that will be process. |
| setImageFileName(String value) | Gets or sets the file name (as is in the Markdown document) that will be process. |
| isAbsoluteUri() | Get a value indicating whether this image has absolute URI link. |
| setAbsoluteUri(boolean value) | Get a value indicating whether this image has absolute URI link. |
| setData(byte[] data) | Sets user provided data of the resource which is used if  M:GroupDocs.Editor.Options.IMarkdownImageLoadCallback.ProcessImage(MarkdownImageLoadArgs)  |
##### MarkdownImageLoadArgs()
```
public MarkdownImageLoadArgs()
```

##### getImageFileName()
```
public final String getImageFileName()
```

Gets or sets the file name (as is in the Markdown document) that will be process.

**Returns:**
java.lang.String
##### setImageFileName(String value)
```
public final void setImageFileName(String value)
```

Gets or sets the file name (as is in the Markdown document) that will be process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### isAbsoluteUri()
```
public final boolean isAbsoluteUri()
```

Get a value indicating whether this image has absolute URI link.

Value:  true  if this image has absolute URI link; otherwise,  false .

**Returns:**
boolean
##### setAbsoluteUri(boolean value)
```
public final void setAbsoluteUri(boolean value)
```

Get a value indicating whether this image has absolute URI link.

Value:  true  if this image has absolute URI link; otherwise,  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### setData(byte[] data)
```
public final void setData(byte[] data)
```

Sets user provided data of the resource which is used if  M:GroupDocs.Editor.Options.IMarkdownImageLoadCallback.ProcessImage(MarkdownImageLoadArgs)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | byte[] |  |

### MarkdownImageLoadingAction
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/markdownimageloadingaction.md

**Inheritance:**
java.lang.Object
```
public final class MarkdownImageLoadingAction
```

Defines the mode of image loading while opening for editing the file in Markdown format
#### Fields

| Field | Description |
| --- | --- |
| Default | GroupDocs.Editor will load this resource as usual |
| Skip | GroupDocs.Editor will skip loading of this image |
| UserProvided | GroupDocs.Editor will use byte array provided by user in  M:GroupDocs.Editor.Options.MarkdownImageLoadArgs.SetData(System.Byte[])  as image data |
##### Default
```
public static final int Default
```

GroupDocs.Editor will load this resource as usual

##### Skip
```
public static final int Skip
```

GroupDocs.Editor will skip loading of this image

##### UserProvided
```
public static final int UserProvided
```

GroupDocs.Editor will use byte array provided by user in  M:GroupDocs.Editor.Options.MarkdownImageLoadArgs.SetData(System.Byte[])  as image data

### MarkdownSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/markdownsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class MarkdownSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving Markdown documents

MarkdownSaveOptions class must be applied by the user when there is an instance of EditableDocument class, that contains an edited document content, and it is required to save this content to the new document of Markdown format.
#### Constructors

| Constructor | Description |
| --- | --- |
| MarkdownSaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getOptimizeMemoryUsage() | Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. |
| setOptimizeMemoryUsage(boolean value) | Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. |
| getTableContentAlignment() | Allow specifies how to align contents in tables when exporting into the Markdown format. |
| setTableContentAlignment(int value) | Allow specifies how to align contents in tables when exporting into the Markdown format. |
| getImagesFolder() | Specifies the physical folder where images are saved when exporting a document to the Markdown format. |
| setImagesFolder(String value) | Specifies the physical folder where images are saved when exporting a document to the Markdown format. |
| getExportImagesAsBase64() | Specifies whether images are saved in Base64 format to the output file. |
| setExportImagesAsBase64(boolean value) | Specifies whether images are saved in Base64 format to the output file. |
##### MarkdownSaveOptions()
```
public MarkdownSaveOptions()
```

##### getOptimizeMemoryUsage()
```
public final boolean getOptimizeMemoryUsage()
```

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to  true  can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is  false  (memory optimization is disabled for the sake of better performance).

**Returns:**
boolean
##### setOptimizeMemoryUsage(boolean value)
```
public final void setOptimizeMemoryUsage(boolean value)
```

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to  true  can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is  false  (memory optimization is disabled for the sake of better performance).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTableContentAlignment()
```
public final int getTableContentAlignment()
```

Allow specifies how to align contents in tables when exporting into the Markdown format. The default value is MarkdownTableContentAlignment.Auto.

Value: The table content alignment

**Returns:**
int
##### setTableContentAlignment(int value)
```
public final void setTableContentAlignment(int value)
```

Allow specifies how to align contents in tables when exporting into the Markdown format. The default value is MarkdownTableContentAlignment.Auto.

Value: The table content alignment

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getImagesFolder()
```
public final String getImagesFolder()
```

Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is null.

If neither the  ImagesFolder (\#getImagesFolder.getImagesFolder/\#setImagesFolder(String).setImagesFolder(String)) nor  ExportImagesAsBase64 (\#getExportImagesAsBase64.getExportImagesAsBase64/\#setExportImagesAsBase64(boolean).setExportImagesAsBase64(boolean)) are specified by the user, then the GroupDocs.Editor will try to determine the  ImagesFolder (\#getImagesFolder.getImagesFolder/\#setImagesFolder(String).setImagesFolder(String)) by itself and apply it on success

**Returns:**
java.lang.String
##### setImagesFolder(String value)
```
public final void setImagesFolder(String value)
```

Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is null.

If neither the  ImagesFolder (\#getImagesFolder.getImagesFolder/\#setImagesFolder(String).setImagesFolder(String)) nor  ExportImagesAsBase64 (\#getExportImagesAsBase64.getExportImagesAsBase64/\#setExportImagesAsBase64(boolean).setExportImagesAsBase64(boolean)) are specified by the user, then the GroupDocs.Editor will try to determine the  ImagesFolder (\#getImagesFolder.getImagesFolder/\#setImagesFolder(String).setImagesFolder(String)) by itself and apply it on success

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getExportImagesAsBase64()
```
public final boolean getExportImagesAsBase64()
```

Specifies whether images are saved in Base64 format to the output file. Default is  false .

When this property is set to  true , then images data are exported directly into the image elements ! and separate files are not created. This property, if set to  true , has the higher priority than the  MarkdownSaveOptions.ImagesFolder (\#getImagesFolder.getImagesFolder/\#setImagesFolder(String).setImagesFolder(String)) property.

**Returns:**
boolean
##### setExportImagesAsBase64(boolean value)
```
public final void setExportImagesAsBase64(boolean value)
```

Specifies whether images are saved in Base64 format to the output file. Default is  false .

When this property is set to  true , then images data are exported directly into the image elements ! and separate files are not created. This property, if set to  true , has the higher priority than the  MarkdownSaveOptions.ImagesFolder (\#getImagesFolder.getImagesFolder/\#setImagesFolder(String).setImagesFolder(String)) property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### MarkdownTableContentAlignment
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/markdowntablecontentalignment.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
```
public final class MarkdownTableContentAlignment extends System.Enum
```

Allows to specify the alignment of the content of the table to be used when exporting into Markdown format.
#### Fields

| Field | Description |
| --- | --- |
| Auto | The alignment will be taken from the first paragraph in corresponding table column. |
| Left | The content of tables will be aligned to the Left. |
| Center | The content of tables will be aligned to the Center. |
| Right | The content of tables will be aligned to the Right. |
#### Methods

| Method | Description |
| --- | --- |
| getMarkdownTableContentAlignment() |  |
| getMarkdownTableContentAlignments() |  |
##### Auto
```
public static final int Auto
```

The alignment will be taken from the first paragraph in corresponding table column.

##### Left
```
public static final int Left
```

The content of tables will be aligned to the Left.

##### Center
```
public static final int Center
```

The content of tables will be aligned to the Center.

##### Right
```
public static final int Right
```

The content of tables will be aligned to the Right.

##### getMarkdownTableContentAlignment()
```
public static int[] getMarkdownTableContentAlignment()
```

**Returns:**
int[]
##### getMarkdownTableContentAlignments()
```
public static List<Integer> getMarkdownTableContentAlignments()
```

**Returns:**
java.util.List<java.lang.Integer>

### MhtmlSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/mhtmlsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class MhtmlSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving the MHTML (MIME encapsulation of aggregate HTML documents) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| MhtmlSaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getExportCidUrls() | Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. |
| setExportCidUrls(boolean value) | Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. |
| getExportDocumentProperties() | Specifies whether to export built-in and custom document properties to MHTML. |
| setExportDocumentProperties(boolean value) | Specifies whether to export built-in and custom document properties to MHTML. |
| getExportLanguageInformation() | Specifies whether language information is exported to MHTML. |
| setExportLanguageInformation(boolean value) | Specifies whether language information is exported to MHTML. |
##### MhtmlSaveOptions()
```
public MhtmlSaveOptions()
```

##### getExportCidUrls()
```
public final boolean getExportCidUrls()
```

Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. Default value is  false .

By default, resources in MHTML documents are referenced by file name (for example, "image.png"), which are matched against "Content-Location" headers of MIME parts. This option enables an alternative method, where references to resource files are written as CID (Content-ID) URLs (for example, "cid:image.png") and are matched against "Content-ID" headers.

In theory, there should be no difference between the two referencing methods and either of them should work fine in any browser or mail agent. In practice, however, some agents fail to fetch resources by file name. If your browser or mail agent refuses to load resources included in an MTHML document (doesn't show images or doesn't load CSS styles), try exporting the document with CID URLs.

**Returns:**
boolean
##### setExportCidUrls(boolean value)
```
public final void setExportCidUrls(boolean value)
```

Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. Default value is  false .

By default, resources in MHTML documents are referenced by file name (for example, "image.png"), which are matched against "Content-Location" headers of MIME parts. This option enables an alternative method, where references to resource files are written as CID (Content-ID) URLs (for example, "cid:image.png") and are matched against "Content-ID" headers.

In theory, there should be no difference between the two referencing methods and either of them should work fine in any browser or mail agent. In practice, however, some agents fail to fetch resources by file name. If your browser or mail agent refuses to load resources included in an MTHML document (doesn't show images or doesn't load CSS styles), try exporting the document with CID URLs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getExportDocumentProperties()
```
public final boolean getExportDocumentProperties()
```

Specifies whether to export built-in and custom document properties to MHTML. Default value is  false .

**Returns:**
boolean
##### setExportDocumentProperties(boolean value)
```
public final void setExportDocumentProperties(boolean value)
```

Specifies whether to export built-in and custom document properties to MHTML. Default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getExportLanguageInformation()
```
public final boolean getExportLanguageInformation()
```

Specifies whether language information is exported to MHTML. Default value is  false .

When this property is set to  true , the GroupDocs.Editor emits the  lang  HTML-attribute on the document elements that specify language. This can be needed to preserve language related semantics.

**Returns:**
boolean
##### setExportLanguageInformation(boolean value)
```
public final void setExportLanguageInformation(boolean value)
```

Specifies whether language information is exported to MHTML. Default value is  false .

When this property is set to  true , the GroupDocs.Editor emits the  lang  HTML-attribute on the document elements that specify language. This can be needed to preserve language related semantics.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### PageRange
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/pagerange.md

**Inheritance:**
java.lang.Object
```
public class PageRange
```

Encapsulates one page range, which can have open or closed bounds. By default is "fully open" - it includes all existing pages. Page numbering starts from 1, not from 0.

Immutable struct, that encapsulates a page range, which is not related to any specific document, and can represent a page range for any document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageRange() |  |
#### Fields

| Field | Description |
| --- | --- |
| AllPages | Represents all existing pages of a document. |
#### Methods

| Method | Description |
| --- | --- |
| getStartNumber() | Inclusive start page number, from which this page range starts. |
| getEndNumber() | Exclusive end page number, until which this page range continues and on which is stops exclusively. |
| getCount() | Numbers of pages within range. |
| isDefault() | Indicates whether this instance represents a default "fully open" page range i.e. |
| equals(PageRange other) | Detects whether this instance of PageRange is equal to specified |
| fromBeginningWithCount(int pageCount) | Creates a page range, that starts from the first page and has specified amount of pages |
| fromStartPageTillEnd(int startPageNumber) | Creates a page range, that starts from the specified page number and continues till the end of the document |
| fromStartPageWithCount(int startPageNumber, int pageCount) | Creates a page range, that starts from the specified page number and has specified amount of pages, or unlimited page count (till the end) |
| fromStartPageTillEndPage(int startPageNumber, int endPageNumber) | Creates a page range, that starts from the specified page number (inclusively) and continues until the specified page number (exclusively) |
##### PageRange()
```
public PageRange()
```

##### AllPages
```
public static final PageRange AllPages
```

Represents all existing pages of a document. Default value.

##### getStartNumber()
```
public final int getStartNumber()
```

Inclusive start page number, from which this page range starts. If 1 - page range starts from the first page of a document

**Returns:**
int
##### getEndNumber()
```
public final int getEndNumber()
```

Exclusive end page number, until which this page range continues and on which is stops exclusively. If 0 - page range spreads until end of the document

**Returns:**
int
##### getCount()
```
public final int getCount()
```

Numbers of pages within range. If 0 - page range spreads until end of the document no matter how much pages it consists of

**Returns:**
int
##### isDefault()
```
public final boolean isDefault()
```

Indicates whether this instance represents a default "fully open" page range i.e. it consists all pages of a document

**Returns:**
boolean
##### equals(PageRange other)
```
public final boolean equals(PageRange other)
```

Detects whether this instance of PageRange is equal to specified

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | PageRange | Other PageRange instance to check on equality |

**Returns:**
boolean - true is are equal; false if are unequal
##### fromBeginningWithCount(int pageCount)
```
public static PageRange fromBeginningWithCount(int pageCount)
```

Creates a page range, that starts from the first page and has specified amount of pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageCount | int | Number of pages, must be strictly bigger than zero |

**Returns:**
PageRange - New PageRange instance
##### fromStartPageTillEnd(int startPageNumber)
```
public static PageRange fromStartPageTillEnd(int startPageNumber)
```

Creates a page range, that starts from the specified page number and continues till the end of the document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startPageNumber | int | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |

**Returns:**
PageRange - New PageRange instance
##### fromStartPageWithCount(int startPageNumber, int pageCount)
```
public static PageRange fromStartPageWithCount(int startPageNumber, int pageCount)
```

Creates a page range, that starts from the specified page number and has specified amount of pages, or unlimited page count (till the end)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startPageNumber | int | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
| pageCount | int | Number of pages, must be strictly bigger than zero. If zero - this means all pages till the end of a document |

**Returns:**
PageRange - New PageRange instance
##### fromStartPageTillEndPage(int startPageNumber, int endPageNumber)
```
public static PageRange fromStartPageTillEndPage(int startPageNumber, int endPageNumber)
```

Creates a page range, that starts from the specified page number (inclusively) and continues until the specified page number (exclusively)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startPageNumber | int | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
| endPageNumber | int | Page number, until which page range continues, exclusively. Page numbers are 1-based, so must be strictly bigger than zero, and also must be strictly greater than  startPageNumber  |

**Returns:**
PageRange -

### PdfCompliance
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/pdfcompliance.md

**Inheritance:**
java.lang.Object
```
public final class PdfCompliance
```

Specifies the PDF standards compliance level
#### Fields

| Field | Description |
| --- | --- |
| Pdf17 | PDF 1.7 (ISO 32000-1) standard |
| Pdf20 | PDF 2.0 (ISO 32000-2) standard |
| PdfA1a | PDF/A-1a standard. |
| PdfA1b | PDF/A-1b (ISO 19005-1). |
| PdfA2a | PDF/A-2a (ISO 19005-2) standard. |
| PdfA2u | PDF/A-2u (ISO 19005-2) standard. |
| PdfUa1 | PDF/UA-1 (ISO 14289-1) standard. |
##### Pdf17
```
public static final int Pdf17
```

PDF 1.7 (ISO 32000-1) standard

##### Pdf20
```
public static final int Pdf20
```

PDF 2.0 (ISO 32000-2) standard

##### PdfA1a
```
public static final int PdfA1a
```

PDF/A-1a standard. This level includes all the requirements of PDF/A-1b and additionally requires that document structure be included (also known as being "tagged"), with the objective of ensuring that document content can be searched and repurposed.

Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

##### PdfA1b
```
public static final int PdfA1b
```

PDF/A-1b (ISO 19005-1). PDF/A-1b has the objective of ensuring reliable reproduction of the visual appearance of the document.

##### PdfA2a
```
public static final int PdfA2a
```

PDF/A-2a (ISO 19005-2) standard. This level includes all the requirements of PDF/A-2u and additionally requires that document structure be included (also known as being "tagged"), with the objective of ensuring that document content can be searched and repurposed.

Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

##### PdfA2u
```
public static final int PdfA2u
```

PDF/A-2u (ISO 19005-2) standard. PDF/A-2u has the objective of preserving document static visual appearance over time, independent of the tools and systems used for creating, storing or rendering the files. Additionally any text contained in the document can be reliably extracted as a series of Unicode codepoints.

##### PdfUa1
```
public static final int PdfUa1
```

PDF/UA-1 (ISO 14289-1) standard. The primary purpose of PDF/UA is to define how to represent electronic documents in the PDF format in a manner that allows the file to be accessible.

### PdfSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/pdfsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class PdfSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving PDF (Portable Document Format) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfSaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Password, which will be applied to the generated PDF document as user password, required for opening. |
| setPassword(String value) | Password, which will be applied to the generated PDF document as user password, required for opening. |
| getCompliance() | Specifies the PDF standards compliance level for output documents. |
| setCompliance(int value) | Specifies the PDF standards compliance level for output documents. |
| getFontEmbedding() | Responsible for embedding font resources into resultant PDF document, which are used in the original document. |
| setFontEmbedding(int value) | Responsible for embedding font resources into resultant PDF document, which are used in the original document. |
| getOptimizeMemoryUsage() | Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. |
| setOptimizeMemoryUsage(boolean value) | Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. |
##### PdfSaveOptions()
```
public PdfSaveOptions()
```

##### getPassword()
```
public final String getPassword()
```

Password, which will be applied to the generated PDF document as user password, required for opening. If NULL or empty, no password will be applied to the document. Otherwise, document will be encrypted with RC4 (key length of 128 bit). By default is NULL \\u2014 password is not applied.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Password, which will be applied to the generated PDF document as user password, required for opening. If NULL or empty, no password will be applied to the document. Otherwise, document will be encrypted with RC4 (key length of 128 bit). By default is NULL \\u2014 password is not applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCompliance()
```
public final int getCompliance()
```

Specifies the PDF standards compliance level for output documents. Default is PdfCompliance.Pdf17.

**Returns:**
int
##### setCompliance(int value)
```
public final void setCompliance(int value)
```

Specifies the PDF standards compliance level for output documents. Default is PdfCompliance.Pdf17.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFontEmbedding()
```
public final int getFontEmbedding()
```

Responsible for embedding font resources into resultant PDF document, which are used in the original document. By default doesn't embed any fonts (NotEmbed).

**Returns:**
int
##### setFontEmbedding(int value)
```
public final void setFontEmbedding(int value)
```

Responsible for embedding font resources into resultant PDF document, which are used in the original document. By default doesn't embed any fonts (NotEmbed).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getOptimizeMemoryUsage()
```
public final boolean getOptimizeMemoryUsage()
```

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

**Returns:**
boolean
##### setOptimizeMemoryUsage(boolean value)
```
public final void setOptimizeMemoryUsage(boolean value)
```

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### PresentationEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/presentationeditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public class PresentationEditOptions implements IEditOptions
```

Allows to specify custom options for editing documents of all supportable Presentation (PowerPoint-compatible) formats
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationEditOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getSlideNumber() | Allows to specify the slide numbers, which should be opened for editing |
| setSlideNumber(int value) | Allows to specify the slide numbers, which should be opened for editing |
| getShowHiddenSlides() | Specifies whether the hidden slides should be included or not. |
| setShowHiddenSlides(boolean value) | Specifies whether the hidden slides should be included or not. |
##### PresentationEditOptions()
```
public PresentationEditOptions()
```

##### getSlideNumber()
```
public final int getSlideNumber()
```

Allows to specify the slide numbers, which should be opened for editing

Slide number is a zero-based index of a slide, that allows to specify and select one particular slide from a presentation to edit. If lesser then 0, the first slide will be selected (same as SlideNumber = 0). If greater then amount of all slides in presentation, the last slide will be selected. If input presentation contains only single slide, this option will be ignored, and this single slide will be edited. If trying to open for editing a hidden slide, while  ShowHiddenSlides (\#getShowHiddenSlides.getShowHiddenSlides/\#setShowHiddenSlides(boolean).setShowHiddenSlides(boolean)) option is set to 'false', the exception will be thrown.

**Returns:**
int
##### setSlideNumber(int value)
```
public final void setSlideNumber(int value)
```

Allows to specify the slide numbers, which should be opened for editing

Slide number is a zero-based index of a slide, that allows to specify and select one particular slide from a presentation to edit. If lesser then 0, the first slide will be selected (same as SlideNumber = 0). If greater then amount of all slides in presentation, the last slide will be selected. If input presentation contains only single slide, this option will be ignored, and this single slide will be edited. If trying to open for editing a hidden slide, while  ShowHiddenSlides (\#getShowHiddenSlides.getShowHiddenSlides/\#setShowHiddenSlides(boolean).setShowHiddenSlides(boolean)) option is set to 'false', the exception will be thrown.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getShowHiddenSlides()
```
public final boolean getShowHiddenSlides()
```

Specifies whether the hidden slides should be included or not. Default is false - hidden slides are not shown and exception will be thrown while trying to edit them.

**Returns:**
boolean
##### setShowHiddenSlides(boolean value)
```
public final void setShowHiddenSlides(boolean value)
```

Specifies whether the hidden slides should be included or not. Default is false - hidden slides are not shown and exception will be thrown while trying to edit them.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### PresentationLoadOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/presentationloadoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ILoadOptions
```
public class PresentationLoadOptions implements ILoadOptions
```

Allows to specify custom options for loading documents of all supportable Presentation formats like PPT(X), PPTM, PPS(X) etc.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationLoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Allows to specify, modify and obtain the password, which will be used for opening the Presentation document, if it is encoded. |
| setPassword(String value) | Allows to specify, modify and obtain the password, which will be used for opening the Presentation document, if it is encoded. |
##### PresentationLoadOptions()
```
public PresentationLoadOptions()
```

##### getPassword()
```
public final String getPassword()
```

Allows to specify, modify and obtain the password, which will be used for opening the Presentation document, if it is encoded. Set to NULL or empty string in order to remove the password.

By default this property has NULL value \\u2014 password is not set. If input Presentation document is password-protected, the password is mandatory and an exception will be thrown if password is not specified or is invalid. If input Presentation document is NOT password-protected, but password is set, it will be ignored.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Allows to specify, modify and obtain the password, which will be used for opening the Presentation document, if it is encoded. Set to NULL or empty string in order to remove the password.

By default this property has NULL value \\u2014 password is not set. If input Presentation document is password-protected, the password is mandatory and an exception will be thrown if password is not specified or is invalid. If input Presentation document is NOT password-protected, but password is set, it will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### PresentationSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/presentationsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class PresentationSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving Presentation (PowerPoint-compatible) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationSaveOptions() | This parameterless constructor creates a new instance of PresentationSaveOptions with PPTX output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(PresentationFormats).setOutputFormat(PresentationFormats)) property) |
| PresentationSaveOptions(PresentationFormats outputFormat) | Creates a new instance of PresentationSaveOptions with specified mandatory Presentation output format, while all other parameters are default |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Allows to specify, modify and obtain the password, which will be used for encoding the resultant Presentation document. |
| setPassword(String value) | Allows to specify, modify and obtain the password, which will be used for encoding the resultant Presentation document. |
| getSlideNumber() | Allows to insert edited slide into existing presentation instead of creating a new single-slide presentation (default behavior). |
| setSlideNumber(int value) | Allows to insert edited slide into existing presentation instead of creating a new single-slide presentation (default behavior). |
| getInsertAsNewSlide() | Boolean flag, which specifies whether edited slide should replace the existing slide in original presentation on the position, specified by the  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int)) property, or it should be injected between existing slide and previous one, without replacing its content. |
| setInsertAsNewSlide(boolean value) | Boolean flag, which specifies whether edited slide should replace the existing slide in original presentation on the position, specified by the  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int)) property, or it should be injected between existing slide and previous one, without replacing its content. |
| getOutputFormat() | Allows to specify a Presentation format, which will be used for saving the document |
| setOutputFormat(PresentationFormats value) | Allows to specify a Presentation format, which will be used for saving the document |
| getSlideNumbersToDelete() | Allows to specify an array with 1-based numbers of slides that should be deleted from the presentation during its saving, in case when the edited slide is inserted into existing presentation. |
| setSlideNumbersToDelete(int[] value) | Allows to specify an array with 1-based numbers of slides that should be deleted from the presentation during its saving, in case when the edited slide is inserted into existing presentation. |
##### PresentationSaveOptions()
```
public PresentationSaveOptions()
```

This parameterless constructor creates a new instance of PresentationSaveOptions with PPTX output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(PresentationFormats).setOutputFormat(PresentationFormats)) property)

##### PresentationSaveOptions(PresentationFormats outputFormat)
```
public PresentationSaveOptions(PresentationFormats outputFormat)
```

Creates a new instance of PresentationSaveOptions with specified mandatory Presentation output format, while all other parameters are default

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | PresentationFormats | Mandatory output format, in which the Presentation document should be saved |

##### getPassword()
```
public final String getPassword()
```

Allows to specify, modify and obtain the password, which will be used for encoding the resultant Presentation document. By default is NULL - password will not be set. Set to NULL or empty string in order to remove the password, if it was set previously.

**Returns:**
java.lang.String -
##### setPassword(String value)
```
public final void setPassword(String value)
```

Allows to specify, modify and obtain the password, which will be used for encoding the resultant Presentation document. By default is NULL - password will not be set. Set to NULL or empty string in order to remove the password, if it was set previously.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSlideNumber()
```
public final int getSlideNumber()
```

Allows to insert edited slide into existing presentation instead of creating a new single-slide presentation (default behavior). Slide number is a 1-based number of a slide in the presentation, loaded in the Editor class. If it is 0 (default value), the new presentation will be created with single edited slide. If it is greater or lesser then zero, and there is valid presentation, loaded in the Editor class, the edited slide, stored inside input EditableDocument instance, will be inserted into this presentation.

> ```
> Given presentation has 5 slides:
>  SlideNumber  = 0; \u2014 ignore given presentation, create a new presentation and put edited slide into it.
>  SlideNumber  = 1; \u2014 replace the first slide with edited
>  SlideNumber  = 2; \u2014 replace the second slide with edited
>  SlideNumber  = 5; \u2014 replace the last (5th) slide with edited
>  SlideNumber  = 6; \u2014 replace the last (5th) slide with edited, because 6 is greater then 5 and thus is adjusted
>  SlideNumber = -1; \u2014 replace the last (5th) slide with edited, because "-1" means "last existing"
>  SlideNumber = -2; \u2014 replace the 4th slide with edited
>  SlideNumber = -3; \u2014 replace the 3rd slide with edited
>  SlideNumber = -4; \u2014 replace the 2nd slide with edited
>  SlideNumber = -5; \u2014 replace the first slide with edited
>  SlideNumber = -6; \u2014 replace the first slide with edited, because "-6" is greater then 5 and thus is adjusted
> ```

 *SlideNumber*  integer property, if it is not in default state (reserved value '0'), represents a slide number, so it starts from 1, not from zero, and its max value is the amount of all existing slides in a presentation. However, if specified value is greater then amount of all slides, GroupDocs.Editor will adjust it to mark the last slide. Negative values are also allowed and count slides from end. For example, "-1" implies last slide in a presentation, "-2" \\u2014 last but one, etc. Like with positive values, when negative slide number exceeds the total count of slides in the given presentation, it will be adjusted to the first slide. The  InsertAsNewSlide (\#getInsertAsNewSlide.getInsertAsNewSlide/\#setInsertAsNewSlide(boolean).setInsertAsNewSlide(boolean)) boolean property is tightly coupled with this one.

**Returns:**
int
##### setSlideNumber(int value)
```
public final void setSlideNumber(int value)
```

Allows to insert edited slide into existing presentation instead of creating a new single-slide presentation (default behavior). Slide number is a 1-based number of a slide in the presentation, loaded in the Editor class. If it is 0 (default value), the new presentation will be created with single edited slide. If it is greater or lesser then zero, and there is valid presentation, loaded in the Editor class, the edited slide, stored inside input EditableDocument instance, will be inserted into this presentation.

> ```
> Given presentation has 5 slides:
>  SlideNumber  = 0; \u2014 ignore given presentation, create a new presentation and put edited slide into it.
>  SlideNumber  = 1; \u2014 replace the first slide with edited
>  SlideNumber  = 2; \u2014 replace the second slide with edited
>  SlideNumber  = 5; \u2014 replace the last (5th) slide with edited
>  SlideNumber  = 6; \u2014 replace the last (5th) slide with edited, because 6 is greater then 5 and thus is adjusted
>  SlideNumber = -1; \u2014 replace the last (5th) slide with edited, because "-1" means "last existing"
>  SlideNumber = -2; \u2014 replace the 4th slide with edited
>  SlideNumber = -3; \u2014 replace the 3rd slide with edited
>  SlideNumber = -4; \u2014 replace the 2nd slide with edited
>  SlideNumber = -5; \u2014 replace the first slide with edited
>  SlideNumber = -6; \u2014 replace the first slide with edited, because "-6" is greater then 5 and thus is adjusted
> ```

 *SlideNumber*  integer property, if it is not in default state (reserved value '0'), represents a slide number, so it starts from 1, not from zero, and its max value is the amount of all existing slides in a presentation. However, if specified value is greater then amount of all slides, GroupDocs.Editor will adjust it to mark the last slide. Negative values are also allowed and count slides from end. For example, "-1" implies last slide in a presentation, "-2" \\u2014 last but one, etc. Like with positive values, when negative slide number exceeds the total count of slides in the given presentation, it will be adjusted to the first slide. The  InsertAsNewSlide (\#getInsertAsNewSlide.getInsertAsNewSlide/\#setInsertAsNewSlide(boolean).setInsertAsNewSlide(boolean)) boolean property is tightly coupled with this one.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getInsertAsNewSlide()
```
public final boolean getInsertAsNewSlide()
```

Boolean flag, which specifies whether edited slide should replace the existing slide in original presentation on the position, specified by the  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int)) property, or it should be injected between existing slide and previous one, without replacing its content. By default is false \\u2014 existing slide will be replaced. This property is ignored, if value of  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int)) property is set to '0'.

By default slide is replaced. This means that if given presentation has 5 slides, and  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int))=4, then 4th slide will be replaced with the new edited slide, while the total amount of slides in presentation (5) will remain untouched. However, if value of this property is set to  *true* , the new edited slide will be injected as 4th slide, and all subsequent slides wil be shifter to the end: "old" 4th slide becomes 5th, and 5th becomes 6th, and the total amount of slides in presentation will be incremented by one and equal to 6.

**Returns:**
boolean
##### setInsertAsNewSlide(boolean value)
```
public final void setInsertAsNewSlide(boolean value)
```

Boolean flag, which specifies whether edited slide should replace the existing slide in original presentation on the position, specified by the  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int)) property, or it should be injected between existing slide and previous one, without replacing its content. By default is false \\u2014 existing slide will be replaced. This property is ignored, if value of  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int)) property is set to '0'.

By default slide is replaced. This means that if given presentation has 5 slides, and  SlideNumber (\#getSlideNumber.getSlideNumber/\#setSlideNumber(int).setSlideNumber(int))=4, then 4th slide will be replaced with the new edited slide, while the total amount of slides in presentation (5) will remain untouched. However, if value of this property is set to  *true* , the new edited slide will be injected as 4th slide, and all subsequent slides wil be shifter to the end: "old" 4th slide becomes 5th, and 5th becomes 6th, and the total amount of slides in presentation will be incremented by one and equal to 6.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOutputFormat()
```
public final PresentationFormats getOutputFormat()
```

Allows to specify a Presentation format, which will be used for saving the document

Output format is usually set in the constructor of this class, because it is mandatory. This property allows to obtain or modify the output format later, when instance of PresentationSaveOptions class was already created.

**Returns:**
PresentationFormats
##### setOutputFormat(PresentationFormats value)
```
public final void setOutputFormat(PresentationFormats value)
```

Allows to specify a Presentation format, which will be used for saving the document

Output format is usually set in the constructor of this class, because it is mandatory. This property allows to obtain or modify the output format later, when instance of PresentationSaveOptions class was already created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PresentationFormats |  |

##### getSlideNumbersToDelete()
```
public final int[] getSlideNumbersToDelete()
```

Allows to specify an array with 1-based numbers of slides that should be deleted from the presentation during its saving, in case when the edited slide is inserted into existing presentation.When the edited slide is saved not as a new single-slide presentation (default behavior), but instead is saved into an existing presentation (using \#getSlideNumber().getSlideNumber() / \#setSlideNumber(int).setSlideNumber(int)), it is also possible to delete some particular slides from this presentation by specifying their numbers in this array. By default this array is  null  \\u2014 no slides will be deleted. However, when this array is non-null and non-empty, and it contains at least one valid slide number, after the output Presentation document is generated with the content of the edited slide, the slides with specified numbers will be deleted from the presentation right before writing its content to the output stream or file. Slide numbers in this array are 1-based, not 0-based. Invalid numbers (less than 1 or greater than the total number of slides) will be ignored.

**Returns:**
int[] - Array of 1-based slide numbers to delete, or  null  if nothing should be deleted.
##### setSlideNumbersToDelete(int[] value)
```
public final void setSlideNumbersToDelete(int[] value)
```

Allows to specify an array with 1-based numbers of slides that should be deleted from the presentation during its saving, in case when the edited slide is inserted into existing presentation.Slide numbers in this array are 1-based. Invalid numbers will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | Array of 1-based slide numbers to delete (may be  null  or empty). |

### SpreadsheetEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/spreadsheeteditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public class SpreadsheetEditOptions implements IEditOptions
```

Allows to specify custom options for editing documents of all supportable Spreadsheet (Excel-compatible) formats
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetEditOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheetIndex() | Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks). |
| setWorksheetIndex(int value) | Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks). |
| getExcludeHiddenWorksheets() | Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. |
| setExcludeHiddenWorksheets(boolean value) | Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. |
##### SpreadsheetEditOptions()
```
public SpreadsheetEditOptions()
```

##### getWorksheetIndex()
```
public final int getWorksheetIndex()
```

Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).

Most of Spreadsheet documents support a concept of tabs, i.e. they can be multi-tabbed. On the other hand, HTML format doesn't support such structure. Because of this GroupDocs.Editor can convert to the HTML only one specific tab of the input document, and this option allows to specify it. Tab index is 0-based, negative values are prohibited. If specified index exceeds the number of all tabs, the exception will be thrown. If input Spreadsheet document contains only one tab, this option will be ignored. Default value is 0 (first tab).

**Returns:**
int
##### setWorksheetIndex(int value)
```
public final void setWorksheetIndex(int value)
```

Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).

Most of Spreadsheet documents support a concept of tabs, i.e. they can be multi-tabbed. On the other hand, HTML format doesn't support such structure. Because of this GroupDocs.Editor can convert to the HTML only one specific tab of the input document, and this option allows to specify it. Tab index is 0-based, negative values are prohibited. If specified index exceeds the number of all tabs, the exception will be thrown. If input Spreadsheet document contains only one tab, this option will be ignored. Default value is 0 (first tab).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExcludeHiddenWorksheets()
```
public final boolean getExcludeHiddenWorksheets()
```

Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.

Several binary Spreadsheet formats (like XLSX) support hidden worksheets (tabs) concept. Document of such format, if it has more then one worksheet, may contain additional hidden worksheets. By default such hidden worksheets are available for processing, but with this option it is able to ignore them, like these hidden worksheets are absent and don't exist. When this option is enabled, you cannot select hidden worksheet with the ' WorksheetIndex (\#getWorksheetIndex.getWorksheetIndex/\#setWorksheetIndex(int).setWorksheetIndex(int))' property.

**Returns:**
boolean
##### setExcludeHiddenWorksheets(boolean value)
```
public final void setExcludeHiddenWorksheets(boolean value)
```

Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.

Several binary Spreadsheet formats (like XLSX) support hidden worksheets (tabs) concept. Document of such format, if it has more then one worksheet, may contain additional hidden worksheets. By default such hidden worksheets are available for processing, but with this option it is able to ignore them, like these hidden worksheets are absent and don't exist. When this option is enabled, you cannot select hidden worksheet with the ' WorksheetIndex (\#getWorksheetIndex.getWorksheetIndex/\#setWorksheetIndex(int).setWorksheetIndex(int))' property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/spreadsheetloadoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ILoadOptions
```
public final class SpreadsheetLoadOptions implements ILoadOptions
```

Contains options for loading binary Spreadsheet (Cells, Excel-compatible) documents like XLS(X), ODS etc. into Editor class
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Default parameterless constructor - all parameters have default values |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded. |
| setPassword(String value) | Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded. |
| getOptimizeMemoryUsage() | Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. |
| setOptimizeMemoryUsage(boolean value) | Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. |
##### SpreadsheetLoadOptions()
```
public SpreadsheetLoadOptions()
```

Default parameterless constructor - all parameters have default values

##### getPassword()
```
public final String getPassword()
```

Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded. Set to NULL or empty string in order to not use the password (default value).

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Allows to specify, modify and obtain the password, which will be used for opening the Spreadsheet document, if it is encoded. Set to NULL or empty string in order to not use the password (default value).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOptimizeMemoryUsage()
```
public final boolean getOptimizeMemoryUsage()
```

Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

**Returns:**
boolean
##### setOptimizeMemoryUsage(boolean value)
```
public final void setOptimizeMemoryUsage(boolean value)
```

Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/spreadsheetsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class SpreadsheetSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetSaveOptions() | This parameterless constructor creates a new instance of SpreadsheetSaveOptions with XLSX output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(SpreadsheetFormats).setOutputFormat(SpreadsheetFormats)) property) |
| SpreadsheetSaveOptions(SpreadsheetFormats outputFormat) | Creates a new instance of SpreadsheetSaveOptions with specified mandatory Spreadsheet output format, while all other parameters are default |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Spreadsheet document, if tis document format supports password protection. |
| setPassword(String value) | Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Spreadsheet document, if tis document format supports password protection. |
| getWorksheetNumber() | Allows to insert edited worksheet into copy of existing spreadsheet instead of creating a new single-worksheet spreadsheet (default behavior). |
| setWorksheetNumber(int value) | Allows to insert edited worksheet into copy of existing spreadsheet instead of creating a new single-worksheet spreadsheet (default behavior). |
| getInsertAsNewWorksheet() | Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int)) property, or it should be injected between existing worksheet and previous one, without replacing its content. |
| setInsertAsNewWorksheet(boolean value) | Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int)) property, or it should be injected between existing worksheet and previous one, without replacing its content. |
| getOutputFormat() | Allows to specify a Spreadsheet format, which will be used for saving the document |
| setOutputFormat(SpreadsheetFormats value) | Allows to specify a Spreadsheet format, which will be used for saving the document |
| getWorksheetProtection() | Allows to enable a worksheet protection for the output Spreadsheet document. |
| setWorksheetProtection(WorksheetProtection value) | Allows to enable a worksheet protection for the output Spreadsheet document. |
| getWorksheetNumbersToDelete() | Allows to specify an array with 1-based numbers of worksheets that should be deleted from the spreadsheet during its saving, in case when the edited worksheet is inserted into existing spreadsheet. |
| setWorksheetNumbersToDelete(int[] value) | Allows to specify an array with 1-based numbers of worksheets that should be deleted from the spreadsheet during its saving, in case when the edited worksheet is inserted into existing spreadsheet. |
##### SpreadsheetSaveOptions()
```
public SpreadsheetSaveOptions()
```

This parameterless constructor creates a new instance of SpreadsheetSaveOptions with XLSX output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(SpreadsheetFormats).setOutputFormat(SpreadsheetFormats)) property)

##### SpreadsheetSaveOptions(SpreadsheetFormats outputFormat)
```
public SpreadsheetSaveOptions(SpreadsheetFormats outputFormat)
```

Creates a new instance of SpreadsheetSaveOptions with specified mandatory Spreadsheet output format, while all other parameters are default

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | SpreadsheetFormats | Mandatory output format, in which the Spreadsheet document should be saved |

##### getPassword()
```
public final String getPassword()
```

Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Spreadsheet document, if tis document format supports password protection. Specify NULL or empty string for removing (cleaning) the password.

**Returns:**
java.lang.String -
##### setPassword(String value)
```
public final void setPassword(String value)
```

Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Spreadsheet document, if tis document format supports password protection. Specify NULL or empty string for removing (cleaning) the password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getWorksheetNumber()
```
public final int getWorksheetNumber()
```

Allows to insert edited worksheet into copy of existing spreadsheet instead of creating a new single-worksheet spreadsheet (default behavior). WorksheetNumber is a 1-based number of a worksheet in the spreadsheet, loaded in the Editor class. If it is 0 (default value), the new spreadsheet will be created with single edited worksheet. If it is greater or lesser then zero, and there is valid spreadsheet, loaded in the Editor class, the edited worksheet, that is represented by input EditableDocument instance, will be inserted into this spreadsheet.

> ```
> Given spreadsheet has 5 worksheets:
>  WorksheetNumber  = 0; \u2014 ignore given spreadsheet, create a new spreadsheet and put edited worksheet into it.
>  WorksheetNumber  = 1; \u2014 replace the first worksheet with edited
>  WorksheetNumber  = 2; \u2014 replace the second worksheet with edited
>  WorksheetNumber  = 5; \u2014 replace the last (5th) worksheet with edited
>  WorksheetNumber  = 6; \u2014 replace the last (5th) worksheet with edited, because 6 is greater then 5 and thus is adjusted
>  WorksheetNumber = -1; \u2014 replace the last (5th) worksheet with edited, because "-1" means "last existing"
>  WorksheetNumber = -2; \u2014 replace the 4th worksheet with edited
>  WorksheetNumber = -3; \u2014 replace the 3rd worksheet with edited
>  WorksheetNumber = -4; \u2014 replace the 2nd worksheet with edited
>  WorksheetNumber = -5; \u2014 replace the first worksheet with edited
>  WorksheetNumber = -6; \u2014 replace the first worksheet with edited, because "-6" is greater then 5 and thus is adjusted
> ```

 *WorksheetNumber*  integer property, if it is not in default state (reserved value '0'), represents a worksheet number, so it starts from 1, not from zero, and its max value is the amount of all existing slides in a presentation. However, if specified value is greater then amount of all slides, GroupDocs.Editor will adjust it to mark the last worksheet. Negative values are also allowed and count worksheets from end. For example, "-1" implies last worksheet in a spreadsheet, "-2" \\u2014 last but one, etc. Like with positive values, when negative worksheet number exceeds the total count of worksheets in the given spreadsheet, it will be adjusted to the first worksheet. The  InsertAsNewWorksheet (\#getInsertAsNewWorksheet.getInsertAsNewWorksheet/\#setInsertAsNewWorksheet(boolean).setInsertAsNewWorksheet(boolean)) boolean property is tightly coupled with this one.

**Returns:**
int -
##### setWorksheetNumber(int value)
```
public final void setWorksheetNumber(int value)
```

Allows to insert edited worksheet into copy of existing spreadsheet instead of creating a new single-worksheet spreadsheet (default behavior). WorksheetNumber is a 1-based number of a worksheet in the spreadsheet, loaded in the Editor class. If it is 0 (default value), the new spreadsheet will be created with single edited worksheet. If it is greater or lesser then zero, and there is valid spreadsheet, loaded in the Editor class, the edited worksheet, that is represented by input EditableDocument instance, will be inserted into this spreadsheet.

> ```
> Given spreadsheet has 5 worksheets:
>  WorksheetNumber  = 0; \u2014 ignore given spreadsheet, create a new spreadsheet and put edited worksheet into it.
>  WorksheetNumber  = 1; \u2014 replace the first worksheet with edited
>  WorksheetNumber  = 2; \u2014 replace the second worksheet with edited
>  WorksheetNumber  = 5; \u2014 replace the last (5th) worksheet with edited
>  WorksheetNumber  = 6; \u2014 replace the last (5th) worksheet with edited, because 6 is greater then 5 and thus is adjusted
>  WorksheetNumber = -1; \u2014 replace the last (5th) worksheet with edited, because "-1" means "last existing"
>  WorksheetNumber = -2; \u2014 replace the 4th worksheet with edited
>  WorksheetNumber = -3; \u2014 replace the 3rd worksheet with edited
>  WorksheetNumber = -4; \u2014 replace the 2nd worksheet with edited
>  WorksheetNumber = -5; \u2014 replace the first worksheet with edited
>  WorksheetNumber = -6; \u2014 replace the first worksheet with edited, because "-6" is greater then 5 and thus is adjusted
> ```

 *WorksheetNumber*  integer property, if it is not in default state (reserved value '0'), represents a worksheet number, so it starts from 1, not from zero, and its max value is the amount of all existing slides in a presentation. However, if specified value is greater then amount of all slides, GroupDocs.Editor will adjust it to mark the last worksheet. Negative values are also allowed and count worksheets from end. For example, "-1" implies last worksheet in a spreadsheet, "-2" \\u2014 last but one, etc. Like with positive values, when negative worksheet number exceeds the total count of worksheets in the given spreadsheet, it will be adjusted to the first worksheet. The  InsertAsNewWorksheet (\#getInsertAsNewWorksheet.getInsertAsNewWorksheet/\#setInsertAsNewWorksheet(boolean).setInsertAsNewWorksheet(boolean)) boolean property is tightly coupled with this one.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getInsertAsNewWorksheet()
```
public final boolean getInsertAsNewWorksheet()
```

Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int)) property, or it should be injected between existing worksheet and previous one, without replacing its content. By default is false \\u2014 existing worksheet will be replaced. This property is ignored, if value of  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int)) property is set to '0'.

By default worksheet is replaced. This means that if given spreadsheet has 5 worksheets, and  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int))=4, then 4th worksheet will be replaced with the new edited worksheet, while the total amount of worksheets in spreadsheet (5) will remain untouched. However, if value of this property is set to  *true* , the new edited worksheet will be injected as 4th worksheet, and all subsequent worksheets will be shifted to the end: "old" 4th worksheet becomes 5th, and 5th becomes 6th, and the total amount of worksheets in spreadsheet will be incremented by one and equal to 6.

**Returns:**
boolean -
##### setInsertAsNewWorksheet(boolean value)
```
public final void setInsertAsNewWorksheet(boolean value)
```

Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int)) property, or it should be injected between existing worksheet and previous one, without replacing its content. By default is false \\u2014 existing worksheet will be replaced. This property is ignored, if value of  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int)) property is set to '0'.

By default worksheet is replaced. This means that if given spreadsheet has 5 worksheets, and  WorksheetNumber (\#getWorksheetNumber.getWorksheetNumber/\#setWorksheetNumber(int).setWorksheetNumber(int))=4, then 4th worksheet will be replaced with the new edited worksheet, while the total amount of worksheets in spreadsheet (5) will remain untouched. However, if value of this property is set to  *true* , the new edited worksheet will be injected as 4th worksheet, and all subsequent worksheets will be shifted to the end: "old" 4th worksheet becomes 5th, and 5th becomes 6th, and the total amount of worksheets in spreadsheet will be incremented by one and equal to 6.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOutputFormat()
```
public final SpreadsheetFormats getOutputFormat()
```

Allows to specify a Spreadsheet format, which will be used for saving the document

**Returns:**
SpreadsheetFormats -
##### setOutputFormat(SpreadsheetFormats value)
```
public final void setOutputFormat(SpreadsheetFormats value)
```

Allows to specify a Spreadsheet format, which will be used for saving the document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetFormats |  |

##### getWorksheetProtection()
```
public final WorksheetProtection getWorksheetProtection()
```

Allows to enable a worksheet protection for the output Spreadsheet document. By default is NULL - protection is not applied. Not all formats support a worksheet protection.

**Returns:**
WorksheetProtection -
##### setWorksheetProtection(WorksheetProtection value)
```
public final void setWorksheetProtection(WorksheetProtection value)
```

Allows to enable a worksheet protection for the output Spreadsheet document. By default is NULL - protection is not applied. Not all formats support a worksheet protection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WorksheetProtection |  |

##### getWorksheetNumbersToDelete()
```
public final int[] getWorksheetNumbersToDelete()
```

Allows to specify an array with 1-based numbers of worksheets that should be deleted from the spreadsheet during its saving, in case when the edited worksheet is inserted into existing spreadsheet.When the edited worksheet is saved not as a new single-worksheet spreadsheet (default behavior), but instead is saved into an existing spreadsheet (using \#getWorksheetNumber().getWorksheetNumber() / \#setWorksheetNumber(int).setWorksheetNumber(int)), it is also possible to delete some particular worksheets from this spreadsheet by specifying their numbers in this array. By default this array is  null  \\u2014 no worksheets will be deleted. However, when this array is non-null and non-empty, and it contains at least one valid worksheet number, after the output spreadsheet document is generated with the content of the edited worksheet, the worksheets with specified numbers will be deleted from the spreadsheet right before writing its content to the output stream or file. Worksheet numbers in this array are 1-based, not 0-based. Invalid numbers (less than 1 or greater than the total number of worksheets) will be ignored.

**Returns:**
int[] - Array of 1-based worksheet numbers to delete, or  null  if nothing should be deleted.
##### setWorksheetNumbersToDelete(int[] value)
```
public final void setWorksheetNumbersToDelete(int[] value)
```

Allows to specify an array with 1-based numbers of worksheets that should be deleted from the spreadsheet during its saving, in case when the edited worksheet is inserted into existing spreadsheet.Worksheet numbers in this array are 1-based. Invalid numbers will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | Array of 1-based worksheet numbers to delete (may be  null  or empty). |

### TextDirection
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/textdirection.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
```
public final class TextDirection extends System.Enum
```

Represents 3 possible variants how to treat text direction in the plain text documents
#### Fields

| Field | Description |
| --- | --- |
| LeftToRight | Left-to-Right direction, usual text, default value. |
| RightToLeft | Right-to-Left direction |
| Auto | Auto-detect direction. |
#### Methods

| Method | Description |
| --- | --- |
| getTextDirection() |  |
##### LeftToRight
```
public static final int LeftToRight
```

Left-to-Right direction, usual text, default value.

##### RightToLeft
```
public static final int RightToLeft
```

Right-to-Left direction

##### Auto
```
public static final int Auto
```

Auto-detect direction. When this option is selected and text contains characters belonging to RTL scripts, the document direction will be set automatically to RTL.

##### getTextDirection()
```
public static int[] getTextDirection()
```

**Returns:**
int[]

### TextEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/texteditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public class TextEditOptions implements IEditOptions
```

Allows to specify custom options for loading plain text (TXT) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| TextEditOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Character encoding of the text document, which will be applied for its opening |
| setEncoding(Charset value) | Character encoding of the text document, which will be applied for its opening |
| getRecognizeLists() | Allows to specify how numbered list items are recognized when document is imported from plain text format. |
| setRecognizeLists(boolean value) | Allows to specify how numbered list items are recognized when document is imported from plain text format. |
| getLeadingSpaces() | Gets or sets preferred option of a leading space handling. |
| setLeadingSpaces(int value) | Gets or sets preferred option of a leading space handling. |
| getTrailingSpaces() | Gets or sets preferred option of a trailing space handling. |
| setTrailingSpaces(int value) | Gets or sets preferred option of a trailing space handling. |
| getEnablePagination() | Allows to enable or disable pagination in the resultant HTML document. |
| setEnablePagination(boolean value) | Allows to enable or disable pagination in the resultant HTML document. |
| getDirection() | Allows to specify the direction of text flow in the input plain text document. |
| setDirection(int value) | Allows to specify the direction of text flow in the input plain text document. |
##### TextEditOptions()
```
public TextEditOptions()
```

##### getEncoding()
```
public final Charset getEncoding()
```

Character encoding of the text document, which will be applied for its opening

**Returns:**
java.nio.charset.Charset
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Character encoding of the text document, which will be applied for its opening

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### getRecognizeLists()
```
public final boolean getRecognizeLists()
```

Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true.

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "\\u2022", "\*", "-" or "o"). If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

**Returns:**
boolean
##### setRecognizeLists(boolean value)
```
public final void setRecognizeLists(boolean value)
```

Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true.

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "\\u2022", "\*", "-" or "o"). If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getLeadingSpaces()
```
public final int getLeadingSpaces()
```

Gets or sets preferred option of a leading space handling. By default converts leading spaces to the left indent.

**Returns:**
int
##### setLeadingSpaces(int value)
```
public final void setLeadingSpaces(int value)
```

Gets or sets preferred option of a leading space handling. By default converts leading spaces to the left indent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTrailingSpaces()
```
public final int getTrailingSpaces()
```

Gets or sets preferred option of a trailing space handling. By default truncates all trailing spaces.

**Returns:**
int
##### setTrailingSpaces(int value)
```
public final void setTrailingSpaces(int value)
```

Gets or sets preferred option of a trailing space handling. By default truncates all trailing spaces.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getEnablePagination()
```
public final boolean getEnablePagination()
```

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

**Returns:**
boolean
##### setEnablePagination(boolean value)
```
public final void setEnablePagination(boolean value)
```

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDirection()
```
public final int getDirection()
```

Allows to specify the direction of text flow in the input plain text document. By default is Left-to-Right.

**Returns:**
int
##### setDirection(int value)
```
public final void setDirection(int value)
```

Allows to specify the direction of text flow in the input plain text document. By default is Left-to-Right.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### TextLeadingSpacesOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/textleadingspacesoptions.md

**Inheritance:**
java.lang.Object
```
public final class TextLeadingSpacesOptions
```

Contains available options for leading space handling during opening plain text document (TXT)
#### Fields

| Field | Description |
| --- | --- |
| ConvertToIndent | Convert one or more consecutive spaces to the left indent. |
| Preserve | Pass all leading spaces to the output HTML "as is", without touching them |
| Trim | Trim (truncate) all leading spaces completely |
##### ConvertToIndent
```
public static final int ConvertToIndent
```

Convert one or more consecutive spaces to the left indent. Default value.

##### Preserve
```
public static final int Preserve
```

Pass all leading spaces to the output HTML "as is", without touching them

##### Trim
```
public static final int Trim
```

Trim (truncate) all leading spaces completely

### TextSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/textsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class TextSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving plain text (TXT) documents
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Character encoding of the text document, which will be applied for its saving |
| setEncoding(Charset value) | Character encoding of the text document, which will be applied for its saving |
| getAddBidiMarks() | Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. |
| setAddBidiMarks(boolean value) | Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format |
| getPreserveTableLayout() | Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. |
| setPreserveTableLayout(boolean value) | Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. |
##### TextSaveOptions()
```
public TextSaveOptions()
```

##### getEncoding()
```
public final Charset getEncoding()
```

Character encoding of the text document, which will be applied for its saving

**Returns:**
java.nio.charset.Charset -
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Character encoding of the text document, which will be applied for its saving

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### getAddBidiMarks()
```
public final boolean getAddBidiMarks()
```

Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. Default is 'false' \\u2014 do not add BiDi marks.

**Returns:**
boolean -
##### setAddBidiMarks(boolean value)
```
public final void setAddBidiMarks(boolean value)
```

Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPreserveTableLayout()
```
public final boolean getPreserveTableLayout()
```

Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false.

**Returns:**
boolean -
##### setPreserveTableLayout(boolean value)
```
public final void setPreserveTableLayout(boolean value)
```

Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### TextTrailingSpacesOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/texttrailingspacesoptions.md

**Inheritance:**
java.lang.Object
```
public final class TextTrailingSpacesOptions
```

Contains available options for trailing space handling during opening plain text document (TXT)
#### Fields

| Field | Description |
| --- | --- |
| Trim | Trim (truncate) all trailing spaces completely. |
| Preserve | Pass all trailing spaces to the output HTML "as is", without touching them |
##### Trim
```
public static final int Trim
```

Trim (truncate) all trailing spaces completely. Default value.

##### Preserve
```
public static final int Preserve
```

Pass all trailing spaces to the output HTML "as is", without touching them

### WebFont
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/webfont.md

**Inheritance:**
java.lang.Object
```
public final class WebFont
```

Represents a font settings for the web
#### Methods

| Method | Description |
| --- | --- |
| getColor() | Font color in ARGB32 format |
| setColor(ArgbColor value) | Font color in ARGB32 format |
| getWeight() | Sets the weight (or boldness) of the font |
| setWeight(FontWeight value) | Sets the weight (or boldness) of the font |
| getStyle() | Sets whether a font should be styled with a normal, italic, or oblique face from its font-family. |
| setStyle(FontStyle value) | Sets whether a font should be styled with a normal, italic, or oblique face from its font-family. |
| getLine() | Sets a line or combination of lines, applied to the text |
| setLine(TextDecorationLineType value) | Sets a line or combination of lines, applied to the text |
| getSize() | Sets the size of the font in absolute or relative units |
| setSize(FontSize value) | Sets the size of the font in absolute or relative units |
| getName() | Sets the font name. |
| setName(String value) | Sets the font name. |
| deepClone() | Creates and returns a full deep copy of this WebFont instance |
| equals(WebFont other) | Determines whether this instance of WebFont is equal to specified |
| equals(Object obj) | Determines whether this instance of WebFont is equal to specified uncasted object |
##### getColor()
```
public final ArgbColor getColor()
```

Font color in ARGB32 format

**Returns:**
ArgbColor
##### setColor(ArgbColor value)
```
public final void setColor(ArgbColor value)
```

Font color in ARGB32 format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ArgbColor |  |

##### getWeight()
```
public final FontWeight getWeight()
```

Sets the weight (or boldness) of the font

**Returns:**
FontWeight
##### setWeight(FontWeight value)
```
public final void setWeight(FontWeight value)
```

Sets the weight (or boldness) of the font

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FontWeight |  |

##### getStyle()
```
public final FontStyle getStyle()
```

Sets whether a font should be styled with a normal, italic, or oblique face from its font-family.

**Returns:**
FontStyle
##### setStyle(FontStyle value)
```
public final void setStyle(FontStyle value)
```

Sets whether a font should be styled with a normal, italic, or oblique face from its font-family.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FontStyle |  |

##### getLine()
```
public final TextDecorationLineType getLine()
```

Sets a line or combination of lines, applied to the text

**Returns:**
TextDecorationLineType
##### setLine(TextDecorationLineType value)
```
public final void setLine(TextDecorationLineType value)
```

Sets a line or combination of lines, applied to the text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TextDecorationLineType |  |

##### getSize()
```
public final FontSize getSize()
```

Sets the size of the font in absolute or relative units

**Returns:**
FontSize
##### setSize(FontSize value)
```
public final void setSize(FontSize value)
```

Sets the size of the font in absolute or relative units

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FontSize |  |

##### getName()
```
public final String getName()
```

Sets the font name. If not specified, the default font will be used

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Sets the font name. If not specified, the default font will be used

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### deepClone()
```
public final WebFont deepClone()
```

Creates and returns a full deep copy of this WebFont instance

**Returns:**
WebFont - New WebFont instance, that is a full and deep copy of this one
##### equals(WebFont other)
```
public final boolean equals(WebFont other)
```

Determines whether this instance of WebFont is equal to specified

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | WebFont | Another WebFont to check equality, may be NULL |

**Returns:**
boolean - true if equal, false if unequal
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether this instance of WebFont is equal to specified uncasted object

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Object, that is expected to be a WebFont instance |

**Returns:**
boolean - true if equal, false if unequal

### WordProcessingEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/wordprocessingeditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public class WordProcessingEditOptions implements IEditOptions
```

Allows to specify custom options for editing documents of all supportable WordProcessing (Words-compliant) formats like DOC(X), RTF, ODT etc.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingEditOptions() | Creates and returns a new instance of the WordProcessingEditOptions class, where all options are set to their default values |
| WordProcessingEditOptions(boolean enablePagination) | Creates and returns a new instance of the WordProcessingEditOptions class with specified pagination and default all other options |
#### Methods

| Method | Description |
| --- | --- |
| getEnablePagination() | Allows to enable or disable pagination in the resultant HTML document. |
| setEnablePagination(boolean value) | Allows to enable or disable pagination in the resultant HTML document. |
| getEnableLanguageInformation() | Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. |
| setEnableLanguageInformation(boolean value) | Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. |
| getExtractOnlyUsedFont() | Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document. |
| setExtractOnlyUsedFont(boolean value) | Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document. |
| getFontExtraction() | Responsible for extracting font resources, which are used in the input WordProcessing document. |
| setFontExtraction(int value) | Responsible for extracting font resources, which are used in the input WordProcessing document. |
| getInputControlsClassName() | Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document. |
| setInputControlsClassName(String value) | Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document. |
| getUseInlineStyles() | Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet ( false ) or as inline styles in the HTML markup ( true ). |
| setUseInlineStyles(boolean value) | Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet ( false ) or as inline styles in the HTML markup ( true ). |
##### WordProcessingEditOptions()
```
public WordProcessingEditOptions()
```

Creates and returns a new instance of the WordProcessingEditOptions class, where all options are set to their default values

##### WordProcessingEditOptions(boolean enablePagination)
```
public WordProcessingEditOptions(boolean enablePagination)
```

Creates and returns a new instance of the WordProcessingEditOptions class with specified pagination and default all other options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enablePagination | boolean | Pagination flag, that enables HTML output, adjusted for paged mode |

##### getEnablePagination()
```
public final boolean getEnablePagination()
```

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

**Returns:**
boolean
##### setEnablePagination(boolean value)
```
public final void setEnablePagination(boolean value)
```

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEnableLanguageInformation()
```
public final boolean getEnableLanguageInformation()
```

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

**Returns:**
boolean
##### setEnableLanguageInformation(boolean value)
```
public final void setEnableLanguageInformation(boolean value)
```

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getExtractOnlyUsedFont()
```
public final boolean getExtractOnlyUsedFont()
```

Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.

Value:  true  if it is required to extract only those font resources, which are used in text content of the document; otherwise,  false . Default value is  false .

Not all fonts, used in the WordProcessing document, are 100% used directly (applied to some text). There may be a situation, when font is referenced in the document and even may be embedded, but is not applied to any piece of text. For example, some font may be attached to some style, but this style is not applied to any part of text. This option controls how to process such cases.

**Returns:**
boolean
##### setExtractOnlyUsedFont(boolean value)
```
public final void setExtractOnlyUsedFont(boolean value)
```

Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.

Value:  true  if it is required to extract only those font resources, which are used in text content of the document; otherwise,  false . Default value is  false .

Not all fonts, used in the WordProcessing document, are 100% used directly (applied to some text). There may be a situation, when font is referenced in the document and even may be embedded, but is not applied to any piece of text. For example, some font may be attached to some style, but this style is not applied to any part of text. This option controls how to process such cases.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFontExtraction()
```
public final int getFontExtraction()
```

Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn't extract any fonts (NotExtract).

**Returns:**
int
##### setFontExtraction(int value)
```
public final void setFontExtraction(int value)
```

Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn't extract any fonts (NotExtract).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getInputControlsClassName()
```
public final String getInputControlsClassName()
```

Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document. By default is NULL - 'class' attributes are not applied.

Almost all formats from WordProcessing format family contain fields \\u2014 specific document entities, that allow to obtain input data from users. There are a wide variety of fields: text-boxes, checkboxes, combo-boxes, drop down lists, buttons, date/time pickers, etc. All of them are translated into the most appropriate HTML structures and elements, with preserving the entered user data, if they are present in the input document. In specific use-cases it is required only to gather entered data on a client-side instead of editing the entire document content. For such case it is required to identify input controls in some way for fetching them with their data on client-side. This property allows to specify a class name, that will be applied for every input control in HTML markup, so client code will be able to traverse over HTML document structure and gather data.

**Returns:**
java.lang.String
##### setInputControlsClassName(String value)
```
public final void setInputControlsClassName(String value)
```

Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document. By default is NULL - 'class' attributes are not applied.

Almost all formats from WordProcessing format family contain fields \\u2014 specific document entities, that allow to obtain input data from users. There are a wide variety of fields: text-boxes, checkboxes, combo-boxes, drop down lists, buttons, date/time pickers, etc. All of them are translated into the most appropriate HTML structures and elements, with preserving the entered user data, if they are present in the input document. In specific use-cases it is required only to gather entered data on a client-side instead of editing the entire document content. For such case it is required to identify input controls in some way for fetching them with their data on client-side. This property allows to specify a class name, that will be applied for every input control in HTML markup, so client code will be able to traverse over HTML document structure and gather data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUseInlineStyles()
```
public final boolean getUseInlineStyles()
```

Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet ( false ) or as inline styles in the HTML markup ( true ). By default external styles are used ( false ).

**Returns:**
boolean
##### setUseInlineStyles(boolean value)
```
public final void setUseInlineStyles(boolean value)
```

Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet ( false ) or as inline styles in the HTML markup ( true ). By default external styles are used ( false ).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/wordprocessingloadoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ILoadOptions
```
public final class WordProcessingLoadOptions implements ILoadOptions
```

Contains options for loading WordProcessing (Word-compatible) documents like DOC(X), RTF, ODT etc. into Editor class
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingLoadOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Allows to specify, modify and obtain the password, which will be used for opening WordProcessing document, if it is encoded. |
| setPassword(String value) | Allows to specify, modify and obtain the password, which will be used for opening WordProcessing document, if it is encoded. |
##### WordProcessingLoadOptions()
```
public WordProcessingLoadOptions()
```

##### getPassword()
```
public final String getPassword()
```

Allows to specify, modify and obtain the password, which will be used for opening WordProcessing document, if it is encoded. Set to NULL or empty string in order to not use the password (default value).

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Allows to specify, modify and obtain the password, which will be used for opening WordProcessing document, if it is encoded. Set to NULL or empty string in order to not use the password (default value).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### WordProcessingProtection
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/wordprocessingprotection.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingProtection
```

Encapsulates document protection options for the WordProcessing document, which is generated from HTML
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingProtection() | Parameterless constructor - all parameters have default values |
| WordProcessingProtection(int protectionType, String password) | Allows to set all parameters during class instantiation |
#### Methods

| Method | Description |
| --- | --- |
| getProtectionType() | Allows to set a protection type of the document. |
| setProtectionType(int value) | Allows to set a protection type of the document. |
| getPassword() | The password to protect the document with. |
| setPassword(String value) | The password to protect the document with. |
| convertToAsposeWords(int protectionType) |  |
##### WordProcessingProtection()
```
public WordProcessingProtection()
```

Parameterless constructor - all parameters have default values

##### WordProcessingProtection(int protectionType, String password)
```
public WordProcessingProtection(int protectionType, String password)
```

Allows to set all parameters during class instantiation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | int | Set the protection type of the document |
| password | java.lang.String | Set the protection password |

##### getProtectionType()
```
public final int getProtectionType()
```

Allows to set a protection type of the document. By default is set to not protect the document at all.

**Returns:**
int
##### setProtectionType(int value)
```
public final void setProtectionType(int value)
```

Allows to set a protection type of the document. By default is set to not protect the document at all.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPassword()
```
public final String getPassword()
```

The password to protect the document with. If null or empty string - the protection will not be applied to the document.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

The password to protect the document with. If null or empty string - the protection will not be applied to the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### convertToAsposeWords(int protectionType)
```
public static int convertToAsposeWords(int protectionType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | int |  |

**Returns:**
int

### WordProcessingProtectionType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/wordprocessingprotectiontype.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingProtectionType
```

Represents all available protection types of the WordProcessing document
#### Fields

| Field | Description |
| --- | --- |
| NoProtection | The document is not protected. |
| AllowOnlyRevisions | User can only add revision marks to the document |
| AllowOnlyComments | User can only modify comments in the document |
| AllowOnlyFormFields | User can only enter data in the form fields in the document |
| ReadOnly | No changes are allowed to the document |
#### Methods

| Method | Description |
| --- | --- |
| getAll() |  |
##### NoProtection
```
public static final int NoProtection
```

The document is not protected. Default value.

##### AllowOnlyRevisions
```
public static final int AllowOnlyRevisions
```

User can only add revision marks to the document

##### AllowOnlyComments
```
public static final int AllowOnlyComments
```

User can only modify comments in the document

##### AllowOnlyFormFields
```
public static final int AllowOnlyFormFields
```

User can only enter data in the form fields in the document

##### ReadOnly
```
public static final int ReadOnly
```

No changes are allowed to the document

##### getAll()
```
public static Map<Integer,String> getAll()
```

**Returns:**
java.util.Map<java.lang.Integer,java.lang.String>

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/wordprocessingsaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class WordProcessingSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving WordProcessing-compliant documents after they were edited

WordProcessingSaveOptions is applied in situations when there is an instance of EditableDocument class, that contains an edited document content, and it is required to save this content to the new document of WordProcessing format.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSaveOptions() | This parameterless constructor creates a new instance of WordProcessingSaveOptions with DOCX output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(WordProcessingFormats).setOutputFormat(WordProcessingFormats)) property) |
| WordProcessingSaveOptions(WordProcessingFormats outputFormat) | Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default |
#### Methods

| Method | Description |
| --- | --- |
| getEnablePagination() | Allows to enable or disable pagination which will be used for saving the document. |
| setEnablePagination(boolean value) | Allows to enable or disable pagination which will be used for saving the document. |
| getPassword() | Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated WordProcessing document. |
| setPassword(String value) | Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated WordProcessing document. |
| getOutputFormat() | Allows to specify a WordProcessing format, which will be used for saving the document |
| setOutputFormat(WordProcessingFormats value) | Allows to specify a WordProcessing format, which will be used for saving the document |
| getLocale() | Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation. |
| setLocale(Locale value) | Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation. |
| getLocaleBi() | Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation. |
| setLocaleBi(Locale value) | Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation. |
| getLocaleFarEast() | Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation. |
| setLocaleFarEast(Locale value) | Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation. |
| getOptimizeMemoryUsage() | Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. |
| setOptimizeMemoryUsage(boolean value) | Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. |
| getProtection() | Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection. |
| setProtection(WordProcessingProtection value) | Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection. |
| getFontEmbedding() | Responsible for embedding font resources into output WordProcessing document. |
| setFontEmbedding(int value) | Responsible for embedding font resources into output WordProcessing document. |
| deepClone() | Creates and returns a full copy of this instance of WordProcessingSaveOptions class |
##### WordProcessingSaveOptions()
```
public WordProcessingSaveOptions()
```

This parameterless constructor creates a new instance of WordProcessingSaveOptions with DOCX output format (can be modified then through  OutputFormat (\#getOutputFormat.getOutputFormat/\#setOutputFormat(WordProcessingFormats).setOutputFormat(WordProcessingFormats)) property)

##### WordProcessingSaveOptions(WordProcessingFormats outputFormat)
```
public WordProcessingSaveOptions(WordProcessingFormats outputFormat)
```

Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | WordProcessingFormats | Mandatory output format, in which the WordProcessing document should be saved |

##### getEnablePagination()
```
public final boolean getEnablePagination()
```

Allows to enable or disable pagination which will be used for saving the document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled.

**Returns:**
boolean -
##### setEnablePagination(boolean value)
```
public final void setEnablePagination(boolean value)
```

Allows to enable or disable pagination which will be used for saving the document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated WordProcessing document. Specify NULL or empty string for removing (cleaning) the password.

**Returns:**
java.lang.String -
##### setPassword(String value)
```
public final void setPassword(String value)
```

Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated WordProcessing document. Specify NULL or empty string for removing (cleaning) the password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOutputFormat()
```
public final WordProcessingFormats getOutputFormat()
```

Allows to specify a WordProcessing format, which will be used for saving the document

**Returns:**
WordProcessingFormats -
##### setOutputFormat(WordProcessingFormats value)
```
public final void setOutputFormat(WordProcessingFormats value)
```

Allows to specify a WordProcessing format, which will be used for saving the document

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WordProcessingFormats |  |

##### getLocale()
```
public final Locale getLocale()
```

Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document locale according to its own settings or other factors.

This option forcibly applies the specified locale to overall text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

**Returns:**
java.util.Locale -
##### setLocale(Locale value)
```
public final void setLocale(Locale value)
```

Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document locale according to its own settings or other factors.

This option forcibly applies the specified locale to overall text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Locale |  |

##### getLocaleBi()
```
public final Locale getLocaleBi()
```

Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document RTL locale according to its own settings or other factors.

This option forcibly applies the specified locale to overall RTL text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

**Returns:**
java.util.Locale -
##### setLocaleBi(Locale value)
```
public final void setLocaleBi(Locale value)
```

Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document RTL locale according to its own settings or other factors.

This option forcibly applies the specified locale to overall RTL text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Locale |  |

##### getLocaleFarEast()
```
public final Locale getLocaleFarEast()
```

Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document East-Asian locale according to its own settings or other factors.

This option forcibly applies the specified locale to overall East-Asian text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

**Returns:**
java.util.Locale -
##### setLocaleFarEast(Locale value)
```
public final void setLocaleFarEast(Locale value)
```

Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document East-Asian locale according to its own settings or other factors.

This option forcibly applies the specified locale to overall East-Asian text in the document. Do not use it, if document contains different parts of text, which are written on different languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Locale |  |

##### getOptimizeMemoryUsage()
```
public final boolean getOptimizeMemoryUsage()
```

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

**Returns:**
boolean -
##### setOptimizeMemoryUsage(boolean value)
```
public final void setOptimizeMemoryUsage(boolean value)
```

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getProtection()
```
public final WordProcessingProtection getProtection()
```

Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection. By default is NULL - document protection will not be used.

**Returns:**
WordProcessingProtection -
##### setProtection(WordProcessingProtection value)
```
public final void setProtection(WordProcessingProtection value)
```

Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection. By default is NULL - document protection will not be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WordProcessingProtection |  |

##### getFontEmbedding()
```
public final int getFontEmbedding()
```

Responsible for embedding font resources into output WordProcessing document. By default doesn't embed any fonts (NotEmbed).

**Returns:**
int -
##### setFontEmbedding(int value)
```
public final void setFontEmbedding(int value)
```

Responsible for embedding font resources into output WordProcessing document. By default doesn't embed any fonts (NotEmbed).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### deepClone()
```
public final WordProcessingSaveOptions deepClone()
```

Creates and returns a full copy of this instance of WordProcessingSaveOptions class

**Returns:**
WordProcessingSaveOptions - New WordProcessingSaveOptions instance

### WorksheetProtection
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/worksheetprotection.md

**Inheritance:**
java.lang.Object
```
public final class WorksheetProtection
```

Encapsulates worksheet protection options, which allow to protect a worksheet in the output Spreadsheet document from modification of specified type with a specified password.

Most of Spreadsheet formats like XLSX allows to protect a worksheet from editing with password. This class allows to enable such protection and specify its options.
#### Constructors

| Constructor | Description |
| --- | --- |
| WorksheetProtection() | Creates new instance with default parameters. |
| WorksheetProtection(int protectionType, String password) | Creates new instance with specified worksheet protection type and password |
#### Methods

| Method | Description |
| --- | --- |
| getProtectionType() | Allows to specify a type of worksheet protection. |
| setProtectionType(int value) | Allows to specify a type of worksheet protection. |
| getPassword() | Password, which is used for protecting a worksheet. |
| setPassword(String value) | Password, which is used for protecting a worksheet. |
##### WorksheetProtection()
```
public WorksheetProtection()
```

Creates new instance with default parameters. If not modified and passed to SpreadsheetSaveOptions, no worksheet protection will be applied

##### WorksheetProtection(int protectionType, String password)
```
public WorksheetProtection(int protectionType, String password)
```

Creates new instance with specified worksheet protection type and password

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | int | Type of worksheet protection |
| password | java.lang.String | Password, that locks the protection |

##### getProtectionType()
```
public final int getProtectionType()
```

Allows to specify a type of worksheet protection. By default is 'None' - protection is not applied.

**Returns:**
int
##### setProtectionType(int value)
```
public final void setProtectionType(int value)
```

Allows to specify a type of worksheet protection. By default is 'None' - protection is not applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPassword()
```
public final String getPassword()
```

Password, which is used for protecting a worksheet. If NULL or empty string, the protection will not be applied.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Password, which is used for protecting a worksheet. If NULL or empty string, the protection will not be applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### WorksheetProtectionType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/worksheetprotectiontype.md

**Inheritance:**
java.lang.Object
```
public final class WorksheetProtectionType
```

Represents Spreadsheet worksheet (tab) protection types
#### Fields

| Field | Description |
| --- | --- |
| None | Protection is not applied (default value) |
| All | User cannot modify anything on the worksheet |
| Contents | User cannot enter data in the worksheet |
| Objects | User cannot modify drawing objects |
| Scenarios | User cannot modify saved scenarios |
| Structure | User cannot modify the structure |
| Window | User cannot modify the window |
#### Methods

| Method | Description |
| --- | --- |
| getAll() |  |
##### None
```
public static final int None
```

Protection is not applied (default value)

##### All
```
public static final int All
```

User cannot modify anything on the worksheet

##### Contents
```
public static final int Contents
```

User cannot enter data in the worksheet

##### Objects
```
public static final int Objects
```

User cannot modify drawing objects

##### Scenarios
```
public static final int Scenarios
```

User cannot modify saved scenarios

##### Structure
```
public static final int Structure
```

User cannot modify the structure

##### Window
```
public static final int Window
```

User cannot modify the window

##### getAll()
```
public static Map<Integer,String> getAll()
```

**Returns:**
java.util.Map<java.lang.Integer,java.lang.String>

### XmlEditOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/xmleditoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public final class XmlEditOptions implements IEditOptions
```

Allows to specify custom options for loading XML (eXtensible Markup Language) documents and converting them to the HTML
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlEditOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Character encoding of the text document, which will be applied for its opening. |
| setEncoding(Charset value) | Character encoding of the text document, which will be applied for its opening. |
| getFixIncorrectStructure() | Allows to enable or disable mechanism for fixing corrupted XML structure. |
| setFixIncorrectStructure(boolean value) | Allows to enable or disable mechanism for fixing corrupted XML structure. |
| getRecognizeUris() | Allows to enable URI recognition algorithm |
| setRecognizeUris(boolean value) | Allows to enable URI recognition algorithm |
| getRecognizeEmails() | Allows to enable recognition algorithm for email addresses in attribute values |
| setRecognizeEmails(boolean value) | Allows to enable recognition algorithm for email addresses in attribute values |
| getTrimTrailingWhitespaces() | Allows to enable the truncation of trailing whitespaces in the inner-tag text. |
| setTrimTrailingWhitespaces(boolean value) | Allows to enable the truncation of trailing whitespaces in the inner-tag text. |
| getAttributeValuesQuoteType() | Allows to specify quote type (single or double quotes) for attribute values. |
| setAttributeValuesQuoteType(QuoteType value) | Allows to specify quote type (single or double quotes) for attribute values. |
| getHighlightOptions() | Allows to adjust the XML highlighting, that will be applied to the XML structure, when it is represented in HTML. |
| getFormatOptions() | Allows to adjust the XML formatting, that will be applied to the XML structure, when it is represented in HTML. |
##### XmlEditOptions()
```
public XmlEditOptions()
```

##### getEncoding()
```
public final Charset getEncoding()
```

Character encoding of the text document, which will be applied for its opening. By default is null \\u2014 internal document encoding will be applied.

**Returns:**
java.nio.charset.Charset
##### setEncoding(Charset value)
```
public final void setEncoding(Charset value)
```

Character encoding of the text document, which will be applied for its opening. By default is null \\u2014 internal document encoding will be applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### getFixIncorrectStructure()
```
public final boolean getFixIncorrectStructure()
```

Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false).

By default only proper valid well-formed XML documents are acceptable. When this option is enabled, GroupDocs.Editor will try to fix corrupted XML structure if possible.

**Returns:**
boolean
##### setFixIncorrectStructure(boolean value)
```
public final void setFixIncorrectStructure(boolean value)
```

Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false).

By default only proper valid well-formed XML documents are acceptable. When this option is enabled, GroupDocs.Editor will try to fix corrupted XML structure if possible.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRecognizeUris()
```
public final boolean getRecognizeUris()
```

Allows to enable URI recognition algorithm

**Returns:**
boolean
##### setRecognizeUris(boolean value)
```
public final void setRecognizeUris(boolean value)
```

Allows to enable URI recognition algorithm

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getRecognizeEmails()
```
public final boolean getRecognizeEmails()
```

Allows to enable recognition algorithm for email addresses in attribute values

**Returns:**
boolean
##### setRecognizeEmails(boolean value)
```
public final void setRecognizeEmails(boolean value)
```

Allows to enable recognition algorithm for email addresses in attribute values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getTrimTrailingWhitespaces()
```
public final boolean getTrimTrailingWhitespaces()
```

Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) \\u2014 trailing whitespaces will be preserved.

**Returns:**
boolean
##### setTrimTrailingWhitespaces(boolean value)
```
public final void setTrimTrailingWhitespaces(boolean value)
```

Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) \\u2014 trailing whitespaces will be preserved.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAttributeValuesQuoteType()
```
public final QuoteType getAttributeValuesQuoteType()
```

Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default.

**Returns:**
QuoteType
##### setAttributeValuesQuoteType(QuoteType value)
```
public final void setAttributeValuesQuoteType(QuoteType value)
```

Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QuoteType |  |

##### getHighlightOptions()
```
public final XmlHighlightOptions getHighlightOptions()
```

Allows to adjust the XML highlighting, that will be applied to the XML structure, when it is represented in HTML. Default highlighting is used and is adjustable. Cannot be null.

**Returns:**
XmlHighlightOptions
##### getFormatOptions()
```
public final XmlFormatOptions getFormatOptions()
```

Allows to adjust the XML formatting, that will be applied to the XML structure, when it is represented in HTML. Default formatting is used and is adjustable. Cannot be null.

**Returns:**
XmlFormatOptions

### XmlFormatOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/xmlformatoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public final class XmlFormatOptions implements IEditOptions
```

Contains options, that allow to adjust the formatting of XML document, when it is represented as HTML
#### Methods

| Method | Description |
| --- | --- |
| getEachAttributeFromNewline() | When enabled, each and every pair of attribute-value in every XML element will be placed on a new line. |
| setEachAttributeFromNewline(boolean value) | When enabled, each and every pair of attribute-value in every XML element will be placed on a new line. |
| getLeafTextNodesOnNewline() | When enabled, leaf text nodes (textual content inside XML elements, that has no children) will be rendered on a new line with bigger left indent. |
| setLeafTextNodesOnNewline(boolean value) | When enabled, leaf text nodes (textual content inside XML elements, that has no children) will be rendered on a new line with bigger left indent. |
| getLeftIndent() | Allows to specify an offset for the left indent of every new line. |
| setLeftIndent(Length value) | Allows to specify an offset for the left indent of every new line. |
| isDefault() | Indicates whether this instance of XML formatting options has a default value |
##### getEachAttributeFromNewline()
```
public final boolean getEachAttributeFromNewline()
```

When enabled, each and every pair of attribute-value in every XML element will be placed on a new line. By default is false (disabled) \\u2014 all attribute-value pairs are placed in a single line.

**Returns:**
boolean
##### setEachAttributeFromNewline(boolean value)
```
public final void setEachAttributeFromNewline(boolean value)
```

When enabled, each and every pair of attribute-value in every XML element will be placed on a new line. By default is false (disabled) \\u2014 all attribu